Skip to main content

RepositoryItemTokenEdit.CheckMode Property

Gets or sets whether only one or multiple tokens can be selected (checked) simultaneously within this TokenEdit control.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

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

Property Value

Type Default Description
DevExpress.XtraEditors.TokenEditCheckMode Default

A DevExpress.XtraEditors.TokenEditCheckMode enumerator value that specifies whether only one or multiple tokens can be selected simultaneously within this TokenEdit control.

Remarks

To select (check) tokens, users can click their captions (and glyphs, if the RepositoryItemTokenEdit.DeleteTokenOnGlyphClick property equals DefaultBoolean.False).

CheckedToken

If the CheckMode property equals TokenEditCheckMode.Single or TokenEditCheckMode.Default, selecting a new token will automatically unselect the previous one. Otherwise, if the CheckMode property is set to TokenEditCheckMode.Multiple, users can select multiple tokens simultaneously. In multiple selection mode, the Ctrl (add to selection) and Shift (select all tokens that belong to this segment) keyboard keys are supported.

Checked item(s) are stored in the TokenEdit.CheckedItems collection and in the TokenEdit.CheckedItem property.

You can also specify whether token selection should be kept when the editor loses focus. To do this, use the RepositoryItemTokenEdit.ClearCheckStatesOnLostFocus property.

See Also