Client-API-Steuerelementtypen

In diesem Artikel werden die unterstützten Steuerelementtypen aufgeführt. Alle Steuerelemente verfügen über die allgemeinen Steuerelementmethoden, aber einige Methoden verwenden unterschiedliche Werttypen, und einige Steuerelemente verfügen über zusätzliche Member.

Steuerelementtyp Description
Adressverbund Stellt Adresseingabefelder mit mehreren Unterkomponenten bereit, z. B. Straße, Ort und Bundesland.
Boolean Stellt Optionsfelder mit "true" oder "false" bereit.
DateTime Stellt Datums- und Uhrzeiteingabefelder bereit.
Decimal Stellt Eingabefelder für Dezimalzahlen bereit.
Doppel Stellt Gleitkommazahleneingabefelder bereit.
Dropdown-Nachschlagevorgang Stellt ein nichtmodales Dropdown zum Auswählen eines verknüpften Datensatzes bereit.
E‑Mail Stellt E-Mail-Adresseingabefelder bereit.
File Ermöglicht es jemandem, eine Datei für ein bearbeitbares Formular auszuwählen.
Formatierte ganze Zahl Stellt ganzzahlige Felder bereit, die als Werte wie Dauer, Sprachen und Zeitzonen formatiert sind.
Vollständiger Name Stellt Nameneingabefelder mit mehreren Komponenten bereit, z. B. Vor- und Nachname.
Bild Ermöglicht es jemandem, ein Bild für ein bearbeitbares Formular auszuwählen.
Integer Stellt numerische ganzzahlige Eingabefelder bereit.
Memo Stellt mehrzeile Texteingabefelder bereit.
Modale Suche Stellt ein modales Dialogfeld zum Auswählen eines verknüpften Datensatzes bereit.
Geld Stellt Währungseingabefelder bereit.
Mehrfachauswahl Stellt Kontrollkästchenfelder bereit.
MultiSelect-Auswahlliste Stellt Felder zum Auswählen mehrerer Optionen bereit.
Auswahlliste Stellt Optionssatzfelder bereit, z. B. Dropdowns und Optionsfelder.
Status Stellt den aktuellen Status eines Tabellendatensatzes als schreibgeschützten Wert bereit.
Status-Grund Stellt den aktuellen Statusgrund eines Tabellendatensatzes als schreibgeschützten Wert bereit.
String Stellt einzeilige Texteingabefelder bereit.
Börsenkürzel Stellt Eingabefelder für Aktientickersymbole bereit.
URL Stellt URL-Eingabefelder bereit.

Adressverbund

Adresseingabefelder, die mehrere Unterkomponenten enthalten, z. B. Straße, Ort und Bundesland, verwenden das zusammengesetzte Adresssteuerelement.

Adressverbundeigenschaften und -methoden

Verwenden Sie diese Member, um zusammengesetzte Adresswerte zu konfigurieren und zu lesen.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Siehe setValue-Methodenparameter.
getValue Methode Gibt dasselbe Objekt zurück.

setValue-Methodenparameter

Erwartet ein Objekt mit den folgenden Eigenschaften.

{
    "line1": "address line one value",
    "line2": "address line two value",
    "line3": "address line three value",
    "city": "address city value",
    "state": "address state value",
    "postalCode": "address postalCode value",
    "country": "address country value"
}

Boolesch

Optionsfelder mit True/False-Optionen verwenden das boolesche Steuerelement.

Boolesche Eigenschaften und Methoden

Verwenden Sie diese Member, um boolesche Feldwerte festzulegen und abzurufen.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Erwartet einen Zeichenfolgenwert, der lokalisierten wahr- oder falsch-Werten entspricht.
getValue Methode Gibt den ausgewählten Optionswert als Zeichenfolge zurück.

DateTime

Datums- und Uhrzeiteingabefelder verwenden das DateTime-Steuerelement.

DateTime-Eigenschaften und -Methoden

