RepositoryItemTokenEdit.EditMode Property

Gets or sets whether an end-user can manually enter and validate any desired text within this TokenEdit.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

[DXCategory("Behavior")]
[DefaultValue(TokenEditMode.Default)]
[SmartTagProperty("Edit Mode", "Behavior", SortOrder = 50)]
public TokenEditMode EditMode { get; set; }

VB.NET

<DXCategory("Behavior")>
<DefaultValue(TokenEditMode.Default)>
<SmartTagProperty("Edit Mode", "Behavior", SortOrder:=50)>
Public Property EditMode As TokenEditMode

Property Value

Type	Default	Description
DevExpress.XtraEditors.TokenEditMode	**Default**	A DevExpress.XtraEditors.TokenEditMode enumerator value that specifies whether an end-user can manually enter and validate any desired text within this TokenEdit.

Remarks

Depending on the EditMode property value, the TokenEdit control can operate in either Manual or Token List mode.

• In Manual mode, end-users can manually enter any text that will later be validated in the RepositoryItemTokenEdit.ValidateToken event. If the entered text does not pass this validation, it remains plain text. Otherwise, it is converted into a token. In this mode, the token drop-down list (see the RepositoryItemTokenEdit.ShowDropDown property) is used only as a secondary tool that assists your end-users in entering tokens that were either added previously, or stored in the predefined RepositoryItemTokenEdit.Tokens collection.
• In Token List mode (same as Default value), end-users can only type in tokens stored within the RepositoryItemTokenEdit.Tokens collection. Any text that does not match these stored tokens is automatically deleted. The RepositoryItemTokenEdit.ValidateToken event is never raised, since end-users are allowed to select only pre-defined tokens and no validation is needed.

See the Token Edit Control topic for the details.

Related GitHub Examples

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

protected override BaseTokenEditPopupController CreatePopupController() {
    if(Properties.EditMode == TokenEditMode.TokenList || Properties.EditMode == TokenEditMode.Default) return new MyTokenEditTokenListPopupController(this);
    return new TokenEditManualModePopupController(this);

tokenedit-how-to-add-a-check-box-to-a-token-t315168/CS/TokenEdit_Glyph_InEndOfToken/Form1.cs#L31

edit.Separators.AddRange(new string[] { "," });
edit.EditMode = TokenEditMode.Manual;
edit.ValidateToken += tokenEdit1_ValidateToken;

VB.NET

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

Protected Overrides Function CreatePopupController() As BaseTokenEditPopupController
    If Properties.EditMode = TokenEditMode.TokenList OrElse Properties.EditMode = TokenEditMode.Default Then
        Return New MyTokenEditTokenListPopupController(Me)

tokenedit-how-to-add-a-check-box-to-a-token-t315168/VB/Form1.vb#L28

edit.Separators.AddRange(New String() { "," })
edit.EditMode = TokenEditMode.Manual
AddHandler edit.ValidateToken, AddressOf tokenEdit1_ValidateToken