CheckEdit.CheckState Property

Gets or sets the editor’s check state.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v25.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(CheckState.Unchecked)]
[DXCategory("Appearance")]
public virtual CheckState CheckState { get; set; }

VB.NET

<DXCategory("Appearance")>
<DefaultValue(CheckState.Unchecked)>
Public Overridable Property CheckState As CheckState

Property Value

Type	Default	Description
CheckState	Unchecked	The check state.

Remarks

CheckEdit supports the following modes:

Two-State Mode

The editor can be in the Checked or Unchecked state.

Three-State Mode

The editor can be in the following states: Checked, Unchecked, or Indeterminate (grayed). Set the AllowGrayed property to true to enable three-state mode.

CheckState	Checked	EditValue
Checked	true	true or ValueChecked (if specified)
Unchecked	false	false or ValueUnchecked (if specified)
Indeterminate	true	null (Nothing in VB.NET) or ValueGrayed (if specified)

CheckEdit changes its states in the following order: Indeterminate → Unchecked → Checked.

Set the DefaultStateAfterIndeterminate property to Checked to activate the following order: Indeterminate → Checked → Unchecked.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CheckState 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.

C#

winforms-mvvm-best-practices/CS/DataBindingCapabilitiesConverters/DataBindingWithCustomConvertersFluentAPIUserControl.cs#L34

var fluent = mvvmContext.OfType<ViewModel>();
fluent.SetBinding(check, e => e.CheckState, x => x.ModelState,
    modelState =>