getComputedElementStyle

[ Funktion ]

public static getComputedElementStyle(
    element: Jquery<Element> | readonly Element[] | NodeListOf<Element> | HTMLCollectionOf<Element> | Element | undefined, 
    propertyName: string
): Dictionary<string>;

Gibt eine aktive CSS-Eigenschaft eines HTML-Elements zurück. Dies berücksichtigt auch Eigenschaften, welche von CSS-Dateien wirken. Enthält das übergebene Objekt mehrere Elemente (wie bei einer jQuery Collection), so wird das erste Element genutzt.

Parameter

Name

Typ

Beschreibung

element

Info: Typ Element unterstützt ab Version 1.10
Info: Typen Element[] | NodeListOf<Element> | HTMLCollectionOf<Element> ab Version 1.10.1171.21

JQuery<Element>, readonly Element[], NodeListOf<Element>, HTMLCollectionOf<Element>, Element, undefined

  • jQuery Collection mit dem zu prüfenden Element
  • beliebige Array-ähnliche Element-Liste (auch beispielsweise aus document.querySelectorAll() oder document.getElementsByClassName())
  • einzelnes Element, also beispielsweise HTML oder SVG-Element.

propertyName

string

Name der CSS-Eigenschaft

Rückgabewert

Typ

Beschreibung

Dictionary<string>

Objekt mit der CSS-Eigenschaft des ersten Elements in der jQuery Collection. Ist eine angeforderte Eigenschaft nicht (mehr) gesetzt, so wird dieser Eintrag im Objekt nicht gesetzt.

Gibt im Fehlerfall ein leeres Objekt zurück.

getComputedElementStyle 1:

Verfügbar ab Version 1.10

Beispiel - JavaScript

var control = TcHmi.Controls.get('TcHmiButton');
if(control === undefined){ 
    return; 
}
var cntrlElem = control.getElement();
var borderWidthStyle = 
TcHmi.StyleProvider.getComputedElementStyle(cntrlElem, 'border-width');
/* returns:
{
    'border-width': '0px',
}
*/
TcHmi.Log.debug('Border Width is: '+ borderWidthStyle['border-width']);