RepositoryItemTokenEdit.SelectedItems Property

Gets the collection that contains all tokens currently visible in the TokenEdit.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

[Browsable(false)]
public TokenEditSelectedItemCollection SelectedItems { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property SelectedItems As TokenEditSelectedItemCollection

Property Value

Type	Description
DevExpress.XtraEditors.TokenEditSelectedItemCollection	A DevExpress.XtraEditors.TokenEditSelectedItemCollection object that contains all tokens currently visible in the editor.

Remarks

The SelectedItems object provides zero-based indexed access to all tokens currently displayed within the editor, whether they were chosen from the drop-down list (see the RepositoryItemTokenEdit.ShowDropDown property) or manually entered and transformed into tokens in the RepositoryItemTokenEdit.ValidateToken event. In other words, the SelectedItems property returns the collection of all tokens whose values (TokenEditToken.Value) form the editor’s current EditValue property value.

Same tokens can be also retrieved in an IList structure via the TokenEdit.GetTokenList method.

Important

Do not confuse the SelectedItems property with the RepositoryItemTokenEdit.CheckedItems property, which returns all tokens painted as checked. To check a token, an end-user must click its caption. See this link for details.

The SelectedItems collection is designed only to return checked tokens. Do not manually modify this collection via Add, AddRange, Remove or other methods.

Related GitHub Examples

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

tokenedit-how-to-use-one-token-multiple-times-within-the-editor-t215066/CS/MyTokenEdit.cs#L56

TokenEditTokenCollection tokCol = Properties.Tokens;
TokenEditSelectedItemCollection selCol = Properties.SelectedItems;
List<TokenEditToken> list = new List<TokenEditToken>(Properties.Tokens.Count);

how-to-provide-custom-filter-functionality-for-tokenedit-t328505/CS/T328505/MyTokenEdit.cs#L138

TokenEditTokenCollection tokCol = Properties.Tokens;
TokenEditSelectedItemCollection selCol = Properties.SelectedItems;
if(selCol.Count == 0) return tokCol;

VB.NET

tokenedit-how-to-use-one-token-multiple-times-within-the-editor-t215066/VB/MyTokenEdit.vb#L68

Dim tokCol As TokenEditTokenCollection = Properties.Tokens
Dim selCol As TokenEditSelectedItemCollection = Properties.SelectedItems
Dim list As New List(Of TokenEditToken)(Properties.Tokens.Count)

how-to-provide-custom-filter-functionality-for-tokenedit-t328505/VB/T328505/MyTokenEdit.vb#L153

Dim tokCol As TokenEditTokenCollection = Properties.Tokens
Dim selCol As TokenEditSelectedItemCollection = Properties.SelectedItems
If selCol.Count = 0 Then