RadioButtonAdd (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Radio Button functions

See also

RadioButtonAdd (Function)

In french: SélecteurAjoute

Adds a new option into a Radio Button control. The option is added after the existing options.

Versions 21 and later

This function is now available for Android applications.

New in version 21

This function is now available for Android applications.

Versions 22 and later

This function is now available in Universal Windows 10 App mode.

New in version 22

This function is now available in Universal Windows 10 App mode.

Example

// Add 2 options
RadioButtonAdd(RADIO_Options, "Read a book on a tablet")
RadioButtonAdd(RADIO_Options, "Read a paperback")

Syntax

<Result> = RadioButtonAdd(<Radio Button control> , <Caption> [, <Sub-caption> [, <Image>]])

<Result>: Integer

Index of the new option.
-1 if an error occurred. To get more details on the error, use ErrorInfo.

<Radio Button control>: Control name

Name of the Radio Button control into which the option will be added. The option is added after the existing options.

<Caption>: Character string

Text of the option to be added.

<Sub-caption>: Optional character string

Subtext of the option to be added.
If this parameter is not specified, the new option has no subtext.
If this parameter is specified, the sub-caption will be displayed even if the radio button is using a display mode without sub-caption.
This parameter is not available.

<Image>: Optional character string

Image associated with the option to add.
If this parameter is not specified, the added option has no image.
If this parameter is specified, the image will be displayed only if the radio button uses a "Vista style" display mode (with image).
This parameter is not available.

Remarks

The characteristics of the added option can also be modified via the following properties used on the option:
- Caption to modify the caption.
- SubCaption to modify the sub-caption.
- Image to modify the image.
When adding options into a Radio Button control, the control size is not modified. The added options may not be visible if the control is not large enough. The control can be enlarged by the Width and Height properties.
To add an option at a specific position, use RadioButtonInsert.
Using returned values: If the radio button is using the returned values, you have the ability to define the value returned by the added option via ReturnedValue.
For example:

nIndex is int
nIndex = RadioButtonAdd(RADIO_Option, "Read a book on a tablet")
RADIO_Option[nIndex].ReturnedValue = "Tablet"
// Select the new option
RADIO_Option = "Tablet"

Component: wd270obj.dll