Client-API-Formulare, Registerkarten und Abschnitte

Verwenden Sie Power Pages Client-API-Formulare, Registerkarten, Abschnitte und Steuerelemente, um Seitenelemente zu prüfen und zu verwalten. In dieser Referenz werden die verfügbaren Auflistungen, Eigenschaften und Methoden zum Steuern von Sichtbarkeit, Werten und mehrstufiger Navigation erläutert.

$pages.currentPage.forms

Die $pages.currentPage.forms Auflistung enthält Methoden zum Arbeiten mit Formularelementen auf der Seite.

methoden $pages.currentPage.forms

Verwenden Sie diese Methoden, um Formulare auflisten und bestimmte Formularinstanzen abzurufen.

Methode Rückgabe Description
getAll IForm[] Gibt alle Formulare zurück, die der aktuellen Seite hinzugefügt wurden.
getFormById(id: string) IForm Ruft ein Formular anhand seiner HTML-Element-ID ab.
getFormByName(name: string) IForm Ruft ein Formular anhand seines Namens ab.

Beispiele für $pages.currentPage.forms-Methode

In diesen Beispielen wird gezeigt, wie Sie alle Formulare abrufen und bestimmte Formulare nach ID oder Name abrufen.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let forms = $pages.currentPage.forms.getAll();
    let form1 = $pages.currentPage.forms.getFormById('form_#1');
    let form2 = $pages.currentPage.forms.getFormByName('form_name')
});

IForm-Schnittstelle

Die IForm Schnittstelle stellt einen Container für Steuerelemente und Registerkarten dar.

IForm-Eigenschaften

Die folgenden Eigenschaften beschreiben das Formular und die darin enthaltenen Steuerelemente und Registerkarten.

Eigentum Type Description
id string Die ID des Formulars.
name string Der Name des Formulars.
controls Steuerung[] Alle Steuerelemente im Formular.
tabs Registerkarte[] Alle Registerkarten im Formular.
isMultiStep boolesch True, wenn das Formular multisteps ist; andernfalls "false". Siehe Formular mit mehreren Schritten.

IForm-Methoden

Verwenden Sie diese Methoden, um die Sichtbarkeit eines Formulars abzufragen und umzuschalten, ob es sichtbar ist.

Methode Rückgabe Description
getVisible boolean Gibt true zurück, wenn das Formular sichtbar ist; andernfalls "false".
setVisible(isVisible: boolean) void Legt die Sichtbarkeit des Formulars fest.
getHtmlElement HTMLElement Gibt das zugrunde liegende HTML-Element für das Formular zurück.
getControlByLogicalName(logicalName: string) Steuerelement | undefined Gibt das Steuerelement für das Formular zurück, das den angegebenen logischen Namen aufweist, z. B. den Spaltenschemanamen. Gibt nicht definiert zurück, wenn kein Steuerelement übereinstimmt.

IForm-Beispiel

Im folgenden Beispiel wird ein Formular anhand der ID abgerufen und die Sichtbarkeit, anzahl der Steuerelemente und Registerkarten protokolliert.

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

    console.log(`Form id: ${form.id} has ${form.controls.length} controls.`);

    if (form.getVisible()) {
        console.log('Form is currently visible.');
    }
    let tabs = form.tabs;
    console.log(`Form has ${tabs.length} tabs.`);

    // Look up a control by its logical name.
    let nameControl = form.getControlByLogicalName('fullname');
    if (nameControl) {
        nameControl.setValue('Jane Doe');
    }
});

Mehrstufiges Formular

Ein mehrstufiges Formular ist ein Container, der mehrere grundlegende Formulare enthält.

Mehrstufige Formulareigenschaften

Die folgenden Eigenschaften gelten für den Mehrschritt-Formularcontainer und beschreiben, was im derzeit aktiven Schritt verfügbar ist.

Eigentum Type Description
id string Die ID des mehrstufigen Formulars.
controls Steuerung[] Alle Steuerelemente im aktuellen Schritt.
tabs Registerkarte[] Alle Registerkarten im aktuellen Schritt.
isMultiStep boolesch True, wenn das Formular multisteps ist; andernfalls "false".
nextButton JQuery-Element Stellt die nächste Schaltfläche dar (leeres Objekt, falls nicht vorhanden).
previousButton JQuery-Element Stellt die vorherige Schaltfläche dar (leeres Objekt, falls nicht vorhanden).

