Back to Devexpress

TokenEditToken Class

windowsforms-devexpress-dot-xtraeditors-9d73811e.md

latest3.4 KB
Original Source

TokenEditToken Class

The token.

Namespace : DevExpress.XtraEditors

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
public class TokenEditToken :
    ICloneable
vb
Public Class TokenEditToken
    Implements ICloneable

The following members return TokenEditToken objects:

Remarks

Read the following topic for additional information and examples: Token Edit Control.

Examples

Unbound Mode

In unbound mode, the TokenEdit stores tokens in the Properties.Tokens collection. The following example demonstrates how to add unbound tokens in code:

csharp
tokenEdit1.Properties.BeginUpdate();
// Token values must be unique.
tokenEdit1.Properties.Tokens.AddToken("Description string A", "value1");
tokenEdit1.Properties.Tokens.AddToken("Description string B", "value2");
// ... add more tokens
tokenEdit1.Properties.EndUpdate();
vb
tokenEdit1.Properties.BeginUpdate()
' Token values must be unique.
tokenEdit1.Properties.Tokens.AddToken("Description string A", "value1")
tokenEdit1.Properties.Tokens.AddToken("Description string B", "value2")
' ... add more tokens
tokenEdit1.Properties.EndUpdate()

Bound Mode

  1. Use the Properties.DataSource property to bind the TokenEdit control to a data source.
  2. Use the Properties.DisplayMember to specify the data field that stores token descriptions.
  3. Use the Properties.ValueMember to specify the field that stores token values. Token values must be unique.
csharp
tokenEdit1.Properties.BeginUpdate();
tokenEdit1.Properties.DataSource = queryBindingSource;
tokenEdit1.Properties.DisplayMember = "EmailAddress";
tokenEdit1.Properties.ValueMember = "EmailAddressID";
tokenEdit1.Properties.EndUpdate();
vb
tokenEdit1.Properties.BeginUpdate()
tokenEdit1.Properties.DataSource = queryBindingSource
tokenEdit1.Properties.DisplayMember = "EmailAddress"
tokenEdit1.Properties.ValueMember = "EmailAddressID"
tokenEdit1.Properties.EndUpdate()

Inheritance

Object TokenEditToken

See Also

TokenEditToken Members

DevExpress.XtraEditors Namespace