TokenEdit Class
The text editor that applies custom validation to the entered text and transforms text blocks which passed this validation to tokens.
Namespace: DevExpress.XtraEditors
Assembly: DevExpress.XtraEditors.v24.1.dll
NuGet Package: DevExpress.Win.Navigation
Declaration
public class TokenEdit :
BaseEdit,
IPopupControl,
IPopupControlHookPopupFactory,
IMouseWheelSupport,
IDXMenuSupport,
ITextEditControllerOwner,
IDirectXClientProviderEx,
IDirectXClientProvider,
ISupportsAutoSizeRelated API Members
The following members return TokenEdit objects:
Remarks
The TokenEdit is an advanced text editor that can apply custom validation logic to the entered text and transform those text blocks that have successfully passed this validation into tokens - visual elements that can display glyphs and fire various events in response to user actions (for example, TokenClick, TokenMouseEnter).
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:
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
- Use the Properties.DataSource property to bind the
TokenEditcontrol to a data source. - Use the Properties.DisplayMember to specify the data field that stores token descriptions.
- Use the Properties.ValueMember to specify the field that stores token values. Token values must be unique.
tokenEdit1.Properties.BeginUpdate();
tokenEdit1.Properties.DataSource = queryBindingSource;
tokenEdit1.Properties.DisplayMember = "EmailAddress";
tokenEdit1.Properties.ValueMember = "EmailAddressID";
tokenEdit1.Properties.EndUpdate();