A radio button group item. Radio button groups are used when precisely one option out of a set of options can be selected.

## Example

form = pf.Form.New("Export settings")

-- Prepare input parameter and radio button group

options = {}
table.insert(options, "Only electric near fields")
table.insert(options, "Only magnetic near fields")
table.insert(options, "Both electric and magnetic near fields")

-- Run the form and retrieve the user input

form:Run()


## Inheritance

The FormRadioButtonGroup object is derived from the FormItem object.

## Property List

Count
Enabled
Controls the item enabled state. Setting the enabled state of an item to false will also disable items or their contents. (Read/Write boolean)
FixedHeight
The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the height of the item. Setting the fixed height to zero or a negative value will restore the default/auto setting and the height will be dynamically determined. The fixed height takes precedence over the minimum height and thus the minimum height is ignored when a fixed height is set. (Read/Write number)
FixedWidth
The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the width of the item. Setting the fixed width to zero or a negative value will restore the default/auto setting and the width will be dynamically determined. The fixed width takes precedence over the minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write number)
ItemHeight
The height of the item in pixels. (Read only number)
ItemWidth
The width of the item in pixels. (Read only number)
MinimumHeight
The minimum height of the item in pixels. When the height is dynamically determined, it will not be less than the minimum height setting. The minimum height value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or a negative value will restore the default/auto setting where no minimum height is enforced. (Read/Write number)
MinimumWidth
The minimum width of the item in pixels. When the width is dynamically determined, it will not be less than the minimum width setting. The minimum width value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or a negative value will restore the default/auto setting where no minimum width is enforced. (Read/Write number)
Options
Type
The object type string. (Read only string)
Value
The index of the selected radio button item in the index map table. (Read/Write number)
Visible
Controls the item visibility. Setting the visibility of an item to false will also hide items or their contents. (Read/Write boolean)

## Method List

ClearCallBack ()
Clear the function that will be called when the check box state changes.
SetCallBack (callback function)
Set the function that will be called when a radiobutton is pressed.

## Constructor Function List

New (label string, map Map of number:Expression)
New (map Map of number:Expression)

## Property Details

Count
Type
number
Access
Enabled
Controls the item enabled state. Setting the enabled state of an item to false will also disable items or their contents.
Type
boolean
Access
FixedHeight
The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the height of the item. Setting the fixed height to zero or a negative value will restore the default/auto setting and the height will be dynamically determined. The fixed height takes precedence over the minimum height and thus the minimum height is ignored when a fixed height is set.
Type
number
Access
FixedWidth
The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the width of the item. Setting the fixed width to zero or a negative value will restore the default/auto setting and the width will be dynamically determined. The fixed width takes precedence over the minimum width and thus the minimum width is ignored when a fixed width is set.
Type
number
Access
ItemHeight
The height of the item in pixels.
Type
number
Access
ItemWidth
The width of the item in pixels.
Type
number
Access
MinimumHeight
The minimum height of the item in pixels. When the height is dynamically determined, it will not be less than the minimum height setting. The minimum height value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or a negative value will restore the default/auto setting where no minimum height is enforced.
Type
number
Access
MinimumWidth
The minimum width of the item in pixels. When the width is dynamically determined, it will not be less than the minimum width setting. The minimum width value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or a negative value will restore the default/auto setting where no minimum width is enforced.
Type
number
Access
Options
The options available in the radio group.
Access
Type
The object type string.
Type
string
Access
Value
The index of the selected radio button item in the index map table.
Type
number
Access
Visible
Controls the item visibility. Setting the visibility of an item to false will also hide items or their contents.
Type
boolean
Access

## Method Details

ClearCallBack ()
Clear the function that will be called when the check box state changes.
SetCallBack (callback function)
Set the function that will be called when a radiobutton is pressed.
Input Parameters
callback(function)
The function call back.

## Static Function Details

New (label string, map Map of number:Expression)
Create a new radio button group item.
Input Parameters
label(string)
The item label.
map(Map of number:Expression)
A list of values that will be available for selection in the button group. The index map is a Lua table containing an array of indexed values.
Return