Vorteile benutzerdefinierter Funktionen
Vorteile der Verwendung benutzerdefinierter Funktionen in Kernkomponenten für adaptive Formulare sind:
- Datenverwaltung: Benutzerdefinierte Funktionen helfen beim Verwalten und Verarbeiten der Daten, die in die Formularfelder eingegeben wurden.
- Datenverarbeitung: Benutzerdefinierte Funktionen helfen bei der Verarbeitung der in die Formularfelder eingegebenen Daten.
- Datenvalidierung: Benutzerdefinierte Funktionen ermöglichen Ihnen benutzerdefinierte Überprüfungen von Formulareingaben und das Anzeigen bestimmter Fehlermeldungen.
- Dynamisches Verhalten: Mit benutzerdefinierten Funktionen können Sie das dynamische Verhalten Ihrer Formulare anhand bestimmter Bedingungen steuern. Beispielsweise können Sie Felder ein-/ausblenden, Feldwerte ändern oder die Formularlogik dynamisch anpassen.
- Integration: Sie können benutzerdefinierte Funktionen zur Integration mit externen APIs oder Diensten verwenden. Dies ist hilfreich beim Abrufen von Daten aus externen Quellen, beim Senden von Daten an externe REST-Endpunkte oder beim Ausführen benutzerdefinierter Aktionen entsprechend externer Ereignisse.
Benutzerdefinierte Funktionen sind im Wesentlichen Client-Bibliotheken, die in der JavaScript-Datei hinzugefügt werden. Nachdem Sie eine benutzerdefinierte Funktion erstellt haben, steht sie im Regeleditor zur Auswahl durch Benutzende in einem adaptiven Formular zur Verfügung. Die benutzerdefinierten Funktionen sind im Regeleditor anhand der JavaScript-Anmerkungen zu erkennen.
Unterstützte JavaScript-Anmerkungen für benutzerdefinierte Funktionen
JavaScript-Anmerkungen bieten Metadaten für JavaScript-Code. Dies schließt Kommentare ein, die mit bestimmten Symbolen beginnen, z. B. /**
und @
. Die Anmerkungen enthalten wichtige Informationen zu Funktionen, Variablen und anderen Elementen im Code. Adaptive Formulare unterstützen die folgenden JavaScript-Anmerkungen für benutzerdefinierte Funktionen:
Name
Der Name wird verwendet, um die benutzerdefinierte Funktion im Regeleditor eines adaptiven Formulars zu erkennen. Die folgenden Syntaxen werden verwendet, um eine benutzerdefinierte Funktion zu benennen:
@name [functionName] <Function Name>
@function [functionName] <Function Name>
@func [functionName] <Function Name>
[functionName]
ist der Name der Funktion. Leerzeichen sind nicht zulässig.<Function Name>
ist der Anzeigename der Funktion im Regeleditor von adaptiven Formularen.Wenn der Anzeigename der Funktion mit dem Namen der Funktion selbst übereinstimmt, können Sie in der Syntax
[functionName]
weglassen.Parameter
Der Parameter ist eine Liste von Argumenten, die von benutzerdefinierten Funktionen verwendet werden. Eine Funktion kann mehrere Parameter unterstützen. Die folgenden Syntaxen werden verwendet, um einen Parameter in einer benutzerdefinierten Funktion zu definieren:
-
@param {type} name <Parameter Description>
-
@argument
{type} name <Parameter Description>
-
@arg
{type}
name <Parameter Description>
{type}
gibt den Parametertyp an. Zulässige Parametertypen sind:- string: Stellt einen einzelnen Zeichenfolgenwert dar.
- number: Stellt einen einzelnen numerischen Wert dar.
- boolean: Stellt einen einzelnen booleschen Wert dar (true oder false).
- string[]: Stellt ein Array von Zeichenfolgenwerten dar.
- number[]: Stellt ein Array numerischer Werte dar.
- boolean[]: Stellt ein Array boolescher Werte dar.
- date: Stellt einen einzelnen Datumswert dar.
- date[]: Stellt ein Array von Datumswerten dar.
- array: Stellt ein generisches Array dar, das Werte verschiedener Typen enthält.
- object: Stellt ein an eine benutzerdefinierte Funktion übergebenes Formularobjekt dar, anstatt dessen Wert direkt weiterzugeben.
- scope: Stellt das globals-Objekt dar, das schreibgeschützte Variablen wie Formularinstanzen, Zielfeldinstanzen und Methoden zum Ausführen von Formularänderungen innerhalb der benutzerdefinierten Funktionen enthält. Es wird als letzter Parameter in den JavaScript-Anmerkungen deklariert und ist für den Regeleditor eines adaptiven Formulars nicht sichtbar. Der Parameter „scope“ greift auf das Objekt des Formulars oder der Komponente zu, um die für die Formularverarbeitung erforderliche Regel oder das Ereignis auszulösen. Um weitere Informationen zum globals-Objekt und dessen Verwendung zu erhalten, klicken Sie hier.
Beim Parametertyp wird nicht zwischen Groß- und Kleinschreibung unterschieden und Leerzeichen sind im Parameternamen nicht zulässig.
<Parameter Description>
enthält Details zum Zweck des Parameters. Dies kann aus mehreren Wörtern bestehen.
Rückgabetyp
Der Rückgabetyp gibt den Typ des Werts an, den die benutzerdefinierte Funktion nach der Ausführung zurückgibt. Die folgenden Syntaxen werden verwendet, um einen Rückgabetyp in einer benutzerdefinierten Funktion zu definieren:
@return {type}
@returns {type}
{type}
gibt den Rückgabetyp der Funktion an. Zulässige Rückgabetypen sind:- string: Stellt einen einzelnen Zeichenfolgenwert dar.
- number: Stellt einen einzelnen numerischen Wert dar.
- boolean: Stellt einen einzelnen booleschen Wert dar (true oder false).
- string[]: Stellt ein Array von Zeichenfolgenwerten dar.
- number[]: Stellt ein Array numerischer Werte dar.
- boolean[]: Stellt ein Array boolescher Werte dar.
- date: Stellt einen einzelnen Datumswert dar.
- date[]: Stellt ein Array von Datumswerten dar.
- array: Stellt ein generisches Array dar, das Werte verschiedener Typen enthält.
- object: Stellt das Formularobjekt anstatt direkt den Wert dar.
Beim Rückgabetyp wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Privat
Die als privat deklarierte benutzerdefinierte Funktion wird nicht in der Liste der benutzerdefinierten Funktionen im Regeleditor eines adaptiven Formulars angezeigt. Standardmäßig sind benutzerdefinierte Funktionen öffentlich. Die Syntax zum Deklarieren der benutzerdefinierten Funktion als privat lautet @private
.