Verwenden Sie diese Member, um Datums- und Uhrzeitwerte zu verwalten und darauf zuzugreifen.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
isDisabled Eigentum Gibt zurück true , wenn das Feld deaktiviert ist, andernfalls false.
dataType Eigentum Der Datentyp des Datetime-Felds
setValue Methode Erwartet eine Datetime-Zeichenfolge im entsprechenden Format.
getValue Methode Gibt den Datetime-Wert als Zeichenfolge zurück.

Decimal

Eingabefelder für Dezimalzahlen verwenden das Decimal-Steuerelement.

Dezimaleigenschaften und -methoden

Verwenden Sie diese Member, um mit Dezimalzahleneingaben zu arbeiten.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Erwartet eine Zeichenfolge, die eine gültige Dezimalzahl darstellt.
getValue Methode Gibt den Dezimalwert als Zeichenfolge zurück.

Double

Gleitkommazahleneingabefelder verwenden das Double-Steuerelement.

Doppelte Eigenschaften und Methoden

Verwenden Sie diese Member, um Gleitkommazahlenwerte zu behandeln.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Erwartet eine Zeichenfolge, die eine gültige Gleitkommazahl darstellt.
getValue Methode Gibt den Zahlenwert als Zeichenfolge zurück.

Nachschlagesteuerelemente, die nicht modal sind, verwenden das Dropdown-Nachschlagesteuerelement.

Verwenden Sie diese Mitglieder, um mit Dropdown-Nachschlageoptionen zu interagieren.

Mitglied Kind Description
isDropdown Eigentum Ist immer wahr. Verwenden Sie diese Eigenschaft, um zwischen einem modalen Nachschlagevorgang und einem Dropdown-Nachschlagevorgang zu unterscheiden.
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Erwartet einen Zeichenfolgenparameter, der die ID der auszuwählenden Option darstellt.
getValue Methode Gibt ein Objekt des Formulars { id: string, name: string } für die ausgewählte Option oder nicht definiert zurück, wenn keine Option ausgewählt ist.

E-Mail

E-Mail-Eingabefelder verwenden das E-Mail-Steuerelement.

E-Mail-Eigenschaften und -Methoden

Verwenden Sie diese Mitglieder, um E-Mail-Adresswerte zu überprüfen und abzurufen.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Erwartet eine Zeichenfolge, die eine gültige E-Mail-Adresse darstellt.
getValue Methode Gibt den E-Mail-Wert als Zeichenfolge zurück.

Datei

Mit dem Dateisteuerelement kann jemand eine Datei für ein bearbeitbares Formular auswählen.

Dateieigenschaften und -methoden

Verwenden Sie diese Mitglieder, um Dateien auszuwählen, darauf zuzugreifen und sie zu entfernen.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
maxFileSizeInByte Eigentum Die maximale Größe der Datei in Bytes, die Sie hochladen können.
setValue Methode Erwartet ein Objekt vom Typ "Datei " und legt es so fest, als ob jemand es mit der Dateiauswahl ausgewählt hat. Die Methode löst einen Fehler aus, wenn die Datei leer ist oder überschreitet maxFileSizeInByte.
getValue Methode Gibt das File - Objekt zurück, das Sie während der aktuellen Formularsitzung ausgewählt oder festgelegt haben. Es wird keine Datei heruntergeladen, die bereits in Dataverse gespeichert ist.
removeFile Methode Entfernt die Setdatei.

Verwenden Sie die downloadFileFromColumn Methode, um eine Datei herunterzuladen, die in einer Dataverse-Dateispalte gespeichert ist.

Formatierte ganze Zahl

Ganzzahlige Felder mit bestimmten Formatierungsanforderungen wie Dauer, Sprache und Zeitzone verwenden das formatierte ganzzahlige Steuerelement.

Formatierte ganzzahlige Eigenschaften und Methoden

Verwenden Sie diese Member, um ganze Zahlen mit spezieller Formatierung zu verwalten.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Erwartet eine Zeichenfolge, die eine gültige formatierte ganze Zahl darstellt.
getValue Methode Gibt den formatierten ganzzahligen Wert als Zeichenfolge zurück.

Vollständiger Name

