« Back to Product

Documentation

UpdateFormField

Require: IP-Symcon >= 5.2

 void UpdateFormField (string $Field, string $Parameters, variant $Value) 

Parameters

Field

Name of the form field to be changed

Parameters

Name of the parameter to be changed

Value

New value of the parameter

Returns

No Return

Description

This function sets the parameter Parameter of the form field named Field to the value Value in every open instance configuration of this instance. If a form field with this name exists in the element and action areas, both are updated.

Warning

It is not possible to change the Name and Type parameters of form fields. Other parameters that cannot be changed are listed in the respective documentation.

Warning

For complex parameters, i.e. lists or objects, the new value must be passed in JSON-encoded form.

Example

// hide the button
$this->UpdateFormField("MyButton", "visible", false);
Any questions?