RepositoryItemTokenEdit.DeleteTokenOnGlyphClick Property

Gets or sets whether a TokenEdit‘s token should be deleted if an end-user clicks this token’s image.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
[DXCategory("Behavior")]
public DefaultBoolean DeleteTokenOnGlyphClick { get; set; }

VB.NET

<DXCategory("Behavior")>
<DefaultValue(DefaultBoolean.Default)>
Public Property DeleteTokenOnGlyphClick As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	A DefaultBoolean enumerator value that specifies whether a TokenEdit‘s token should be deleted if an end-user clicks this token’s image.

Available values:

Name	Description
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

Remarks

By default, all TokenEdit tokens display a small delete icon to the left of the text, as displayed at the figure below.

If the DeleteTokenOnGlyphClick property equals DefaultBoolean.True, clicking this icon at runtime will remove the corresponding token (see the following animation). The DefaultBoolean.Default property value is DefaultBoolean.False.

You can also draw your own custom token icons on the RepositoryItemTokenEdit.CustomDrawTokenGlyph event. See the Token Edit Control topic for details.