Nameneingabefelder, die möglicherweise mehrere Komponenten (Vorname, Nachname usw.) enthalten, verwenden das vollständige Namenssteuerelement.

Methoden mit vollständigem Namen

Verwenden Sie diese Member zum Konfigurieren und Lesen vollständiger Namenskomponenten.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Erwartet ein Objekt mit den folgenden Eigenschaften: { "firstName": "first name value", "middleName": "middle name value", "lastName": "last name value" }.
getValue Methode Gibt dasselbe Objekt zurück.

Image

Mit dem Bildsteuerelement kann jemand ein Bild für ein bearbeitbares Formular auswählen.

Bildeigenschaften und -methoden

Verwenden Sie diese Mitglieder, um Bilder auszuwählen, darauf zuzugreifen und sie zu entfernen.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
maxFileSizeInByte Eigentum Die maximale Größe des Bilds in Bytes, die Sie hochladen können.
setValue Methode Erwartet ein Bild vom Typ "Datei " und legt es so fest, als ob jemand es mit der Dateiauswahl ausgewählt hat. Die Methode löst einen Fehler aus, wenn die Datei leer ist, überschreitet maxFileSizeInByteoder keinen MIME-Bildtyp aufweist.
getValue Methode Gibt das File - Objekt zurück, das Sie während der aktuellen Formularsitzung ausgewählt oder festgelegt haben. Es wird kein Bild heruntergeladen, das bereits in Dataverse gespeichert ist.
removeFile Methode Entfernt das Setbild.

Verwenden Sie die downloadFileFromColumn Methode, um ein Bild herunterzuladen, das in einer Dataverse-Bildspalte gespeichert ist.

Integer

Numerische Eingabefelder verwenden das Ganzzahl-Steuerelement.

Ganzzahlige Eigenschaften und Methoden

Verwenden Sie diese Member, um ganzzahlige Feldwerte festzulegen und abzurufen.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Erwartet eine Zeichenfolge, die eine gültige ganze Zahl darstellt.
getValue Methode Gibt den ganzzahligen Wert als Zeichenfolge zurück.

Mitteilung

Mehrzeilentexteingabefelder verwenden das Memo-Steuerelement.

Memoeigenschaften und -methoden

Verwenden Sie diese Member, um Mehrzeilentexteingabeinhalte zu verwalten.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Erwartet einen Zeichenfolgenwert. Die Methode löst einen Fehler aus, wenn der Wert die konfigurierte maximale Länge des Felds überschreitet.
getValue Methode Gibt den Memotext als Zeichenfolge zurück.

Modale Nachschlagefelder verwenden das modale Nachschlagesteuerelement.

Verwenden Sie diese Member, um modale Nachschlagewerte festzulegen, abzurufen und zu löschen.

Mitglied Kind Description
isModal Eigentum Trifft immer zu. Verwenden Sie diese Eigenschaft, um zwischen modalem Nachschlagen und Dropdown-Nachschlagevorgang zu unterscheiden.
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Erwartet ein Objekt mit den folgenden Eigenschaften: { "id": "Der eindeutige Bezeichner des Datensatzes.", "name": "Der primäre Name-Feldwert des Datensatzes", "entityType": "Der Entitätstypnamewert der Tabelle."}
getValue Methode Gibt dasselbe Objekt zurück.
clearValue Methode Löscht den festgelegten Wert aus dem Feld.

Geld

Währungseingabefelder verwenden das Money-Steuerelement.

Money-Eigenschaften und -Methoden

Verwenden Sie diese Member, um Währungsbeträge festzulegen und abzurufen.

Mitglied Kind Description
readOnly Eigentum true wenn das Feld ein schreibgeschütztes Feld ist, andernfalls false.
setValue Methode Erwartet eine Zeichenfolge, die einen gültigen Geldbetrag darstellt.
getValue Methode gibt den Geldwert als Zeichenfolge zurück.

Multiple-Choice

Kontrollkästchenfelder verwenden das Mehrfachauswahl-Steuerelement.

Methoden für mehrfache Auswahl

