ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Controls, pages and windows / Radio Button functions
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Inserts a new option into a Radio Button control.
Example
// Inserts an option at position 2
RadioButtonInsert(RADIO_Options, 2, "Read a book on a tablet")
Syntax
<Result> = RadioButtonInsert(<Radio Button control> , <Element index> , <Caption> [, <Sub-caption> [, <Image>]])
<Result>: Integer
  • Index of the inserted option.
  • -1 if an error occurred. To get more details on the error, use ErrorInfo.
<Radio Button control>: Control name
Name of Radio Button control into which the option will be inserted.
<Element index>: Integer
Index of the element to be inserted.
If this parameter:
  • is greater than the number of options found in the radio button, the option is added after the last option in the Radio Button control.
  • is equal to 1 or 0, the element is added before the first option found in the Radio Button control.
<Caption>: Character string
Text of the option to be added.
<Sub-caption>: Optional character string
Sub-caption of option to add.
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.
Android 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).
Android This parameter is not available.
Remarks
  • The characteristics of the added option can also be modified via the following properties used on the option:
  • When inserting 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 after the existing options, use RadioButtonAdd.
  • When inserting an option:
    • the index of the inserted option is <Element index>.
    • if the radio button uses option numbering, the options following the inserted option are automatically renumbered.
  • Using returned values: If the radio button is using the returned values, you have the ability to define the value returned by the inserted option via ReturnedValue.
    For example:
    nIndex is int
    nIndex = RadioButtonInsert(RADIO_Option, 2, "Read a book on a tablet")
    RADIO_Option[nIndex].ReturnedValue = "Tablet"
    // Select the new option
    RADIO_Option = "Tablet"
Component: wd290obj.dll
Minimum version required
  • Version 18
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 06/07/2022

Send a report | Local help