| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
XL.FormControl.SetChecked
Sets the check state.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| XL | 13.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
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 |
| Value | The new setting. | 1 |
Result
Returns OK or error.
Description
Sets the check state.Sets 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.
Examples
Loop over form control to find one and check the checkbox:
Set Variable [ $sheet ; Value: 0 ]
Set Variable [ $count ; Value: MBS( "XL.Sheet.FormControlCount"; $bookRef; $sheet ) ]
Set Variable [ $index ; Value: 0 ]
If [ $index ≤ $count ]
Loop
# your script steps here
Set Variable [ $name ; Value: MBS( "XL.FormControl.Name"; $bookRef; $sheet; $index ) ]
If [ $name = "Test" ]
Set Variable [ $r ; Value: MBS( "XL.FormControl.SetChecked"; $bookRef; $sheet; $index; 1 ) ]
End If
#
# next
Set Variable [ $index ; Value: $index + 1 ]
Exit Loop If [ $index ≥ $count ]
End Loop
End If
See also
- XL.Book.SheetCount
- XL.FormControl.GetChecked
- XL.FormControl.Locked
- XL.FormControl.Name
- XL.FormControl.SetInc
- XL.FormControl.SetMultiSel
- XL.FormControl.SetSel
- XL.LoadBook
- XL.Sheet.FormControlCount
Blog Entries
Created 3th February 2023, last changed 29th November 2023
