Back to Devexpress

CheckBox.State Property

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-checkbox.md

latest4.5 KB
Original Source

CheckBox.State Property

Gets or sets the checkbox state.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
CheckBoxState State { get; set; }
vb
Property State As CheckBoxState

Property Value

TypeDescription
CheckBoxState

One of the CheckBoxState enumeration values indicating the checkbox state.

|

Available values:

NameDescription
Unchecked

The checkbox is unchecked.

| | Checked |

The checkbox is checked.

| | Undefined |

The checkbox is undefined.

|

Remarks

With the State property set CheckBoxState.Undefined, the checkbox state is defined by the CheckBox.DefaultState property.

The following code snippets (auto-collected from DevExpress Examples) contain references to the State property.

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.

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/FormFields.cs#L20

csharp
checkBox.Name = "check1";
checkBox.State = CheckBoxState.Checked;
checkBox.SizeMode = CheckBoxSizeMode.Auto;

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/FormFieldsActions.cs#L18

csharp
checkBox.Name = "check1";
checkBox.State = CheckBoxState.Checked;
checkBox.SizeMode = CheckBoxSizeMode.Auto;

word-document-api-examples/CS/CodeExamples/FormFieldsActions.cs#L26

csharp
checkBox.Name = "check1";
checkBox.State = CheckBoxState.Checked;
checkBox.SizeMode = CheckBoxSizeMode.Auto;

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/FormFields.vb#L18

vb
checkBox.Name = "check1"
checkBox.State = DevExpress.XtraRichEdit.API.Native.CheckBoxState.Checked
checkBox.SizeMode = DevExpress.XtraRichEdit.API.Native.CheckBoxSizeMode.Auto

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/FormFieldsActions.vb#L15

vb
checkBox.Name = "check1"
checkBox.State = CheckBoxState.Checked
checkBox.SizeMode = CheckBoxSizeMode.Auto

word-document-api-examples/VB/CodeExamples/FormFieldsActions.vb#L23

vb
checkBox.Name = "check1"
checkBox.State = DevExpress.XtraRichEdit.API.Native.CheckBoxState.Checked
checkBox.SizeMode = DevExpress.XtraRichEdit.API.Native.CheckBoxSizeMode.Auto

See Also

CheckBox Interface

CheckBox Members

DevExpress.XtraRichEdit.API.Native Namespace