Client-API-Steuerelemente

Power Pages Client-API-Steuerelemente implementieren die Control Schnittstelle, die allgemeine Methoden zum Verwalten von Formularwerten, Zuständen, Sichtbarkeit, Anforderungen und Validierung bereitstellt. Verwenden Sie diesen Verweis, um verfügbare Methoden und Rückgabetypen zu identifizieren. Informationen zu steuerelementspezifischen Werttypen und zusätzlichen Membern finden Sie unter Client-API-Steuerelementtypen.

Methode Rückgabe Description
getDisabled() boolean Gibt zurück true , wenn das Steuerelement deaktiviert ist; andernfalls wird zurückgegeben false.
getRequired() boolean Gibt zurück true , wenn das Steuerelement erforderlich ist; andernfalls wird zurückgegeben false.
getVisible() boolean Gibt zurück true , wenn das Steuerelement sichtbar ist; andernfalls wird zurückgegeben false.
getName() string Gibt den Namen des Steuerelements zurück.
getType() string | undefined Gibt den Steuerelementtyp zurück, z MultiSelectPicklist. B. oder undefined wenn der Typ nicht verfügbar ist. Siehe Client-API-Steuerelementtypen.
getLogicalName() string | undefined Gibt den logischen Namen des Steuerelements zurück oder undefined wenn der logische Name nicht verfügbar ist.
getValue() Varies Ruft den aktuellen Wert ab. Der Rückgabetyp hängt vom Steuerelementtyp ab.
setDisabled(isDisabled: boolean) void Legt den deaktivierten Zustand des Steuerelements fest.
setRequired(isRequired: boolean, errorMessage?: string) void Legt den erforderlichen Zustand des Steuerelements fest. Weitere Informationen finden Sie unter setRequired-Methodenparameter.
setVisible(isVisible: boolean) void Legt die Sichtbarkeit des Steuerelements fest.
setValue(value) void Legt einen neuen Wert fest. Der erwartete Werttyp hängt vom Steuerelementtyp ab.
addValidator(id: string, evaluationFn: function, errorMessage: string) void Registriert einen benutzerdefinierten clientseitigen Validator für diese Steuerelementinstanz. Weitere Informationen finden Sie unter addValidator-Methodenparameter.
removeValidator(id: string) void Entfernt einen benutzerdefinierten Validator anhand seiner ID aus dieser Steuerelementinstanz. Sie führt nichts aus, wenn die ID nicht vorhanden ist.
clearValidators() void Entfernt alle benutzerdefinierten Validatoren, die dieser Steuerelementinstanz hinzugefügt wurden, mit addValidator. Dies wirkt sich nicht auf den erforderlichen Validator aus, setRequired der verwaltet wird.

parameter der setRequired-Methode

Parameter Type Description
isRequired boolesch Gibt an, ob das Steuerelement erforderlich ist.
errorMessage String (optional) Die lokalisierte Überprüfungsmeldung. Der Standardwert ist <field name> is a required field..

Ist isRequired dies der Fall, registriert die Client-API einen Validator, der beim Senden des Formulars ausgeführt wird. Wenn es "false" ist, wird der Validator entfernt. Sie können ein Steuerelement nicht optional machen, wenn es auf dem Server als erforderlich gekennzeichnet ist.

addValidator-Methodenparameter

Parameter Type Description
id string Ein eindeutiger Bezeichner für die aktuelle Steuerelementinstanz. Ein neuer Validator mit derselben ID ersetzt den vorhandenen Validator.
evaluationFn Funktion Empfängt den Steuerelementwert und gibt true zurück, wenn der Wert gültig ist.
errorMessage string Die Meldung, die in der Überprüfungszusammenfassung angezeigt wird, wenn die Überprüfung fehlschlägt.

Wichtig

Behalten Und wiederverwenden Sie dieselbe Control Objektinstanz, wenn Sie Validatoren ersetzen oder entfernen. Jeder Zugriff auf form.controls und jeder Aufruf gibt getControlByLogicalName eine neue Kontrollfassade zurück.

Wenn die Auswertungsfunktion oder die getValue Methode einen Fehler auslöst, schlägt die Überprüfung fehl, und die Browserkonsole zeichnet den Fehler auf.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    const form = $pages.currentPage.forms.getFormById('form_#1');
    const control = form.getControlByLogicalName('new_keyword');

    control.setRequired(true, 'This field is mandatory.');
    control.addValidator(
        'keywordCheck',
        (value) => ['alpha', 'beta', 'gamma'].includes(value),
        'Value must be one of: alpha, beta, gamma.'
    );
});