officefileapi-devexpress-dot-spreadsheet-dot-formcontrolcollection-dot-addcheckbox-x28-devexpress-dot-spreadsheet-dot-cellrange-x29.md
Creates a check box form control at the specified cell range.
Namespace : DevExpress.Spreadsheet
Assembly : DevExpress.Spreadsheet.v25.2.Core.dll
NuGet Package : DevExpress.Spreadsheet.Core
CheckBoxFormControl AddCheckBox(
CellRange targetRange
)
Function AddCheckBox(
targetRange As CellRange
) As CheckBoxFormControl
| Name | Type | Description |
|---|---|---|
| targetRange | CellRange |
The cell range where the form control should be located.
|
| Type | Description |
|---|---|
| CheckBoxFormControl |
The 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";
Imports DevExpress.Spreadsheet
Dim workbook As New Workbook()
workbook.LoadDocument("Document.xlsx")
Dim cellRange = workbook.Worksheets(0).Range("B2:C4")
Dim 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.
The following code snippets (auto-collected from DevExpress Examples) contain references to the AddCheckBox(CellRange) method.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.
var checkRange = workbook.Worksheets[0].Range["D5:E5"];
var checkBoxControl = formControls.AddCheckBox(checkRange);
checkBoxControl.CheckState = FormControlCheckState.Checked;
var checkRange = workbook.Worksheets[0].Range["D5:E5"];
var checkBoxControl = formControls.AddCheckBox(checkRange);
checkBoxControl.CheckState = FormControlCheckState.Checked;
var checkRange = workbook.Worksheets[0].Range["D5:E5"];
var checkBoxControl = formControls.AddCheckBox(checkRange);
checkBoxControl.CheckState = FormControlCheckState.Checked;
Dim checkRange = workbook.Worksheets(CInt((0))).Range("D5:E5")
Dim checkBoxControl = formControls.AddCheckBox(checkRange)
checkBoxControl.CheckState = DevExpress.Spreadsheet.FormControlCheckState.Checked
Dim checkRange = workbook.Worksheets(0).Range("D5:E5")
Dim checkBoxControl = formControls.AddCheckBox(checkRange)
checkBoxControl.CheckState = FormControlCheckState.Checked
See Also