Steuerelemente (Client-API-Referenz)

In modellgesteuerten Apps stellt ein Steuerelement ein HTML-Element im Formular dar. Einige Steuerelemente sind an eine bestimmte Spalte gebunden, während andere ungebundene Steuerelemente darstellen, z. B. eine IFRAME-, Webressource oder ein Teilgrid, das dem 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. Zugriffssteuerungen mithilfe einer der folgenden Auflistungen:

  • formContext.ui.controls
  • formContext.ui Section.controls
  • formContext.data.entityAttribute.controls

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

Anmerkung

Wenn Sie Aktionen für Steuerelemente ausführen, die an eine Spalte gebunden sind, sollten Sie berücksichtigen, dass das Steuerelement auf der Seite mehr als einmal angezeigt wird. Im Allgemeinen sollten Sie dieselben Aktionen für jedes Steuerelement für die Spalte ausführen. Sie können die Sammlung von Spaltensteuerelementen durchlaufen und die Aktionen für jedes Steuerelement ausführen.

Steuerelemente werden nach Typ kategorisiert. Verwenden Sie die getControlType-Methode , um den Typ eines Steuerelements zu bestimmen. Bestimmte Steuerelementmethoden sind nur für bestimmte Steuerelementtypen verfügbar.

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

Standardsteuerelementtyp

Diese Methoden sind für ein Standardsteuerelement verfügbar.

Method Description
addNotification Zeigt eine Fehler- oder Empfehlungsbenachrichtigung mit optionalen Aktionen an.
clearNotification Entfernt eine Benachrichtigung aus dem Steuerelement.
getAttribute Gibt die Spalte zurück, der das Steuerelement zugeordnet ist.
getControlType Gibt den Typ des Steuerelements zurück.
getDisabled Gibt zurück, ob das Steuerelement deaktiviert ist.
getLabel Gibt die Beschriftung des Steuerelements zurück.
getName Gibt den Namen des Steuerelements zurück.
getOutputs Gibt ein Wörterbuch der Ausgabeeigenschaften des Steuerelements zurück.
getParent Gibt den Abschnitt zurück, der das Steuerelement enthält.
getVisible Gibt zurück, ob das Steuerelement sichtbar ist.
setDisabled Aktiviert oder deaktiviert das Steuerelement.
setFocus Verschiebt den Fokus auf das Steuerelement.
setLabel Ändert die Beschriftung des Steuerelements.
setNotification Zeigt eine Fehlermeldung an, die angibt, dass Daten ungültig sind.
setVisible Blendet das Steuerelement ein oder aus.

Die folgenden Methoden für das Standard-Steuerelement sind veraltet: addOnKeyPress, fireOnKeyPress und removeOnKeyPress.

IFRAME-Steuerelementtyp

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

Method Description
getContentWindow Gibt das Inhaltsfenster der IFRAME- oder Webressource zurück.
getControlType Gibt den Typ des Steuerelements zurück.
getDisabled Gibt zurück, ob das Steuerelement deaktiviert ist.
getInitialUrl Gibt die standard-URL zurück, die für den IFRAME konfiguriert ist.
getLabel Gibt die Beschriftung des Steuerelements zurück.
getName Gibt den Namen des Steuerelements zurück.
getObject Gibt das Formularobjekt zurück, das die IFRAME- oder Webressource darstellt.
getParent Gibt den Abschnitt zurück, der das Steuerelement enthält.
getSrc Gibt die URL zurück, die derzeit in der IFRAME- oder Webressource angezeigt wird.
getVisible Gibt zurück, ob das Steuerelement sichtbar ist.
setDisabled Aktiviert oder deaktiviert das Steuerelement.
setFocus Verschiebt den Fokus auf das Steuerelement.
setLabel Ändert die Beschriftung des Steuerelements.
setSrc Legt die URL fest, die in der IFRAME- oder Webressource angezeigt werden soll.
setVisible Blendet das Steuerelement ein oder aus.

