MenuCheckBox API 

Description of UI Element Properties

·        checked
This property specifies whether or not the MenuCheckbox is selected. The Boolean value true indicates that the option is selected. A checkmark appears in the graphic that is displayed on the screen.

·        enabled
This property specifies whether or not an event can be triggered by a user interaction.

·        needsMoreInfo
This property adds … to the text of the menu item to indicate to the user that additional user input is required after selecting this menu item.

·        text
This property specifies the text that is associated with the MenuCheckbox graphic and displayed to the right of the box.

·        textDirection
With this property you can specify the text direction. It thus enables the labels for the MenuCheckBox to be read in other languages that require a specific text direction. The textDirection property can be filled with the following values and is represented by the listing type WDTextDirection.

inherit	The text direction is inherited from the parent element. Therefore, the text direction is identical to the one of the parent element.
ltr	The text runs from left to right.
rtl	The text runs from right to left.

The default value for this property is inherit.

 

Overview of Inherited and Additional Properties

Name	Interface	Type	Initial Value	Bindable	Value Required
checked	IWDMenuCheckBox	boolean	false	bindable_mandatory	No
enabled	IWDMenuCheckBox	boolean	true	bindable	No
needsMoreInfo	IWDMenuCheckBox	boolean	false	bindable	No
text	IWDMenuCheckBox	String		bindable	No
textDirection	IWDMenuCheckBox	WDTextDirection	inherit	bindable	No

Events

The event is triggered when the checkbox is switched. The parameter is the new status.

Name	Class	Parameter
onToggle	MenuCheckBox	(boolean checked)