CheckedListBoxItem.Enabled Property

Gets or set whether an end-user can change the item’s state.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

[DefaultValue(true)]
public virtual bool Enabled { get; set; }

VB.NET

<DefaultValue(True)>
Public Overridable Property Enabled As Boolean

Property Value

Type	Default	Description
Boolean	**true**	true if the item is enabled and an end-user can change its state; otherwise, false.

Remarks

Use the Enabled property to temporarily disable an item. The disabled item is displayed grayed and doesn’t respond to mouse events. An end-user cannot change its state, i.e. the BaseCheckedListBoxControl.ItemChecking event is not raised when clicking the item.

The image below shows the CheckedListBox control with enabled and disabled items.

Note: the item’s checked state can be changed via code regardless of the Enabled property’s value.

To disable specific items in bound mode, handle the BaseCheckedListBoxControl.GetItemEnabled event.

Related GitHub Examples

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

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

    if (Items[i].CheckState == System.Windows.Forms.CheckState.Checked)
        ea.CheckedState[i] = Items[i].Enabled;
RaiseConvertCheckStateToEditValue(ea);

how-to-customize-columns-order-and-visibility-in-a-custom-drop-down-menu-e2015/CS/Sample/QuickColumnCustomizationEdit.cs#L170

{
    newCollection.Add(item.Value.ToString(), item.CheckState == CheckState.Checked, oldCollection[listBox.Items.IndexOf(item)].VisibleIndex, item.Enabled);
}

VB.NET

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

If Items(i).CheckState = System.Windows.Forms.CheckState.Checked Then
    ea.CheckedState(i) = Items(i).Enabled
End If

how-to-customize-columns-order-and-visibility-in-a-custom-drop-down-menu-e2015/VB/Sample/QuickColumnCustomizationEdit.vb#L202

For Each item As CheckedListBoxItem In listBox.Items
    newCollection.Add(item.Value.ToString(), item.CheckState = CheckState.Checked, oldCollection(listBox.Items.IndexOf(item)).VisibleIndex, item.Enabled)
Next item