XL.FormControl.SetChecked
-------------------------

Sets the check state.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [XL](component_XL.md) | [13.1](newinversion131.md) | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |

MBS( "XL.FormControl.SetChecked"; BookRef; SheetIndex; FormControlIndexOrName; Value ) 

**MBS**( **"XL.FormControl.SetChecked";** /\* Sets the check state. \*/  
**$BookRef**; /\* The reference number for the workbook.e.g. $ref \*/   
**$SheetIndex**; /\* The index of the sheet. This number ranges from 0 to [XL.Book.SheetCount](XLBookSheetCount.md)-1.e.g. 0 \*/   
**$FormControlIndexOrName**; /\* The index or name of the from control.  
Index ranges from 0 to [XL.Sheet.FormControlCount](XLSheetFormControlCount.md) - 1.e.g. $formControlIndex \*/   
**$Value**) /\* The new setting.e.g. 1 \*/ 

### Parameters

| Parameter | Description | Example |
|---|---|---|
| BookRef | The reference number for the workbook. | $ref |
| SheetIndex | The index of the sheet. This number ranges from 0 to [XL.Book.SheetCount](XLBookSheetCount.md)-1. | 0 |
| FormControlIndexOrName | The index or name of the from control.   Index ranges from 0 to [XL.Sheet.FormControlCount](XLSheetFormControlCount.md) - 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](XLSheetFormControlCount.md)"; $bookRef ; $sheet ) \]   
Set Variable \[ $index ; Value: 0 \]   
If \[ $index ≤ $count \]   
 Loop  
 # your script steps here  
 Set Variable \[ $name ; Value: MBS ( "[XL.FormControl.Name](XLFormControlName.md)"; $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](XLBookSheetCount.md)
- [XL.FormControl.GetChecked](XLFormControlGetChecked.md)
- [XL.FormControl.Locked](XLFormControlLocked.md)
- [XL.FormControl.Name](XLFormControlName.md)
- [XL.FormControl.SetInc](XLFormControlSetInc.md)
- [XL.FormControl.SetMultiSel](XLFormControlSetMultiSel.md)
- [XL.FormControl.SetSel](XLFormControlSetSel.md)
- [XL.Sheet.FormControlCount](XLSheetFormControlCount.md)

### Blog Entries

- [New in MBS FileMaker Plugin 13.1](https://www.mbsplugins.de/archive/2023-03-15/New_in_MBS_FileMaker_Plugin_13/monkeybreadsoftware_blog_filemaker)

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

  
[XL.FormControl.Print](XLFormControlPrint.md) - [XL.FormControl.SetDropLines](XLFormControlSetDropLines.md)

[HTML Version](XLFormControlSetChecked.shtml)