FormControlCollection.AddCheckBox(Cell, Single, Single) Method

Creates a checkbox form control so that the top left corner of the checkbox is located at the specified cell.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

CheckBoxFormControl AddCheckBox(
    Cell topLeftCell,
    float width,
    float height
)

VB.NET

Function AddCheckBox(
    topLeftCell As Cell,
    width As Single,
    height As Single
) As CheckBoxFormControl

Parameters

Name	Type	Description
topLeftCell	Cell	A cell where the top left corner of the form control is located.
width	Single	The form control width.
height	Single	The form control height.

Returns

Type	Description
CheckBoxFormControl	The check box form control.

Remarks

Example

The code sample below creates a checkbox form control:

C#

using DevExpress.Spreadsheet;

Workbook workbook = new Workbook();
workbook.LoadDocument("Document.xlsx");
var topCell = workbook.Worksheets[0].Cells["B2"];
var checkBoxControl = formControls.AddCheckBox(topCell, 200, 100);
checkBoxControl.CheckState = FormControlCheckState.Checked;
checkBoxControl.PlainText = "Reviewed";

VB.NET

Imports DevExpress.Spreadsheet

Dim workbook As New Workbook()
workbook.LoadDocument("Document.xlsx")
Dim topCell = workbook.Worksheets(0).Cells("B2")
Dim checkBoxControl = formControls.AddCheckBox(topCell, 200, 100)
checkBoxControl.CheckState = FormControlCheckState.Checked
checkBoxControl.PlainText = "Reviewed"

Note

The FormControlCollection.AddCheckBox method call adds a new item to both FormControlCollection and ShapeCollection.