RadioButton API 

Definition

The RadioButton UI element is a button with two states (on/off) that enables users to select options. The RadioButton UI element allows you to spread the displayed radio buttons individually on the screen instead of grouping them in a table. You can toggle the radio button when you bind the UI elements to the same context attribute.

The radio button is selected if the context attribute to which the selectedKey property is bound  contains the value of the key that belongs to this radio button. The key is specified by property keyToSelect.

Description of UI Element Properties

●     keyToSelect

This property specifies the value of the key used to select this radio button.

●     selectedKey

Specifies the path of the context attribute that stores the selected key.

●     readOnly

Specifies whether or not the user can make selections in the checkbox.

●     state

Describes the error status of the UI element. The data type of this property corresponds to enumeration type WDState. You can use the following values in the application:

normal	Describes the default state of the UI element.
required	Specifies whether the entered value is required.

●     text

This property describes the text next to the radio button.

●     textDirection

Specifies the text direction and allows you to use a radio button for texts in languages which require a specific text direction. Property textDirection can take the following values and is represented by enumeration type WDTextDirection.

inherit	The text direction is inherited from the parent element. The text direction is therefore identical to that 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
enabled	IWDUIElement	boolean	True	bindable	No
keyToSelect	IWDRadioButton	String		bindable	Yes
selectedKey	IWDRadioButton	String		bindable_mandatory	Yes
readOnly	IWDRadioButton	boolean	false	bindable	No
state	IWDRadioButton	WDState	normal	bindable	No
text	IWDRadioButton	String (TranslatableText)		bindable	No
textDirection	IWDRadioButton	WDTextDirection	inherit	bindable	No
tooltip	IWDUIElement	String (TranslatableText)		bindable	No
visible	IWDUIElement	WDVisibility	visible	bindable	No

Events

●     onSelect

This property can be used to assign the action to be executed whenever the user selects the UI element RadioButton .

Event Parameter	Type
Key	String

See Parameter Mapping.