ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Controls, pages and windows / Check Box 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
Adds a new option into a Check Box control. The option is added after the existing options.
Example
// Add 2 options
CheckBoxAdd(CBOX_Options, "Read a book on a tablet")
CheckBoxAdd(CBOX_Options, "Read a paperback")
Syntax
<Result> = CheckBoxAdd(<Check Box 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.
<Check Box control>: Control name
Name of Check Box 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 subtext will be displayed even if the check box uses a display mode without subtext.
<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 check box is using a "Vista style" display mode (with image).
Remarks
  • The characteristics of the added option can also be modified via the following properties used on the option:
    • Caption property to change the text.
    • WINDEVUniversal Windows 10 App SubCaption property to change the subtext.
    • WINDEV Image property to modify the image.
  • When adding options into a Check Box 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 CheckBoxInsert.
Component: wd290obj.dll
Minimum version required
  • Version 18
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 05/26/2022

Send a report | Local help