Verwenden Sie diese Methoden, um Kontrollkästchenzustände festzulegen und zu lesen.

Mitglied Kind Description
setValue Methode Erwartet einen booleschen Wert.
getValue Methode gibt den Kontrollkästchenstatus als booleschen Wert zurück.

MultiSelect-Auswahlliste

Multiselect-Optionsfelder verwenden das MultiSelect-Auswahllisten-Steuerelement.

MultiSelect-Auswahllistenmethoden

Verwenden Sie diese Methoden, um die ausgewählten Optionen festzulegen und zu lesen.

Mitglied Kind Description
setValue Methode Erwartet ein Array von Zahlen, die die zu markierenden Optionswerte darstellen. Gibt einen Fehler zurück, wenn ein Wert keine der verfügbaren Optionen ist.
getValue Methode Gibt die ausgewählten Optionswerte als Array von Zahlen zurück.
setDisabled Methode Hat keine Auswirkung, wenn das Formular oder das Feld schreibgeschützt ist, da das Steuerelement auf dem Server gesperrt ist.

Im folgenden Beispiel werden die ausgewählten Optionen gelesen und festgelegt.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('form_#1');
    let control = form && form.controls.find(c => c.getType() === 'MultiSelectPicklist');

    if (!control) {
        return;
    }

    // Get the selected values.
    let selectedValues = control.getValue(); // For example, [740740000, 740740001]

    // Set the selected values.
    control.setValue([740740000, 740740001]);
});

Auswahlliste

Optionssatzfelder (Dropdown, Optionsfelder usw.) verwenden das Picklist-Steuerelement.

Picklist-Eigenschaften und -Methoden

Verwenden Sie diese Member zum Konfigurieren und Lesen von Optionssatzauswahlen.

Mitglied Kind Description
subType Eigentum Der Untertyp des Auswahllistensteuerelements. Mögliche Werte sind: VerticalRadioButton, , HorizontalRadioButton, MultipleChoiceMatrixDropdown
setValue Methode Erwartet eine Zeichenfolge, die den Wert der auszuwählenden Option darstellt.
getValue Methode Gibt den ausgewählten Optionswert als Zeichenfolge zurück.

Status

Der aktuelle Status eines Entitätsdatensatzes verwendet das Statussteuerelement.

Note

Dieses Steuerelement lässt das Festlegen des Werts nicht zu. Der Wert ist schreibgeschützt.

Statusgrund

Der aktuelle Statusgrund eines Entitätsdatensatzes verwendet das Statusgrundsteuerelement.

Note

Dieses Steuerelement lässt das Festlegen des Werts nicht zu. Der Wert ist schreibgeschützt.

Schnur

Texteingabefelder verwenden das Zeichenfolgen-Steuerelement.

Zeichenfolgeneigenschaften und -methoden

Verwenden Sie diese Member, um einzeilige Texteingabewerte zu verwalten.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Erwartet einen Zeichenfolgenwert. Die Methode löst einen Fehler aus, wenn der Wert die konfigurierte maximale Länge des Felds überschreitet.
getValue Methode Gibt den Zeichenfolgenwert zurück.

Tickersymbol

Eingabefelder für Aktientickersymbole verwenden das Tickersymbol-Steuerelement.

Eigenschaften und Methoden des Tickersymbols

Verwenden Sie diese Member, um Aktientickersymbole festzulegen und abzurufen.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Erwartet eine Zeichenfolge, die ein gültiges Tickersymbol darstellt.
getValue Methode Gibt das Tickersymbol als Zeichenfolge zurück.

URL

URL-Eingabefelder verwenden das URL-Steuerelement.

URL-Eigenschaften und -Methoden

Verwenden Sie diese Member, um URL-Werte zu überprüfen und abzurufen.

Mitglied Kind Description
isReadOnly Eigentum Gibt zurück true , wenn das Feld schreibgeschützt ist, andernfalls false.
setValue Methode Erwartet eine Zeichenfolge, die eine gültige URL darstellt.
getValue Methode Gibt den URL-Wert als Zeichenfolge zurück.