CheckedListBoxItemCollection.Add(Object, String, CheckState, Boolean) Method

Adds a new item with the specified settings to the collection.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

public int Add(
    object value,
    string description,
    CheckState checkState,
    bool enabled
)

VB.NET

Public Function Add(
    value As Object,
    description As String,
    checkState As CheckState,
    enabled As Boolean
) As Integer

Parameters

Name	Type	Description
value	Object	An object that represents the item’s value. This value is used to initialize the ListBoxItem.Value property.
description	String	A string representing the item’s display text. This value is used to initialize the CheckedListBoxItem.Description property.
checkState	CheckState	A CheckState enumeration member which specifies the item’s state. This value is used to initialize the CheckedListBoxItem.CheckState property.
enabled	Boolean	A Boolean value that specifies whether the created item must be enabled. This value is used to initialize the CheckedListBoxItem.Enabled property.

Returns

Type	Description
Int32	A zero-based integer value that specifies the new item’s index.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Add(Object, String, CheckState, Boolean) method.

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-grid-hide-vertical-lines-between-certain-columns/CS/E3647/Form1.cs#L72

foreach (GridColumn column in gridView1.Columns)
    checkedListBoxControl1.Items.Add(column, column.ToString(), CheckState.Unchecked, true);
checkedListBoxControl1.Items[0].CheckState = CheckState.Checked;

winforms-combobox-hide-specific-items/CS/MyComboBoxEdit/Form1.cs#L17

for (int i = 0; i < comboBoxEdit1.Properties.Items.Count; i++) {
    this.indexesCheckedComboBox.Properties.Items.Add(i, comboBoxEdit1.Properties.Items[i].ToString(), i < 2 ? CheckState.Checked : CheckState.Unchecked, true);
}

VB.NET

winforms-grid-hide-vertical-lines-between-certain-columns/VB/E3647/Form1.vb#L69

For Each column As GridColumn In gridView1.Columns
    checkedListBoxControl1.Items.Add(column, column.ToString(), CheckState.Unchecked, True)
Next column

winforms-combobox-hide-specific-items/VB/MyComboBoxEdit/Form1.vb#L22

For i As Integer = 0 To comboBoxEdit1.Properties.Items.Count - 1
    indexesCheckedComboBox.Properties.Items.Add(i, comboBoxEdit1.Properties.Items(i).ToString(), If(i < 2, CheckState.Checked, CheckState.Unchecked), True)
Next