Kbsearch -Steuerelementtyp (Knowledge Base Search)

Diese Methoden sind für das Knowledge Base-Suchsteuerelement verfügbar.

Method Description
addOnPostSearch Fügt einen Ereignishandler hinzu, der nach Abschluss einer Suche ausgeführt wird.
addOnResultOpened Fügt einen Ereignishandler hinzu, der ausgeführt wird, wenn ein Suchergebnis geöffnet wird.
addOnSelection Fügt einen Ereignishandler hinzu, der ausgeführt wird, wenn ein Suchergebnis ausgewählt wird.
getControlType Gibt den Typ des Steuerelements zurück.
getDisabled Gibt zurück, ob das Steuerelement deaktiviert ist.
getLabel Gibt die Beschriftung des Steuerelements zurück.
getName Gibt den Namen des Steuerelements zurück.
getParent Gibt den Abschnitt zurück, der das Steuerelement enthält.
getSearchQuery Gibt den Text zurück, der als Suchkriterien verwendet wird.
getSelectedResults Gibt das aktuell ausgewählte Suchergebnis zurück.
getTotalResultCount Gibt die Anzahl der Suchergebnisse zurück.
getVisible Gibt zurück, ob das Steuerelement sichtbar ist.
openSearchResult Öffnet ein angegebenes Suchergebnis.
removeOnPostSearch Entfernt einen Ereignishandler für den Abschluss der Suche.
removeOnResultOpened Entfernt einen Ereignishandler zum Öffnen eines Suchergebnisses.
removeOnSelection Entfernt einen Ereignishandler zum Auswählen eines Suchergebnisses.
setFocus Verschiebt den Fokus auf das Steuerelement.
setLabel Ändert die Beschriftung des Steuerelements.
setSearchQuery Legt den Text fest, der als Suchkriterien verwendet wird.
setVisible Blendet das Steuerelement ein oder aus.

Anmerkung

Wenn Sie das Knowledge Base-Suchsteuerelement zum Sozialen Bereich hinzufügen, lautet searchwidgetcontrol_notescontrolder Steuerelementname . Du kannst diesen Namen nicht ändern.

Lookup-Steuerelementtyp

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

Method Description
addCustomFilter Fügt den Nachschlageergebnissen einen Filter hinzu, kombiniert mit vorhandenen Filtern mithilfe von AND.
addCustomView Fügt dem Nachschlagedialogfeld eine Ansicht hinzu.
addNotification Zeigt eine Fehler- oder Empfehlungsbenachrichtigung mit optionalen Aktionen an.
addOnLookupTagClick Fügt einen Ereignishandler hinzu, der ausgeführt wird, wenn auf ein Nachschlagetag geklickt wird.
addPreSearch Fügt einen Ereignishandler hinzu, der vor einer Nachschlagesuche ausgeführt wird.
clearNotification Entfernt eine Benachrichtigung aus dem Steuerelement.
getAttribute Gibt die Spalte zurück, der das Steuerelement zugeordnet ist.
getControlType Gibt den Typ des Steuerelements zurück.
getDefaultView Gibt die ID der Standard-Nachschlageansicht zurück.
getDisabled Gibt zurück, ob das Steuerelement deaktiviert ist.
getEntityTypes Gibt die im Nachschlagevorgang zulässigen Tabellentypen zurück.
getLabel Gibt die Beschriftung des Steuerelements zurück.
getName Gibt den Namen des Steuerelements zurück.
getParent Gibt den Abschnitt zurück, der das Steuerelement enthält.
getVisible Gibt zurück, ob das Steuerelement sichtbar ist.
removeOnLookupTagClick Entfernt einen Ereignishandler für Nachschlagetagklicks.
removePreSearch Entfernt einen Ereignishandler, der vor einer Nachschlagesuche ausgeführt wird.
setDefaultView Legt die Standardansicht im Nachschlagedialogfeld fest.
setDisabled Aktiviert oder deaktiviert das Steuerelement.
setEntityTypes Legt die im Nachschlagevorgang zulässigen Tabellentypen fest.
setFocus Verschiebt den Fokus auf das Steuerelement.
setLabel Ändert die Beschriftung des Steuerelements.
setNotification Zeigt eine Fehlermeldung an, die angibt, dass Daten ungültig sind.
setVisible Blendet das Steuerelement ein oder aus.

