Binding Expression

Dashboard binding expressions are very similar to server binding expressions. However, binding expressions in dashboards may include several primary types of references:

• Standard references (with no schema) that point to server context variables or functions, as well as their fields or properties

• Component references (with form/ schema) that point to properties, events, or functions of dashboard components

• Web UI special references (with web/ schema) that trigger operations specific to Web UI

• Dashboard parameters available as expression environment variables (with env/ schema)

• Activator Event’s data reference (written as env/value) which points to environment variable named value that contains Data Table of event that caused binding’s activation.

A component reference points to a property of a dashboard component (e.g. the text of a Label ). It has the following format:

form/component:property

form is the name of the schema used to identify component references. It tells the expression language processor to resolve the reference according to the component, as opposed to a standard reference. Component references must always start with form/.

component is the name of the dashboard component you want to work with. The component name is shown in Component Tree and in the title of the Component Properties Window when the component is selected in UI Builder.

property is the name of a specific property within the component. Property names can be found in the description of properties of every dashboard component. Property part of a component reference is optional. If it is omitted, the reference points to the default property of the component.

Format of property, i.e. type of value returned by a component property reference, may be found in the description of this property in the components reference.

{form/userNameField:}

{form/userNameField:text}

Both of these two references resolve to the text currently contained in userNameField (assuming that's a text field ). The first variant points to the default property of component, which is text, and the second one names it explicitly (:text).

Web UI Special References are specific to the Web UI and are indicated with the web/ schema.

Many web dashboard components generate events from user interaction or when their properties have been changed by some other means. Some events include related information (such as coordinates of a mouse click point within a component’s area).

The reference env/value (i.e. a reference to an environment variable called value) points to the Data Table containing data of event that caused binding activation.

{form/numberField1:value} * 100

This expression will resolve to a number that equals to the value property of a Number Field component called numberField1, multiplied by 100.

Was this page helpful?

Tell us more

Send

Thank you!