CheckBoxFormControl Interface
A check box form control.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Spreadsheet.v24.1.Core.dll
NuGet Package: DevExpress.Spreadsheet.Core
Declaration
public interface CheckBoxFormControl :
FormControl,
Shape,
FloatingObject,
ShapeFormatBase,
TextFormControl,
LinkedCellFormControl,
ShadedFormControlRelated API Members
The following members return CheckBoxFormControl objects:
Remarks
Create a Check Box Form Control
The code sample below creates a checkbox control:
using DevExpress.Spreadsheet;
Workbook workbook = new Workbook();
workbook.LoadDocument("Document.xlsx");
var cellRange = workbook.Worksheets[0].Range["B2:C4"];
var checkBoxControl = formControls.AddCheckBox(cellRange);
checkBoxControl.CheckState = FormControlCheckState.Checked;
checkBoxControl.PlainText = "Reviewed";
Note
The FormControlCollection.AddCheckBox method call adds a new item to both FormControlCollection and ShapeCollection.
Obtain Check Box Form Controls
The Worksheet.FormControls property obtains all form controls in a worksheet. You can use one of the following ways to obtain a specific form control:
- Access the item in the collection by its index
- Call the FormControlCollection.GetFormControlsByName method
- Call the FormControlCollection.GetFormControlById method
The FormControl.Id and FormControl.Name properties return the form control’s identifier and name.
Modify Check Box Form Controls
Use the CheckBoxFormControl class properties to change checkbox parameters. The code sample below obtains all checkboxes, unchecks them, and enables 3D shading:
using DevExpress.Spreadsheet;
using System.Linq;
Workbook workbook = new Workbook();
workbook.LoadDocument("Document.xlsx");
var formControls = workbook.Worksheets[0].FormControls;
var checkBoxes = formControls.Where(formControl => formControl.FormControlType == FormControlType.CheckBox).Cast<CheckBoxFormControl>();
foreach (CheckBoxFormControl checkBox in checkBoxes) {
checkBox.Shading3D = true;
checkBox.CheckState = FormControlCheckState.Unchecked;
}
Remove Check Box Controls
Call the FormControlCollection.Remove or FormControlCollection.RemoveAt method to remove a form control. The FormControlCollection.Clear() method removes all form controls from a worksheet.
The code sample below removes all check boxes from a worksheet:
Workbook workbook = new Workbook();
workbook.LoadDocument("Document.xlsx");
var formControls = workbook.Worksheets[0].FormControls;
for (int i = formControls.Count - 1; i >= 0; i--) {
if (formControls[i].FormControlType == FormControlType.CheckBox)
formControls.RemoveAt(i);
}