Skip to main content
A newer version of this page is available. .

MVCxTokenBox Properties

The object of this type represents a configured instance of the corresponding extension and is intended to be used mainly as a sender parameter when processing events on the server side.
Name Description
AccessibilityCompliant This property is not in effect for the ASPxTokenBox class. Inherited from ASPxTokenBox.
AccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl.
Adapter protected Gets the browser-specific adapter for the control. Inherited from Control.
AllowCustomTokens Gets or sets whether end-users can input custom tokens. Inherited from ASPxTokenBox.
AllowEllipsisInText Specifies if the combo box can automatically truncate the item’s text if it doesn’t fit into the item’s width. Inherited from ASPxAutoCompleteBoxBase.
AllowMouseWheel This property is not in effect for the ASPxTokenBox class. Inherited from ASPxTokenBox.
AllowUserInput This property is not in effect for the ASPxAutoCompleteBoxBase class. Inherited from ASPxAutoCompleteBoxBase.
AnimationType Gets or sets a value specifying the animation type used when the editor’s drop down window is invoked. Inherited from ASPxDropDownEditBase.
AppRelativeTemplateSourceDirectory Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control.
Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl.
AutoCompleteType This property is not in effect for the ASPxDropDownEditBase class. Inherited from ASPxDropDownEditBase.
AutoPostBack Gets or sets a value that specifies whether server-side processing is required to respond to specific predefined user actions. Inherited from ASPxEdit.
AutoResizeWithContainer Gets or sets a value that specifies whether the editor, whose width is a percentage value, can be resized automatically when the width of its resizable container changes. Inherited from ASPxTextEdit.
BackColor Gets or sets the background color of the Web server control. Inherited from WebControl.
BackgroundImage Gets the web control’s background image. Inherited from ASPxWebControl.
BackwardCompatibility static Provides access to the control’s backward compatibility settings. Inherited from ASPxWebControl.
Border Gets the web control’s border settings. Inherited from ASPxWebControl.
BorderBottom Gets the settings of the web control’s bottom border. Inherited from ASPxWebControl.
BorderColor Gets or sets the border color of the web control. Use the BorderWrapper.BorderColor property instead. Inherited from ASPxWebControl.
BorderLeft Gets the settings of the web control’s left border. Inherited from ASPxWebControl.
BorderRight Gets the settings of the web control’s right border. Inherited from ASPxWebControl.
BorderStyle Gets or sets the border style of the web control. Use the BorderWrapper.BorderStyle property instead. Inherited from ASPxWebControl.
BorderTop Gets the settings of the web control’s top border. Inherited from ASPxWebControl.
BorderWidth Gets or sets the border width of the web control. Use the BorderWrapper.BorderWidth property instead. Inherited from ASPxWebControl.
Bound Gets a value that specifies whether the control is data bound. Inherited from ASPxDataWebControlBase.
ButtonEditEllipsisImage This property is not in effect for the ASPxTokenBox class. Inherited from ASPxTokenBox.
Buttons This property is not in effect for the ASPxTokenBox class. Inherited from ASPxTokenBox.
ButtonStyle This property is not in effect for the ASPxTokenBox class. Inherited from ASPxTokenBox.
ButtonTemplate This property is not in effect for the ASPxTokenBox class. Inherited from ASPxTokenBox.
CallbackPageSize Gets or sets the number of items returned from the server on each callback request performed in response to a predefined client user action. Inherited from ASPxAutoCompleteBoxBase.
CallbackRouteValues

This member supports the internal infrastructure and is not intended to be used directly from your code.

To set up the extension routing logic, use the AutoCompleteBoxBaseSettings.CallbackRouteValues property at the extension settings level.

