Interface RuleTemplate

If defined, this function will be called just before elements that represent the control have been added to the document tree.

If true, this control will not appear on its own line but will instead be appended to the previously declared control. Multiple controls can be chained in sequence to combine them into one long row. When true, the control's label property has no effect.

If true, the control will be disabled and the user will not be able to interact with it or change its value.

This will point to the DOM element that best represents the control. This property is set by the interface framework and should be considered read only except for CustomWidgetTemplates.

If defined, this control can be looked up from the template's controls array using this value. It must conform to the regular expression /^[A-Za-z][\w\-\:\.]*$/.

If true, this control will be given focus when the dialog is shown. Default is false.

If defined, this text will be used as a label for the control.

If the control has a label that appears in the dialog, this will point to the DOM element responsible for the label. This property is set by the interface framework and should be considered read only.

If defined, this function will be called once elements that represent the control have been added to the document tree.

If defined, this function will be called whenever the user changes the control's value. If the function makes changes to the template state (changing label text, disabled state, and so on), those changes will be propagated to the actual dialog. If changes are made to the structure of the dialog (such as adding or removing a control), the function must indicate this by returning true. This will cause the dialog content to be rebuilt.

If a tree of DOM nodes is required to represent this control, this will point to the root element of that tree. This property is set by the interface framework and should be considered read only.

If defined, screen readers will use this as the label for the control.