/
A.07 Workflow Parameter

A.07 Workflow Parameter

Owned by Team Dodo
Last updated: Mar 31, 2025 by Technische Redaktion
2 min read

Die Parameterobjekte bieten eine minimalistische API, über die der Wert des Parameters geändert werden kann.

WfParameter.model

Eigenschaft

Verfügbar ab

Beschreibung

Eigenschaft

Verfügbar ab

Beschreibung

fieldInternalName

11.10.7

Interner Name des Maskenelements, an das der Parameter gebunden ist
Dieser Wert ist in früheren Versionen leer

fieldId

8.50 Final

ID des Maskenelementes, an das der Parameter gebunden ist

id

8.50 Final

ID des Parameters

mode

11.10.7

Schreibschutz-Status des Parameters: 

  • 1: Read-Only

  • 2: Write-Only

  • 3: Read-Write 

name

8.50 Final

Name des Parameters

type

8.50 Final

Datentyp des Parameters

parameterType

11.10.7

Typ des Parameters

WfParameter.api

API-Methode

Verfügbar ab

Beschreibung

API-Methode

Verfügbar ab

Beschreibung

getField()

8.50 Final

Liefert das Workflowmaskenfeld zum Parameter oder NULL, wenn der Parameter an kein Feld gebunden ist.

Beispiel

var parameter = formHelper.getParameterByName("wfOrderNumber"); var field = parameter.api.getField(); field.api.setValue("New Value");

getValue({transformValues})

8.50 Final

Liefert den Wert des Parameters zurück.

Optionaler Parameter:

  • transformValues – legt fest, ob Datumswerte in Timestamps umgewandelt werden sollen. Standard ist 'false'.

Beispiel

var parameter = formHelper.getParameterByName("wfOrderNumber"); var value = parameter.api.getValue(false);

getInitialValue({transformValues})

9.00 SR4

Liefert den initialen Wert des Parameters zurück. Der Wert entspicht dem Wert des Feldes bevor das Show/BeforeOpen-Event ausgeführt wurde.

Optionaler Parameter:

  • transformValues – legt fest, ob Datumswerte in Timestamps umgewandelt werden sollen. Standard ist 'false'.

Beispiel

var parameter = formHelper.getParameterByName("wfOrderNumber"); var value = parameter.api.getInitialValue(false);

setValue({value},{updateFieldValue})

8.50 Final

Ändert den Wert eines Parameters.

Parameter:

  • value – neuer Wert des Feldes

  • updateFieldValue – legt fest, ob der Wert des Feldes, das mit dem Parameter verbunden ist, automatisch aktualisiert wird. Standard ist 'true'.

Beispiel

var parameter = formHelper.getParameterByName("wfOrderNumber"); parameter.api.setValue("New Value", false);

getRows()

8.50 Final

Gibt den Inhalt aller Zeilen der Liste als zweidimensionales Array zurück. Die Funktion steht nur für Parameter des Typs "Liste" zur Verfügung.

Beispiel

var parameter = formHelper.getParameterByName("wfTable"); var value = parameter.api.getRows();

getInitialRows()

9.00 SR4

Gibt den initialen Inhalt aller Zeilen der Liste als zweidimensionales Array zurück. Die Funktion steht nur für Parameter des Typs "Liste" zur Verfügung. Der Wert entspicht dem Wert des Feldes bevor das Show/BeforeOpen-Event ausgeführt wurde.

Beispiel

var parameter = formHelper.getParameterByName("wfTable"); var value = parameter.api.getInitialRows();

addRow()

addRow({values})

8.50 Final

Fügt eine Zeile am Ende der Liste des Parameters hinzu. Funktion steht nur für Parameter des Typs "Liste" zur Verfügung.
Optionaler Parameter:

  • values – Array von Werten für die Zellen einer Zeile

Beispiel

var parameter = formHelper.getParameterByName("wfTable"); parameter.api.addRow(["value Zelle 1", "value Zelle 2"]);

editRow({index},{values})

8.50 Final

Bearbeitet eine Zeile. Funktion steht nur für Parameter des Typs "Liste" zur Verfügung.

Parameter:

  • index – Index der Zeile

  • values – Array von Werten für die Zellen einer Zeile

Beispiel

var parameter = formHelper.getParameterByName("wfTable"); parameter.api.editRow(1, ["value Zelle 1", "value Zelle 2"]);

removeRow({index})

8.50 Final

Entfernt eine Zeile. Funktion steht nur für Parameter des Typs "Liste" zur Verfügung.

Parameter:

  • index – Index der Zeile

Beispiel

var parameter = formHelper.getParameterByName("wfTable"); parameter.api.removeRow(1);

 

Related content