TokenEditToken.Description Property

Gets or sets the description.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v25.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue("")]
[DXCategory("Data")]
public string Description { get; set; }

VB.NET

<DXCategory("Data")>
<DefaultValue("")>
Public Property Description As String

Property Value

Type	Default	Description
String	String.Empty	The token description.

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:

C#

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.NET

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.

C#

tokenEdit1.Properties.BeginUpdate();
tokenEdit1.Properties.DataSource = queryBindingSource;
tokenEdit1.Properties.DisplayMember = "EmailAddress";
tokenEdit1.Properties.ValueMember = "EmailAddressID";
tokenEdit1.Properties.EndUpdate();

VB.NET

tokenEdit1.Properties.BeginUpdate()
tokenEdit1.Properties.DataSource = queryBindingSource
tokenEdit1.Properties.DisplayMember = "EmailAddress"
tokenEdit1.Properties.ValueMember = "EmailAddressID"
tokenEdit1.Properties.EndUpdate()

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Description 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/Form1.cs#L51

{
    XtraMessageBox.Show(string.Format("{0} {1} Checked: {2}", e.Token.Description, e.Token.Value, e.Token.Checked));
}

VB.NET

winforms-tokenedit-checked-tokens/VB/Form1.vb#L47

Private Sub TokenCheckedChanged(ByVal sender As Object, ByVal e As TokenCheckedChangedEventArgs)
    XtraMessageBox.Show(String.Format("{0} {1} Checked: {2}", e.Token.Description, e.Token.Value, e.Token.Checked))
End Sub