« Back to Product

Documentation

SelectInstance

Creates a selection dialog with the caption caption.
If created in the "elements" area, the property name is set to the ID of the selected instance when accepted.

Example

Parameters

Parameter Description
caption Visible caption
download (optional) (default: "") If this parameter is not an empty string and the output of the onChange script is a Data-URL, the output is downloaded as a text file with the name of the download parameter. (since IP-Symcon 7.0)
enabled (optional) (default: true) If true, the instance selection can be used, otherwise it is displayed as deactivated (since IP-Symcon 5.2)
link (optional) (default: false) If this parameter is true, the output of the onChange script is opened as a link. If it is false, the output is displayed as a dialog in the configuration form. (since IP-Symcon 6.0)
name (optional) Name of the instance selection/the property to be set
onChange (optional) (default: "") Script which is executed when the value of the instance selection is changed. If the script consists of several lines, the individual lines can also be defined as an array (arrays are supported since version 6.0). It has the same properties as onClick of the Button (since IP-Symcon 5.2)
type SelectInstance
validModules (optional) (default: []) The selection is restricted to instances that have one of the defined moduleIDs. If the list is empty, all instances are allowed. If the selected instance does not correspond to any of the moduleIDs, an error is displayed and changes cannot be accepted. (since IP-Symcon 5.5)
value (optional) (default: 0) The value of the instance selection - If there is an associated property, this parameter is overwritten by the property in the elements area (since IP-Symcon 5.2)
visible (optional) (default: true) If true, the instance selection is visible, otherwise it is invisible (since IP-Symcon 5.2)
width (optional) (default: 300px) Fixed width of the instance selection in pixels or % as a string, e.g. "40%" or "250px" (since IP-Symcon 5.3)

Example

{ "type": "SelectInstance", "name": "PropertyInstanceID", "caption": "Target" }
Any questions?