RepositoryItemTokenEdit.Tokens Property

Provides access to this TokenEdit control’s token collection.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v20.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Behavior")]
public TokenEditTokenCollection Tokens { get; }

VB.NET

<DXCategory("Behavior")>
Public ReadOnly Property Tokens As TokenEditTokenCollection

Property Value

Type	Description
DevExpress.XtraEditors.TokenEditTokenCollection	A DevExpress.XtraEditors.TokenEditTokenCollection object that stores this TokenEdit control’s tokens.

Remarks

Tokens stored within the Tokens collection are divided into two groups.

• Predefined tokens, added to the Tokens collection in code or at design-time via the editor’s smart tag (see the figure below).

  

• Tokens added to the Tokens collection after the application was launched. This requires the RepositoryItemTokenEdit.TokenPopulateMode property set to the Default value. Refer to this link for details.

Items stored within the Tokens collection are displayed within the editor’s drop-down list if it is enabled (see the RepositoryItemTokenEdit.ShowDropDown property). See the Token Edit Control topic to learn more.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Tokens 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-provide-custom-filter-functionality-for-tokenedit-t328505/CS/T328505/MyTokenEdit.cs#L137

private IList GetCustomFilterSourceCore() {
    TokenEditTokenCollection tokCol = Properties.Tokens;
    TokenEditSelectedItemCollection selCol = Properties.SelectedItems;

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

protected override IList GetDataSource() {
    TokenEditTokenCollection tokCol = Properties.Tokens;
    TokenEditSelectedItemCollection selCol = Properties.SelectedItems;

VB.NET

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

Private Function GetCustomFilterSourceCore() As IList
    Dim tokCol As TokenEditTokenCollection = Properties.Tokens
    Dim selCol As TokenEditSelectedItemCollection = Properties.SelectedItems

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

Protected Overrides Function GetDataSource() As IList
    Dim tokCol As TokenEditTokenCollection = Properties.Tokens
    Dim selCol As TokenEditSelectedItemCollection = Properties.SelectedItems