Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

XL.FormControl.GetChecked

Queries the check state.

Component Version macOS Windows Linux Server iOS SDK
XL 13.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "XL.FormControl.GetChecked"; bookRef; sheetIndex; FormControlIndexOrName )   More

Parameters

Parameter Description Example
bookRef The reference to the workbook. Please use XL.LoadBook to load a file. $ref
sheetIndex The index of the sheet. This number ranges from 0 to XL.Book.SheetCount-1. 0
FormControlIndexOrName The index or name of the from control.
Index ranges from 0 to XL.Sheet.FormControlCount - 1.
$formControlIndex

Result

Returns 0, 1 or error.

Description

Queries the check state.
Returns whether a check box is selected or a radio button is selected.
This attribute only applies to check box and radio button form controls.

Value is 0 for unchecked, 1 for checked and 2 for mixed.

See also

Blog Entries

Created 3th February 2023, last changed 3th February 2023


XL.FormControl.Disabled - XL.FormControl.GetDropLines

💬 Ask a question or report a problem