get

[ Funktion ]

Version 1.8

export function get(
    id: string | null | undefined
): TcHmi.Controls.System.baseTcHmiControl | undefined;

Version 1.12

Export function get<T extends TcHmi.Controls.System.baseTcHmiControl>(
    identifier: string | null | undefined
): T | undefined;

Gibt ein Control mit einem bestimmten Identifier zurück.

Version 1.12

Wird die API in TypeScript-Code benutzt, so kann dem TypeScript-Compiler mitgeteilt, welchen Typ das Control hat.

Hinweis

Dies ist eine reine Hilfe für die Programmierung. Der Browser kennt diese „Typeannotation“ nicht. Es findet keine Prüfung oder Konvertierung zur Laufzeit statt.

Parameter

Name

Typ

Beschreibung

id

string, null, undefined

Identifier des gewünschten Controls.

Rückgabewert

Typ

Beschreibung

TcHmi.Controls.System.baseTcHmiControl, undefined

Das angeforderter Control-Objekt oder undefined wenn kein Control mit diesem Identifier existiert.

get 1:

Verfügbar ab Version 1.8

Beispiel - JavaScript

var someControl = TcHmi.Controls.get('TcHmiButton');
if(someControl !== undefined) {
    someControl.setText('found you');
}

Beispiel - TypeScript

var someControl = TcHmi.Controls.get<TcHmi.Controls.Beckhoff.TcHmiTextbox>('TcHmiButton');
if(someControl !== undefined) {
    someControl.setText('found you'); // TS knows this has setText
}