Interactive Objects > VpeRadioButtonGroup

Inserts a Radiobutton Group into the document. It is required that you insert a Radiobutton Group into the document before inserting Radiobuttons. A Radiobutton Group keeps the associated Radiobuttons together, controls the state switching if a button of the group is clicked and holds the value of the group.

VpeHandle VpeRadioButtonGroup(

VpeHandle hDoc,

int default_value

)

VpeHandle hDoc

Document Handle

int default_value

the default value of the group
E.g. if a Radiobutton Group has three associated Radiobuttons, say button A with the value 1, button B with the value 2 and button C with the value 3 and you set default_value = 2, then the button B will be checked automatically when it is created and associated with this Group.

Returns:

The VPE Object handle of the control.

The handle is required to associate Radiobuttons with the Radiobutton Group object.
In addition the handle can be used later in your code to identify the object (for example, to set the input focus on it or to retrieve its value) and to change some of its properties.

Remarks:

If you assign a value to a group, which is not defined by any Radiobutton, no Radiobutton is selected, i.e. the visual state of the group is undefined. This feature can be used to reflect NULL values, for example from databases.

Example:

see VpeRadioButton()