The RadioButtonGroupByKey UI element groups multiple radio buttons in a table. Unlike UI element CheckBoxGroup, this UI element allows the selection of one element only.
Indicates whether access key for this control is activated. More information: Enabling Access Keys
When accessibility is activated, the assigned text is added to the quick info. This description provides semantic details of the UI element and is only read by the screen reader if the user focuses the complete Ul element.
Specifies the number of columns in which the radio button UI elements are displayed.
Specifies the explanation text. More information: Explanation .
Specifies whether or not the user can select a radio button within the radio button group.
Specifies the path to the context attribute that stores the currently selected key.
Describes the error status of the UI element.Property state can take the following values and is represented by enumeration type WDState.
normal |
Describes the default state of the UI element. |
required |
Specifies whether the entered value is required. The RadioButtonGroupByKey is displayed with an asterisk. |
Specifies the text direction and allows you to use a check box 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. 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.
Specifies the width of the UI element that you can specify in CSS sizes, such as em, ex, pixels or percentage values.
Name | Interface | Type | Initial Value | Bindable |
---|---|---|---|---|
activateAccessKey |
IWDRadioButtonGroupByKey |
boolean |
false |
not bindable |
accessibilityDescription |
IWDRadioButtonGroupByKey |
String (Translatable Text) |
|
bindable |
colCount |
IWDRadioButtonGroupByKey |
int |
1 |
bindable |
enabled |
IWDUIElement |
boolean |
true |
bindable |
explanation |
IWDRadioButtonGroupByKey |
String |
|
not bindable |
selectedKey |
IWDRadioButtonGroupByKey |
String |
|
bindable_mandatory |
readOnly |
IWDRadioButtonGroupByKey |
boolean |
false |
bindable |
state |
IWDRadioButtonGroupByKey |
WDState |
normal |
bindable |
textDirection |
IWDRadioButtonGroupByKey |
WDTextDirection |
inherit |
bindable |
tooltip |
IWDUIElement |
String |
|
bindable |
visible |
IWDUIElement |
WDVisibility |
visible |
bindable |
width |
IWDRadioButtonGroupByKey |
String (CSS size) |
|
bindable |
This event is triggered when the RadioButtonGroupByKey is selected.
Event Parameter | Type |
---|---|
key |
String |
The context node must contain a context attribute y. The attribute is assigned to a data type that can contain a value set (key value pair). The selected keys of the RadioButtonGroupByKey are the values of this value set. The texts to be displayed are the corresponding descriptions. The currently selected key is identical to the current value of the attribute y. Property selectedKey is bound to context attribute y.
explanation;IWDRadioButtonGroupByKey;String;;not bindable ;no