addEx

[ Funktion ]

public static addEx(
    element: JQuery | undefined | null,
    options?: TopMostLayer.IOptions
): boolean;

Hängt ein HTML-Element in den Overlaybereich über der normalen Visualisierung. Diese Funktion ist gedacht zur Nutzung aus Code-Behind heraus.

Eine Referenz zum Element sollte gespeichert werden um die removeEx() Funktion aufrufen zu können.

Parameter

Name

Typ

Beschreibung

element

JQuery

JQuery Collection mit einem HTML-Element.

options [Optional]

TopMostLayer.IOptions

Optionen für erweiterte Funktionen.

Rückgabewert

Typ

Beschreibung

boolean

Ergebnis ob der Aufruf erfolgreich war

addEx 1:

Verfügbar ab Version 1.10

Beispiel - JavaScript

var myPopup = $('<div style="background:white;padding:10px;">Hello World</div>');
TcHmi.TopMostLayer.addEx(myPopup, {
    centerHorizontal: true,
    centerVertical: true,
    removeCb: (data) => {
        if (data.canceled) {
            // user clicked on background
        }
    }
});