Steuerelemente (Client-API-Referenz)

Ein Steuerelement stellt ein HTML-Element dar, das im Formular vorhanden ist. Einige Steuerelemente sind an eine spezifische Spalte gebunden, während andere ungebundene Steuerelemente darstellen können, z. B. einen IFRAME, eine Webressource oder ein Unterraster, der/die/das für das Formular hinzugefügt wurde.

Das Steuerelement-Objekt bietet Methoden, um die Darstellung und das Verhalten eines Steuerelements zu ändern und das entsprechende Spalte zu identifizieren. Der Zugriff auf Steuerelemente erfolgt mit einer folgenden Sammlungen:

• formContext.ui.controls
• formContext.ui Section.controls
• formContext.data.entity Attribute.controls

Die formContext.getControl-Methode ist eine Verknüpfung für den Zugriff auf formContext.ui.controls.get.

Steuerelemente werden nach Typ kategorisiert. Sie können den Typ eines Steuerelements feststellen, indem Sie die getControlType-Methode verwenden. Bestimmte Steuerungsmethoden sind nur für spezifische Steuerelementtypen verfügbar.

Dieser Artikel enthält Informationen zu den Methoden, die pro Steuerelementtyp verfügbar sind.

Standardsteuerelementtyp

Das sind die Methoden, die für ein Standardsteuerelement verfügbar sind.

addNotification clearNotification getAttribute getControlType getDisabled

getLabel getName getOutputs getParent getVisible

setDisabled setFocus setLabel setNotification setVisible

Die folgenden Methoden für das Standardsteuerelement sind veraltet in dieser Version: addOnKeyPress, fireOnKeyPress und removeOnKeyPress.

IFRAME-Steuerelementtyp

Das sind die Methoden, die für ein IFRAME-Steuerelement verfügbar sind.

getContentWindow getControlType getDisabled getInitialUrl getLabel

getName getObject getParent getSrc getVisible

setDisabled setFocus setLabel setSrc setVisible

kbsearch (Knowledge base search)-Steuerelementtyp

Das sind die Methoden, die für das Wissendatenbank-Suchsteuerelement verfügbar sind.

addOnPostSearch addOnResultOpened addOnSelection getControlType getDisabled getLabel getName

getParent getSearchQuery getSelectedResults getTotalResultCount getVisible openSearchResult removeOnPostSearch

removeOnResultOpened removeOnSelection setFocus setLabel setSearchQuery setVisible

Hinweis

Wenn das Wissensdatenbank-Suchsteuerelement dem sozialen Bereich hinzugefügt wird, ist der Name des Steuerelements „searchwidgetcontrol_notescontrol”. Dieser Name kann nicht geändert werden.

lookup-Steuerelementtyp

Das sind die Methoden, die für ein Lookup-Steuerelement verfügbar sind.

addCustomFilter addCustomView addNotification addOnLookupTagClick addPreSearch clearNotification getAttribute getControlType

getDefaultView getDisabled getEntityTypes getLabel getName getParent getVisible removeOnLookupTagClick

removePreSearch setDefaultView setDisabled setEntityTypes setFocus setLabel setNotification setVisible

Auswahlmöglichkeiten und Auswahlspaltentypen

Sowohl Auswahlmöglichkeiten als auch Auswahlsteuerelemente verfügen über dieselben Methoden.

addNotification addOption clearNotification clearOptions getAttribute getControlType

getDisabled getLabel getName getOptions getParent getVisible

removeOption setDisabled setFocus setLabel setNotification setVisible

Schnellformular-Steuerelementtype

Informationen zu Methoden, die für diesen Steuerelementtyp unterstützt werden, finden Sie unter formContext.ui.quickForms.

Unterraster-Steuerelementtyp

Informationen zu Methoden, die für diesen Steuerelementtyp unterstützt werden, finden Sie unter Raster und Unterraster.

Zeitplan-Steuerelementtyp

Die Zeitachsensteuerung zeigt die Nachrichten, Aktivitäten und Notizen in einer einheitlichen Ansicht an. Das sind die Methoden, die für diesen Steuerelementtyp verfügbar sind.

getControlType getDisabled getLabel getName

getParent getVisible refresh setDisabled

setFocus setLabel setVisible

Zeitgeber-Steuerelementtyp

Das sind die Methoden, die für den Zeitgeber-Steuerelementtyp verfügbar sind.

getControlType getDisabled getLabel getName

getParent getState getVisible refresh

setDisabled setFocus setLabel setVisible

Webressourcen-Steuerelementtyp

Ein Webressourcesteuerelement hat denselben Satz von Methoden wie das Iframesteuerelement. Siehe IFRAME-Steuerelementtyp

Die Sliverlight-Webressource verfügt über diese zusätzlichen Methoden:

getData setData

Tipp

Wenn Sie alle Steuerelemente ändern möchten, die an eine Spalte in einem Formular gebunden sind, verwenden Sie die Steuerelementauflistung innerhalb des Spaltentyps. Um jedem Steuerelement, das an die Spalte name Spalte gebunden ist, eine Benachrichtigung hinzuzufügen, können Sie beispielsweise Folgendes tun:

 const notification = { messages: ['Sample Notification on Name Controls'], notificationLevel: 'RECOMMENDATION', uniqueId: 'my_unique_id'};
formContext.getAttribute("name").controls.forEach(control => control.addNotification(notification));

„Form component“-Steuerelementtyp

Für einen „form component“-Steuerelementtyp stehen dieselben Methoden zur Verfügung wie für formContext in einem Hauptformular. Siehe Verhalten von Formularkomponenten > Client-API

Ähnliche Artikel

Spalten

Hinweis

Können Sie uns Ihre Präferenzen für die Dokumentationssprache mitteilen? Nehmen Sie an einer kurzen Umfrage teil. (Beachten Sie, dass diese Umfrage auf Englisch ist.)

Die Umfrage dauert etwa sieben Minuten. Es werden keine personenbezogenen Daten erhoben. (Datenschutzbestimmungen).