Skip to main content

RepositoryItemTokenEdit.TokenPopulateMode Property

Gets or sets whether or not the RepositoryItemTokenEdit.Tokens collection supports automatic population.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

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

Property Value

Type Default Description
DevExpress.XtraEditors.TokenEditTokenPopupateMode Default

A DevExpress.XtraEditors.TokenEditTokenPopupateMode enumerator value that specifies whether or not the RepositoryItemTokenEdit.Tokens collection supports automatic population.

Remarks

The default TokenPopulateMode property value means that whenever an end-user enters a text that is later successfully validated on the RepositoryItemTokenEdit.ValidateToken event and transformed into a token, this token is added to the RepositoryItemTokenEdit.Tokens collection and can later be re-entered from the editor’s drop-down list (see the RepositoryItemTokenEdit.ShowDropDown property). This allows your end-users to repeatedly enter the same tokens without the need to manually re-type their captions.

The DisableAutoPopulate TokenPopulateMode property value prevents validated user tokens from being added to the RepositoryItemTokenEdit.Tokens collection. Thus, the editor’s drop-down list will always display only your predefined tokens. Refer to the Token Edit Control topic for details.

Note

The described behavior applies to Manual mode only. In Token List mode, end-users cannot enter and validate their own text blocks, so no new tokens can be added to the RepositoryItemTokenEdit.Tokens collection. See the RepositoryItemTokenEdit.EditMode property to learn more.

See Also