Multistep-Formularmethoden

Verwenden Sie diese Methoden, um die Sichtbarkeit zu überprüfen und zwischen Schritten in einem mehrstufigen Format zu wechseln.

Name Rückgabe Description
getVisible boolean Gibt true zurück, wenn das Formular sichtbar ist; andernfalls "false".
setVisible(isVisible: boolean) void Legt die Sichtbarkeit des Formulars fest.
hasNextStep boolean Gibt true zurück, wenn ein nächster Schritt vorhanden ist; andernfalls "false".
hasPreviousStep boolean Gibt true zurück, wenn ein vorheriger Schritt vorhanden ist; andernfalls "false".
goToNextStep void Navigiert zum nächsten Schritt; sendet das Formular, wenn kein nächster Schritt vorhanden ist.
goToPreviousStep void Navigiert zum vorherigen Schritt; löst eine Ausnahme aus, wenn keine vorhanden ist.
getControlByLogicalName(logicalName: string) Steuerelement | undefined Gibt das Steuerelement im aktuellen Schritt zurück, das den angegebenen logischen Namen aufweist, z. B. den Spaltenschemanamen. Gibt nicht definiert zurück, wenn kein Steuerelement übereinstimmt.

Beispiel für ein mehrstufiges Formular

In diesem Beispiel wird gezeigt, wie Sie ein mehrstufiges Formular abrufen, prüfen und zum nächsten Schritt wechseln.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('multiform_#1');
    console.log(`Form id: ${form.id} has ${form.controls.length} controls.`);

    if (form.getVisible()) {
        console.log('Form is currently visible.');
    }

    let tabs = form.tabs;
    console.log(`Form has ${tabs.length} tabs.`);

    form.goToNextStep();
});

Tab

A Tab enthält einen oder mehrere Abschnitte in einem Formular.

Tab-Eigenschaft Sections

Ein Array von Abschnitten auf der Registerkarte.

Tab-Methoden

Verwenden Sie diese Methoden, um die Sichtbarkeit einer Registerkarte zu überprüfen, den Namen abzurufen und umzuschalten, ob sie sichtbar ist.

Methode Rückgabe Description
getVisible boolean Gibt true zurück, wenn die Registerkarte sichtbar ist; andernfalls "false".
getName string Gibt den Namen der Registerkarte zurück.
setVisible(isVisible: boolean) void Legt die Sichtbarkeit der Registerkarte fest.

Registerkartenbeispiel

In diesem Beispiel wird ein Formular abgerufen, dessen Registerkarten aufgelistet und der Name der ersten Registerkarte protokolliert.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('form_#1');
    let tabs = form.tabs;
    console.log(`Form has ${tabs.length} tabs.`);
    console.log(`First tab is named: ${tabs[0].getName()}`);
});

Abschnitt

Abschnitte gruppieren Steuerelemente innerhalb einer Registerkarte.

Section-Eigenschaft Controls

Ein Array von Steuerelementen innerhalb des Abschnitts.

Section-Methoden

Verwenden Sie diese Methoden, um den Namen eines Abschnitts zu lesen und seine Sichtbarkeit zu steuern.

Methode Rückgabe Description
getVisible boolean Gibt true zurück, wenn der Abschnitt sichtbar ist; andernfalls "false".
getName string Gibt den Abschnittsnamen zurück.
setVisible(isVisible: boolean) void Legt die Sichtbarkeit des Abschnitts fest.

Abschnittsbeispiel

In diesem Beispiel werden Abschnitte aus der ersten Registerkarte eines Formulars abgerufen und grundlegende Details protokolliert.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('form_#1');
    let sections = form.tabs[0].sections;
    console.log(`Tab has ${sections.length} section(s).`);
    console.log(`First section is named: ${sections[0].getName()}`);
});

Steuerung

A Control stellt ein einzelnes Formularelement dar. Verwenden Sie die allgemeinen Steuerelementmethoden zum Abrufen oder Aktualisieren des Werts, der Sichtbarkeit, des erforderlichen Zustands und des deaktivierten Zustands und zum Hinzufügen der clientseitigen Überprüfung. Die Werttypen und zusätzliche Member sind vom Steuerelementtyp abhängig.