Caption Gets or sets the editor caption. Inherited from ASPxEditBase.
CaptionCellStyle Gets the style settings that define the caption cell appearance. Inherited from ASPxEditBase.
CaptionSettings Provides access to the editor caption settings. Inherited from ASPxEdit.
CaptionStyle Gets the style settings that define the caption appearance. Inherited from ASPxEditBase.
CaseSensitiveTokens Specifies if tokens are case sensitive. Inherited from ASPxTokenBox.
ChildControlsCreated protected Gets a value that indicates whether the server control’s child controls have been created. Inherited from Control.
ClearButton This property is not in effect for the ASPxTokenBox class. Inherited from ASPxTokenBox.
ClientEnabled Gets or sets a value that indicates whether an editor is enabled on the client. Inherited from ASPxEditBase.
ClientID Gets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase.
ClientIDMode Gets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control.
ClientIDSeparator protected Gets a character value representing the separator character used in the ClientID property. Inherited from Control.
ClientInstanceName Specifies the editor’s client programmatic identifier. Inherited from ASPxEditBase.
ClientReadOnly Gets or sets whether the editor is read only on the client-side. Inherited from ASPxEdit.
ClientSideEvents Gets an object that lists the client-side events specific to the ASPxTokenBox. Inherited from ASPxTokenBox.
ClientVisible Gets or sets a value that specifies the initial visibility state of an editor on the client. Inherited from ASPxEditBase.
Context protected Gets the HttpContext object associated with the server control for the current Web request. Inherited from Control.
Controls Gets the web control’s collection of child controls. Inherited from ASPxEditBase.
ControlStyle Gets the style of the Web server control. This property is used primarily by control developers. Inherited from WebControl.
ControlStyleCreated Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. Inherited from WebControl.
CssClass Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. Inherited from WebControl.
CssFilePath Gets or sets the path to a CSS file that defines the editor’s appearance. Inherited from ASPxEditBase.
CssPostfix Gets or sets a CSS class name postfix that identifies style settings to be applied to the editor. Inherited from ASPxEditBase.
Cursor Gets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl.
CustomButtonsPosition Specifies the position of custom control buttons relative to the input element. Inherited from ASPxDropDownEditBase.
DataItemContainer Gets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control.
DataKeysContainer Gets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control.
DataMember Gets or sets a specific data member in a multimember data source to bind to the editor. Inherited from ASPxEditBase.
DataSecurityMode Provides the capability to restrict setting the editor value on the client side to values listed in the server ASPxAutoCompleteBoxBase.Items. Inherited from ASPxAutoCompleteBoxBase.
DataSource Gets or sets the object from which a data-bound editor retrieves its list of data items. Inherited from ASPxAutoCompleteBoxBase.
DataSourceID Gets or sets the ID of the control from which the data-bound editor retrieves its list of data items. Inherited from ASPxAutoCompleteBoxBase.
DisabledCssClass static Gets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl.
DisabledStyle Gets the style settings which define a control’s appearance in the disabled state. Inherited from ASPxWebControl.
DisplayFormatString This property is not in effect for the ASPxTokenBox class. Inherited from ASPxTokenBox.
DropDownApplyButton Gets the settings of the ‘Apply’ command buttons in dropdown editors. Inherited from ASPxDropDownEditBase.
DropDownButton This property is not in effect for the ASPxTokenBox class. Inherited from ASPxTokenBox.
DropDownCloseButton Gets the settings of the ‘Close’ command buttons in dropdown editors. Inherited from ASPxDropDownEditBase.
DropDownHeight Gets or sets the height of the editor’s dropdown window. Inherited from ASPxAutoCompleteBoxBase.
DropDownRows Gets or sets the number of list items displayed within the editor’s scrollable dropdown window simultaneously. Inherited from ASPxAutoCompleteBoxBase.
DropDownWidth Gets or sets the width of the editor’s dropdown window. Inherited from ASPxAutoCompleteBoxBase.
EmptyImage static Obsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
EnableAnimation Obsolete. Gets or sets a value that specifies whether a specific animation effect is used when the editor’s drop down window is invoked. Inherited from ASPxDropDownEditBase.
EnableCallbackMode Gets or sets a value that specifies whether the editor’s list items can be loaded to the client side on demand via callbacks. Inherited from ASPxAutoCompleteBoxBase.
EnableClientSideAPI Gets or sets a value that specifies whether the editor can be manipulated on the client side via code. Inherited from ASPxEditBase.
Enabled Gets or sets a value that indicates whether the editor is enabled, allowing it to respond to end-user interactions. Inherited from ASPxEdit.
EnableDefaultAppearance Obsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
EnableFocusedStyle Gets or sets a value that specifies whether an editor in a focused state is displayed with predefined style settings. Inherited from ASPxEdit.
EnableIncrementalFiltering Obsolete. Gets or sets a value that specifies whether the incremental filtering behavior is available for the editor. Inherited from ASPxAutoCompleteBoxBase.
EnableItemsVirtualRendering Specifies whether the editor’s items are rendered virtually. Inherited from ASPxAutoCompleteBoxBase.
EnableSynchronization Gets or sets a value that specifies whether client manipulations with the editor’s list items (adding, deleting) should be synchronized with the editor’s server ASPxAutoCompleteBoxBase.Items collection. Inherited from ASPxAutoCompleteBoxBase.
EnableSynchronizationOnPerformCallback This property is not in effect for the ASPxAutoCompleteBoxBase class. Inherited from ASPxAutoCompleteBoxBase.
EnableTheming Gets or sets a value indicating whether themes apply to this control. Inherited from WebControl.
EnableViewState Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. Inherited from Control.
EncodeHtml Gets or sets a value that specifies whether the editor’s value and element content are rendered as pure HTML, or HTML markers are stripped out. Inherited from ASPxButtonEditBase.
ErrorText Gets or sets an error text to be displayed within an editor’s error frame if the editor’s custom validation fails. Inherited from ASPxEdit.
Events protected Gets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
FilterMinLength Specifies the minimum length of the filter string. Inherited from ASPxAutoCompleteBoxBase.
FocusedStyle Gets the style settings which define an editor’s appearance in the focused state. Inherited from ASPxEdit.
Font Gets the font properties associated with the Web server control. Inherited from WebControl.
ForceDataBinding Gets or sets a value that specifies whether the editor should be rebound to a data source automatically. Inherited from ASPxAutoCompleteBoxBase.
ForeColor Gets or sets the foreground color (typically the color of the text) of the Web server control. Inherited from WebControl.
GlobalAccessibilityCompliant static Gets or sets whether accessibility support is globally enabled for all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalCheckReferencesToExternalScripts static Gets or sets whether the availability and correctness of references to external client scripts (such as jQuery, jQuery UI, Knockout, etc.), which are used by certain DevExpress web controls, are checked. Inherited from ASPxWebControl.
GlobalEmbedRequiredClientLibraries static Obsolete. Gets or sets whether external client libraries (including scripts and CSS files) are automatically embedded in the DevExpress.Web assembly as resources. Inherited from ASPxWebControl.
GlobalRightToLeft static Gets or sets that the right-to-left orientation shall be globally applied to all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalStyleSheetTheme static Gets or sets the name of the style sheet theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalTheme static Gets or sets the name of the Theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalThemeBaseColor static Gets or sets the base color for the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
GlobalThemeFont static Gets or sets the font settings of the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
HasAttributes Gets a value indicating whether the control has attributes set. Inherited from WebControl.
HasChildViewState protected Gets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control.
Height Gets or sets the editor’s height. Inherited from ASPxTextEdit.
HelpText Gets or sets the current editor help text. Inherited from ASPxTextEdit.
HelpTextSettings Provides access to the help text settings within the editor. Inherited from ASPxTextEdit.
HelpTextStyle Gets the style settings that define the help text appearance. Inherited from ASPxTextEdit.
HorizontalAlign Gets or sets the horizontal alignment of the editor’s contents. Inherited from ASPxPureTextBoxBase.
ID Gets or sets the programmatic identifier assigned to the server control. Inherited from Control.
IdSeparator protected Gets the character used to separate control identifiers. Inherited from Control.
ImageFolder Gets or sets the path to the folder that contains images used by an editor. Inherited from ASPxEdit.
ImageUrlField Gets or sets the data source field that provides image locations for the editor’s items. Inherited from ASPxAutoCompleteBoxBase.
IncrementalFilteringDelay Specifies the time interval after which the editor filters items. Inherited from ASPxAutoCompleteBoxBase.
IncrementalFilteringMode Specifies the incremental filter mode. Inherited from ASPxAutoCompleteBoxBase.
Initialized Gets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase.
InvalidStyle Gets the style settings which define an editor’s appearance in the invalid state. Inherited from ASPxEdit.
IsCallback This member supports the internal infrastructure and is not intended to be used directly from your code.
IsChildControlStateCleared protected Gets a value indicating whether controls contained within this control have control state. Inherited from Control.
IsTrackingViewState protected Gets a value that indicates whether the server control is saving changes to its view state. Inherited from Control.
IsValid Gets or sets a value that indicates whether the editor’s value passes validation. Inherited from ASPxEdit.
IsViewStateEnabled protected Gets a value indicating whether view state is enabled for this control. Inherited from Control.
ItemImage Gets the settings of the common image displayed by all the items in the editor. Inherited from ASPxAutoCompleteBoxBase.
Items Gets the collection of items displayed in the editor’s dropdown window. Inherited from ASPxAutoCompleteBoxBase.
ItemStyle Gets the style settings for all items in the editor. Inherited from ASPxAutoCompleteBoxBase.
ItemTemplate Gets or sets a common template used for displaying the content of all items within the combo box and token box. Inherited from ASPxAutoCompleteBoxBase.
ItemValueType Gets the data type of the editor’s item values. Inherited from ASPxTokenBox.
JSProperties Enables you to supply any server data that can then be parsed on the client. Inherited from ASPxEditBase.
ListBoxStyle Gets the style settings that define the appearance of the editor’s dropdown list. Inherited from ASPxAutoCompleteBoxBase.
LoadDropDownOnDemand Gets or sets a value specifying whether the HTML code that represents the editor’s drop-down window should be loaded via a callback on demand. Inherited from ASPxAutoCompleteBoxBase.
Loaded Indicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase.
LoadingPanelDelay Obsolete. Gets or sets the delay before displaying the loading panel in the editor. Inherited from ASPxAutoCompleteBoxBase.
LoadingPanelImage Gets the settings of an image displayed within a loading panel. Inherited from ASPxAutoCompleteBoxBase.
LoadingPanelImagePosition Obsolete. Gets or sets the position of an image displayed within a loading panel. Inherited from ASPxAutoCompleteBoxBase.
LoadingPanelStyle Gets the style settings defining the appearance of the loading panel. Inherited from ASPxAutoCompleteBoxBase.
LoadingPanelText Obsolete. Gets or sets the text to be displayed within a loading panel while waiting for a callback response. Inherited from ASPxAutoCompleteBoxBase.
LoadViewStateByID protected Gets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control.
MaxLength Gets or sets the maximum number of characters an end user can enter into the editor. Inherited from ASPxTextBoxBase.
NamingContainer Gets a reference to the server control’s naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. Inherited from Control.
NullText Gets or sets the prompt text displayed within the editor’s input box when the editor is not focused and its value is null. Inherited from ASPxAutoCompleteBoxBase.
NullTextDisplayMode Gets or sets a value indicating when the null text should be displayed in the editor. Inherited from ASPxTextEdit.
NullTextStyle Gets the style settings for the editor’s edit box and prompt text, when the editor is not focused and its text is null. Inherited from ASPxTextEdit.
Paddings Gets the editor’s padding settings. Inherited from ASPxPureTextBoxBase.
Page Gets a reference to the Page instance that contains the server control. Inherited from Control.
Parent Gets a reference to the server control’s parent control in the page control hierarchy. Inherited from Control.
ParentImages This property is not in effect for the ASPxEditBase class. Inherited from ASPxEditBase.
ParentSkinOwner For internal use only. Inherited from ASPxEditBase.
ParentStyles This property is not in effect for the ASPxEditBase class. Inherited from ASPxEditBase.
Password This property is not in effect for the ASPxDropDownEditBase class. Inherited from ASPxDropDownEditBase.
PopupHorizontalAlign Gets or sets a drop down window‘s horizontal alignment. Inherited from ASPxDropDownEditBase.
PopupVerticalAlign Gets or sets a drop down window‘s vertical alignment. Inherited from ASPxDropDownEditBase.
Properties Provides access to the settings which are specific to the current editor type.
ReadOnly Gets or sets a value indicating whether an end-user can change the editor’s contents at runtime. Inherited from ASPxAutoCompleteBoxBase.
ReadOnlyStyle Gets style settings for the read-only editor state. Inherited from ASPxEdit.
RenderIFrameForPopupElements Gets or sets a value that specifies whether the editor’s dropdown window is displayed above Java applets that may present on the web page. Inherited from ASPxDropDownEditBase.
RenderingCompatibility Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
RightToLeft Gets or sets a value specifying whether or not the current control supports right-to-left representation. Inherited from ASPxTextEdit.
RootStyle Gets the style settings defining the appearance of an editor container. Inherited from ASPxEditBase.
SelectInputTextOnClick This property is not in effect for the ASPxTokenBox class. Inherited from ASPxTokenBox.
SettingsAdaptivity Provides access to the control’s adaptivity settings. Inherited from ASPxTokenBox.
SettingsLoadingPanel Provides access to the loading panel settings. Inherited from ASPxAutoCompleteBoxBase.
ShadowImage static Obsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
ShowDropDownOnFocus Specifies the drop down window visibility when the editor gets focus. Inherited from ASPxTokenBox.
ShowLoadingPanel Obsolete. Gets or sets whether the loading panel can be displayed. Inherited from ASPxAutoCompleteBoxBase.
ShowLoadingPanelImage Obsolete. Specifies whether or not the image can be displayed within a loading panel while waiting for a callback response. Inherited from ASPxAutoCompleteBoxBase.
ShowModelErrors Gets or sets a value that specifies whether or not model error messages should be automatically displayed for the editor when its value validation fails.
ShowShadow Gets or sets a value that specifies whether the editor’s drop down window casts a shadow. Inherited from ASPxDropDownEditBase.
Site Gets information about the container that hosts the current control when rendered on a design surface. Inherited from Control.
SkinID Gets or sets the skin to apply to the control. Inherited from WebControl.
Spacing Gets or sets the spacing between the editor’s elements. Inherited from ASPxButtonEditBase.
SpriteCssFilePath Gets or sets the path to a CSS file that defines the control’s sprite image settings. Inherited from ASPxEdit.
SpriteImageUrl Gets or sets the path to a sprite image. Inherited from ASPxEdit.
Style Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. Inherited from WebControl.
SupportsDisabledAttribute Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to “disabled” when the control’s IsEnabled property is false. Inherited from WebControl.
IControlBuilderAccessor.ControlBuilder For a description of this member, see ControlBuilder. Inherited from Control.
IControlDesignerAccessor.UserData For a description of this member, see UserData. Inherited from Control.
IDataBindingsAccessor.DataBindings For a description of this member, see DataBindings. Inherited from Control.
IDataBindingsAccessor.HasDataBindings For a description of this member, see HasDataBindings. Inherited from Control.
IExpressionsAccessor.Expressions For a description of this member, see Expressions. Inherited from Control.
IExpressionsAccessor.HasExpressions For a description of this member, see HasExpressions. Inherited from Control.
TabIndex Gets or sets the tab index of the Web server control. Inherited from WebControl.
TagKey protected Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl.
TagName protected Gets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl.
TemplateControl Gets or sets a reference to the template that contains this control. Inherited from Control.
TemplateSourceDirectory Gets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control.
Text Gets or sets the editor token texts, separated with a sign specified by the ASPxTokenBox.TextSeparator property. Inherited from ASPxTokenBox.
TextField Gets or sets the data source field that provides display texts for the editor’s items. Inherited from ASPxAutoCompleteBoxBase.
TextFormatString This property is not in effect for the ASPxTokenBox class. Inherited from ASPxTokenBox.
TextSeparator Gets or sets a separator that is used in the editor ASPxTokenBox.Text property to divide tokens. Inherited from ASPxTokenBox.
Theme Gets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl.
TokenBoxInputStyle Gets the style settings that define the appearance of an input area. Inherited from ASPxTokenBox.
TokenHoverStyle Gets the style settings that define the appearance of a token when it is hovered by a pointer. Inherited from ASPxTokenBox.
TokenRemoveButtonHoverStyle Gets the style settings that define the appearance of a token‘s remove button when it is hovered by a pointer. Inherited from ASPxTokenBox.
TokenRemoveButtonStyle Gets the style settings that define the appearance of a token‘s remove button. Inherited from ASPxTokenBox.
Tokens Provide access to a collection of editor tokens. Inherited from ASPxTokenBox.
TokenStyle Gets the style settings that define the appearance of a token. Inherited from ASPxTokenBox.
TokenTextStyle Gets the style settings that define the appearance of a token‘s text. Inherited from ASPxTokenBox.
ToolTip Gets or sets the text displayed when the mouse pointer hovers over the Web server control. Inherited from WebControl.
UniqueID Gets the unique, hierarchically qualified identifier for the server control. Inherited from Control.
ValidateRequestMode Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control.
ValidationSettings Gets the token box’s validation settings.
Value Gets or sets the editor value. Inherited from ASPxTokenBox.
ValueField Gets or sets the data source field that provides values for the editor’s items. Inherited from ASPxAutoCompleteBoxBase.
ValueSeparator Gets or sets a separator that is used in the editor ASPxTokenBox.Value property to divide values of items, corresponding to editor tokens. Inherited from ASPxTokenBox.
ViewState protected Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. Inherited from Control.
ViewStateIgnoresCase protected Gets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control.
ViewStateMode Gets or sets the view-state mode of this control. Inherited from Control.
Visible Gets or sets a value specifying the editor’s visibility. Inherited from ASPxEdit.
Width Gets or sets the editor’s width. Inherited from ASPxTextEdit.
See Also