FormControlCollection.AddCheckBox(Single, Single, Single, Single) Method

Creates a check box form control in the specified worksheet area.

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

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

C#
VB.NET

csharp

CheckBoxFormControl AddCheckBox(
    float x,
    float y,
    float width,
    float height
)

Function AddCheckBox(
    x As Single,
    y As Single,
    width As Single,
    height As Single
) As CheckBoxFormControl

Parameters

Name	Type	Description
x	Single

The distance from the left of the worksheet. The ISpreadsheetComponent.Unit property specifies the unit of measurement.

| | y | Single |

The distance from the top of the worksheet. The ISpreadsheetComponent.Unit property specifies the unit of measurement.

| | width | Single |

The check box width.

| | height | Single |

The check box height.

Returns

Type	Description
CheckBoxFormControl

The check box form control.

Remarks

Example

The code sample below creates a checkbox form control:

C#
VB.NET

csharp

using DevExpress.Spreadsheet;

Workbook workbook = new Workbook();
workbook.LoadDocument("Document.xlsx");

var checkBoxControl = formControls.AddCheckBox(20, 20, 200, 100);
checkBoxControl.CheckState = FormControlCheckState.Checked;
checkBoxControl.PlainText = "Reviewed";

Imports DevExpress.Spreadsheet

Dim workbook As New Workbook()
workbook.LoadDocument("Document.xlsx")

Dim checkBoxControl = formControls.AddCheckBox(20, 20, 200, 100)
checkBoxControl.CheckState = FormControlCheckState.Checked
checkBoxControl.PlainText = "Reviewed"

Note

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