TokenEdit.CheckedItems Property

Returns the object that contains all currently checked tokens within this TokenEdit.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[Browsable(false)]
public TokenEditCheckedItemCollection CheckedItems { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property CheckedItems As TokenEditCheckedItemCollection

Property Value

Type	Description
DevExpress.XtraEditors.TokenEditCheckedItemCollection	A DevExpress.XtraEditors.TokenEditCheckedItemCollection object that contains all currently checked tokens within this TokenEdit.

Remarks

To check (select) a token within the TokenEdit, and end-user should click its header (or glyph, if the RepositoryItemTokenEdit.DeleteTokenOnGlyphClick property equals DefaultBoolean.False). Depending on the RepositoryItemTokenEdit.CheckMode property value, the editor can have either one or multiple tokens selected at one time. The CheckedItems collection returns all currently selected (checked) tokens for this editor.

Important

Do not confuse the CheckedItems and TokenEdit.SelectedItems collections. The SelectedItems collection returns all tokens currently visible within the editor, while the CheckedItems collection contains only those tokens currently checked.

The CheckedItems collection is designed only to return checked tokens. Do not manually modify this collection via Add, AddRange, Remove or other methods. Use the TokenEdit.CheckItem and TokenEdit.UncheckItem methods instead.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CheckedItems 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-tokenedit-checked-tokens/CS/TokenEdit_Glyph_InEndOfToken/CustomTokenEdit/CustomTokenEdit.cs#L42

public CustomTokenEditToken CheckedItem { get { return base.CheckedItem as CustomTokenEditToken;} }
public CustomTokenEditCheckedItemCollection CheckedItems { get { return base.CheckedItems as CustomTokenEditCheckedItemCollection; } }
public CustomTokenEditSelectedItemCollection SelectedItems { get { return base.SelectedItems as CustomTokenEditSelectedItemCollection; } }

VB.NET

winforms-tokenedit-checked-tokens/VB/CustomTokenEdit/CustomTokenEdit.vb#L46

Get
    Return TryCast(MyBase.CheckedItems, CustomTokenEditCheckedItemCollection)
End Get