CheckedListBoxItem.CheckState Property

Gets or sets the item’s state.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
CheckState	**Unchecked**	A CheckState enumeration member specifying the item’s state.

Remarks

Use the CheckState property to specify the item’s state. Each item displayed by the CheckedListBoxControl can have three (checked, unchecked, indeterminate) states, as shown in the image below.

The BaseCheckedListBoxControl class provides a set of methods allowing you to either obtain or specify an item’s state. For example, use the BaseCheckedListBoxControl.GetItemCheckState method to identify the item’s current state. The BaseCheckedListBoxControl.SetItemCheckState method, in turn, enables you to set the specified item into one of the three states.

Note: to set an item to the indeterminate state at runtime, end-users must hold the CTRL key.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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#

creating-quick-column-customization-popup-window-e991/CS/E991/GridViewQuickColumnCustomization.cs#L145

    GridColumn column = (GridColumn)CheckListBox.Items[i].Value;
    column.Visible = CheckListBox.Items[i].CheckState == CheckState.Checked;
}

schedulercontrol-and-schedulerstorage-event-viewer-t444758/CS/SchedulerControlEventViewer/Form1.cs#L158

if (eventsCheckedListBox.Items[i].Description.Contains("Draw"))
    eventsCheckedListBox.Items[i].CheckState = CheckState.Unchecked;
if (eventsCheckedListBox.Items[i].Description.Contains("Query"))

how-to-create-a-checkedcomboboxedit-descendant-that-stores-edit-values-in-a-custom-format-e1987/CS/CustomCheckedComboBox/CustomCheckedComboBoxEdit.cs#L48

for (int i = 0; i < Items.Count; i++)
    if (Items[i].CheckState == System.Windows.Forms.CheckState.Checked)
        ea.CheckedState[i] = Items[i].Enabled;

Reporting_winforms-end-user-designer-how-to-programmatically-invoke-the-smart-tag-once-an-t317195/CS/WindowsFormsApplication1/Form1.cs#L35

XRDesignPanel panel = sender as XRDesignPanel;
if(checkedListBoxControl1.Items.Contains(e.Component.GetType().Name) && checkedListBoxControl1.Items[e.Component.GetType().Name].CheckState == CheckState.Checked)
    panel.BeginInvoke(new SmartTagInvoker(ShowSmartTag), new object[] { panel, e.Component });

richeditcontrol-event-viewer-t258534/CS/RichEditControlEventViewer/Form1.cs#L159

    if (eventsCheckedListBox.Items[i].Description.Contains("Draw"))
        eventsCheckedListBox.Items[i].CheckState = CheckState.Unchecked;
}

VB.NET

creating-quick-column-customization-popup-window-e991/VB/E991/GridViewQuickColumnCustomization.vb#L184

    Dim column As GridColumn = CType(CheckListBox.Items(i).Value, GridColumn)
    column.Visible = CheckListBox.Items(i).CheckState = CheckState.Checked
Next i

schedulercontrol-and-schedulerstorage-event-viewer-t444758/VB/SchedulerControlEventViewer/Form1.vb#L138

If eventsCheckedListBox.Items(i).Description.Contains("Draw") Then
    eventsCheckedListBox.Items(i).CheckState = CheckState.Unchecked
End If

how-to-create-a-checkedcomboboxedit-descendant-that-stores-edit-values-in-a-custom-format-e1987/VB/CustomCheckedComboBox/CustomCheckedComboBoxEdit.vb#L49

For i As Integer = 0 To Items.Count - 1
    If Items(i).CheckState = System.Windows.Forms.CheckState.Checked Then
        ea.CheckedState(i) = Items(i).Enabled

Reporting_winforms-end-user-designer-how-to-programmatically-invoke-the-smart-tag-once-an-t317195/VB/WindowsFormsApplication1/Form1.vb#L37

Dim panel As XRDesignPanel = TryCast(sender, XRDesignPanel)
If checkedListBoxControl1.Items.Contains(DirectCast(e.Component, Object).GetType().Name) AndAlso checkedListBoxControl1.Items(DirectCast(e.Component, Object).GetType().Name).CheckState = CheckState.Checked Then
    panel.BeginInvoke(New SmartTagInvoker(AddressOf ShowSmartTag), New Object() { panel, e.Component })

richeditcontrol-event-viewer-t258534/VB/RichEditControlEventViewer/Form1.vb#L136

If eventsCheckedListBox.Items(i).Description.Contains("Draw") Then
    eventsCheckedListBox.Items(i).CheckState = CheckState.Unchecked
End If