CheckBoxInsert (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

See also

CheckBoxInsert (Function)

In french: InterrupteurInsère

Inserts a new option into a Check Box control.

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

// Inserts an option at position 2
CheckBoxAdd(CBOX_Options, 2, "Read a book on a tablet")

Syntax

<Result> = CheckBoxInsert(<Check Box control> , <Element subscript> , <Caption> [, <Sub-caption> [, <Image>]])

<Result>: Integer

Subscript of inserted option.
-1 if an error occurred. To get the details of the error, use ErrorInfo.

<Check Box control>: Control name

Name of Check Box control into which the option will be inserted.

<Element subscript>: Integer

Subscript of element to insert.
If this parameter:
is greater than the number of options found in the check box, the option is added after the last option found in the Check Box control.
is equal to 1 or 0, the element is added before the first option found in the Check Box control.

<Caption>: Character string (with quotes)

Caption of option to add.

<Sub-caption>: Optional character string (with quotes)

Sub-caption of the option to insert.
If this parameter is not specified, the added option has no sub-caption.
If this parameter is specified, the sub-caption will be displayed even if the check box is using a display mode without sub-caption.
This parameter is not available.

<Image>: Optional character string (with quotes)

Image associated with the option to insert.
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).
This parameter is not available.

Remarks

The characteristics of inserted option can also be modified by the following properties used on the option:
- ..Caption to modify the caption.
- ..SubCaption to modify the sub-caption.
- ..Image to modify the image.
When inserting options into a Check Box control, the size of the control is not modified. The added options may not be visible if the control is not large enough. The control can be enlarged by ..Width and ..Height.
To add an option after the existing options, use CheckBoxAdd.
When inserting an option:
- the subscript of inserted option is <Element subscript>.
- the subscripts of options found after the inserted option are automatically re-numbered.

Component : wd260obj.dll