Radio Buttons By Index

Function: a!radioButtonFieldByIndex()

Displays a limited set of choices from which the user must select one item and saves the index of the selected choice. To save a value instead of the index, use radio buttons.

Parameters

Name	Keyword	Type	Description
Label	label	Text	Optional text to display as the field label.
Label Position	labelPosition	Text	Optional text to determine where the label appears. Valid values include "ABOVE" (default) Displays the label above the component. "ADJACENT" Displays the label to the left of the component. "COLLAPSED" Hides the label. The label will still be read by screen readers; see accessibility considerations for more information. "JUSTIFIED" Aligns the label alongside the component starting at the edge of the page.
Instructions	instructions	Text	Optional text displayed below the series of radio buttons.
Help Tooltip	helpTooltip	Text	Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".
Choice Labels	choiceLabels	Text Array	List of options for the user to choose from.
Selected Index	value	Integer	The index of the selected choice.
Save Selection To	saveInto	Save Array	One or more variables that are updated with the choice index when the user changes the selection. Use a!save() to save a modified or alternative value to a variable.
Required	required	Boolean	Determines if a value is required to submit the form. Default is false.
Required Message	requiredMessage	Text	Custom message to be displayed when the field's value is required and not provided.
Disabled	disabled	Boolean	Determines if the user is prevented from changing the value. Default is false.
Choice Layout	choiceLayout	Text	Optional text to determine the layout of the list of options. Valid values include "STACKED" (default) to display the choices one on top of another and "COMPACT" to display the choices side-by-side.
Validations	validations	Text Array	Validation errors to be displayed below the field when the value is not null.
Validation Group	validationGroup	Text	When present, this field is only validated when a button in the same validation group is clicked.
Visibility	showWhen	Boolean	Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Notes

• Choices display in the same order as defined in the Choice Labels parameter. The Choice Labels argument cannot be null.
• If null is passed to Selected Index, none of the options are selected.
• Choice index numbers start at 1. The index number for Selected Index cannot be less than 1, or greater than the length of the Choice Labels array.
• The choice at the index passed to the Selected Index parameter displays as selected by default.