Auswahlmöglichkeiten und Auswahlspaltentypen

Auswahl- und Auswahlsteuerelemente verfügen über denselben Satz verfügbarer Methoden.

Method Description
addNotification Zeigt eine Fehler- oder Empfehlungsbenachrichtigung mit optionalen Aktionen an.
addOption Fügt dem Steuerelement eine Option hinzu.
clearNotification Entfernt eine Benachrichtigung aus dem Steuerelement.
clearOptions Entfernt alle Optionen aus dem Steuerelement.
getAttribute Gibt die Spalte zurück, der das Steuerelement zugeordnet ist.
getControlType Gibt den Typ des Steuerelements zurück.
getDisabled Gibt zurück, ob das Steuerelement deaktiviert ist.
getLabel Gibt die Beschriftung des Steuerelements zurück.
getName Gibt den Namen des Steuerelements zurück.
getOptions Gibt die verfügbaren Optionen zurück, einschließlich der leeren Option und ohne entfernte Optionen.
getParent Gibt den Abschnitt zurück, der das Steuerelement enthält.
getVisible Gibt zurück, ob das Steuerelement sichtbar ist.
removeOption Entfernt eine Option aus dem Steuerelement.
setDisabled Aktiviert oder deaktiviert das Steuerelement.
setFocus Verschiebt den Fokus auf das Steuerelement.
setLabel Ändert die Beschriftung des Steuerelements.
setNotification Zeigt eine Fehlermeldung an, die angibt, dass Daten ungültig sind.
setVisible Blendet das Steuerelement ein oder aus.

Schnellformular-Steuerelementtyp

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 "Grids" und "Subgrids ".

Typ des Zeitachsen-Wandsteuerelements

Das Zeitachsensteuerelement stellt die Beiträge, Aktivitäten und Notizen in einer einheitlichen Ansicht dar. Das sind die Methoden, die für diesen Steuerelementtyp verfügbar sind.

Method Description
getControlType Gibt den Typ des Steuerelements zurück.
getDisabled Gibt zurück, ob das Steuerelement deaktiviert ist.
getLabel Gibt die Beschriftung des Steuerelements zurück.
getName Gibt den Namen des Steuerelements zurück.
getParent Gibt den Abschnitt zurück, der das Steuerelement enthält.
getVisible Gibt zurück, ob das Steuerelement sichtbar ist.
refresh Aktualisiert die in der Zeitachse angezeigten Daten.
setDisabled Aktiviert oder deaktiviert das Steuerelement.
setFocus Verschiebt den Fokus auf das Steuerelement.
setLabel Ändert die Beschriftung des Steuerelements.
setVisible Blendet das Steuerelement ein oder aus.

Zeitgeber-Steuerelementtyp

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

Method Description
getControlType Gibt den Typ des Steuerelements zurück.
getDisabled Gibt zurück, ob das Steuerelement deaktiviert ist.
getLabel Gibt die Beschriftung des Steuerelements zurück.
getName Gibt den Namen des Steuerelements zurück.
getParent Gibt den Abschnitt zurück, der das Steuerelement enthält.
getState Gibt den aktuellen Zustand des Timers zurück.
getVisible Gibt zurück, ob das Steuerelement sichtbar ist.
refresh Aktualisiert die im Timer angezeigten Daten.
setDisabled Aktiviert oder deaktiviert das Steuerelement.
setFocus Verschiebt den Fokus auf das Steuerelement.
setLabel Ändert die Beschriftung des Steuerelements.
setVisible Blendet das Steuerelement ein oder aus.

Webressourcen-Steuerelementtyp

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

„Form component“-Steuerelementtyp

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

Spalten