MVCxClientTokenBox Methods

A client-side counterpart of the TokenBox and TokenBoxFor extensions.

Name	Description
AddItem(text)	Adds a new item to the end of the control’s item collection. Inherited from ASPxClientComboBox.
AddItemCssClass(index, className)	Sets the CSS class for a combo box item specified by its index. Inherited from ASPxClientComboBox.
AddItemTextCellCssClass(itemIndex, textCellIndex, className)	Sets the CSS class for a combo box item’s text cell specified by its index. Inherited from ASPxClientComboBox.
AddToken(text)	Adds a new token with the specified text to the end of the control’s token collection. Inherited from ASPxClientTokenBox.
AdjustControl	Modifies the control’s size against the control’s container. Inherited from ASPxClientControl.
AdjustControls static	Modifies the controls size within the specified container. Inherited from ASPxClientControl.
AdjustDropDownWindow	Modifies the size of the drop down window in accordance with its content. Inherited from ASPxClientDropDownEditBase.
AreEditorsValid static	Verifies whether the editors in a specified visibility state, which are located within a specified container and belong to a specific validation group, are valid. Inherited from ASPxClientEdit.
AttachEditorModificationListener(handler, predicate) static	Attaches a handler to the ASPxClientEdit‘s event indicating whether the editor has been changed since the previous state. Inherited from ASPxClientEdit.
BeginUpdate	Prevents the client combobox editor from being rendered until the ASPxClientComboBox.EndUpdate method is called. Inherited from ASPxClientComboBox.
Cast(obj) static	Converts the specified object to the MVCxClientTokenBox type.
ClearEditorsInContainer(container) static	Assigns a null value to all editors in a specified visibility state, which are located within a specified container and belong to a specific validation group. Inherited from ASPxClientEdit.
ClearEditorsInContainerById(containerId) static	Assigns a null value to all editors which are located within the specified container object, and belonging to a specific validation group, dependent on the visibility state specified. Inherited from ASPxClientEdit.
ClearGroup(validationGroup) static	Assigns a null value to all editors which belong to a specific validation group, dependent on the visibility state specified. Inherited from ASPxClientEdit.
ClearItems	Removes all items from the client combo box editor. Inherited from ASPxClientComboBox.
ClearTokenCollection	Removes all tokens contained in the token box. Inherited from ASPxClientTokenBox.
DetachEditorModificationListener(handler, predicate) static	Detaches a handler from the editor’s event if the editor meets the predicate criteria. Inherited from ASPxClientEdit.
EndUpdate	Re-enables editor render operations after a call to the ASPxClientComboBox.BeginUpdate method and forces an immediate re-rendering. Inherited from ASPxClientComboBox.
EnsureDropDownLoaded(callbackFunction)	Determines whether the drop-down content is loaded; if not - loads the content. Inherited from ASPxClientComboBox.
FindItemByText(text)	Returns a combo box item by its text. Inherited from ASPxClientComboBox.
FindItemByValue(value)	Returns a combo box item by its value. Inherited from ASPxClientComboBox.
Focus	Sets input focus to the editor. Inherited from ASPxClientEdit.
GetButton(number)	Returns a button by its index in the button collection. Inherited from ASPxClientButtonEditBase.
GetButtonVisible(number)	Returns a value specifying whether a button is displayed. Inherited from ASPxClientButtonEditBase.
GetCaption	Returns the text displayed in the editor caption. Inherited from ASPxClientEditBase.
GetCaretPosition	Obtains the caret position within the edited text. Inherited from ASPxClientTextEdit.
GetClientVisible	Obsolete. Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetControlCollection static	Returns a collection of client web control objects. Inherited from ASPxClientControl.
GetEnabled	Returns a value indicating whether an editor is enabled. Inherited from ASPxClientEditBase.
GetErrorText	Gets the error text to be displayed within the editor’s error frame if the editor’s validation fails. Inherited from ASPxClientEdit.
GetHeight	Returns the control’s height. Inherited from ASPxClientControl.
GetInputElement	Returns an HTML element that is the control’s input element. Inherited from ASPxClientEdit.
GetIsValid	Gets a value that indicates whether the editor’s value passes validation. Inherited from ASPxClientEdit.
GetItem(index)	Returns an item specified by its index within the combo box editor’s item collection. Inherited from ASPxClientComboBox.
GetItemCount	Gets the number of items contained in the editor’s item collection. Inherited from ASPxClientComboBox.
GetMainElement	Returns an HTML element that is the root of the control’s hierarchy. Inherited from ASPxClientControlBase.
GetParentControl	Returns a client instance of the control that is the parent for a specified control. Inherited from ASPxClientControlBase.
GetReadOnly	Returns a value indicating whether the editor’s state is read-only on the client-side. Inherited from ASPxClientEdit.
GetSelectedIndex	Returns the index of the selected item within the combo box editor. Inherited from ASPxClientComboBox.
GetSelectedItem	Returns the combo box editor’s selected item. Inherited from ASPxClientComboBox.
GetText	Gets the token texts, separated with a sign, specified by the ASPxTokenBox.TextSeparator property. Inherited from ASPxClientTokenBox.
GetTokenCollection	Returns a collection of tokens. Inherited from ASPxClientTokenBox.
GetTokenHtmlElement(index)	Returns an HTML span element that corresponds to the specified token. Inherited from ASPxClientTokenBox.
GetTokenIndexByText(text)	Returns the index of a token specified by its text. Inherited from ASPxClientTokenBox.
GetTokenRemoveButtonHtmlElement(index)	Returns an HTML span element that corresponds to the specified token‘s remove button. Inherited from ASPxClientTokenBox.
GetTokenTextHtmlElement(index)	Returns an HTML span element that corresponds to the specified token‘s text. Inherited from ASPxClientTokenBox.
GetValue	Gets the editor value. Inherited from ASPxClientTokenBox.
GetVisible	Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetWidth	Returns the control’s width. Inherited from ASPxClientControl.
HideDropDown	Closes the opened drop down window of the editor. Inherited from ASPxClientDropDownEditBase.
InCallback	Returns a value that determines whether a callback request sent by a web control is being currently processed on the server side. Inherited from ASPxClientControlBase.
InsertItem(index, text)	Adds a new item to the control’s items collection at the specified index. Inherited from ASPxClientComboBox.
IsCustomToken(text, caseSensitive)	Returns a value that indicates if the specified token (string) is a custom token. Inherited from ASPxClientTokenBox.
MakeItemVisible(index)	Scrolls the editor’s item list, so that the specified item becomes visible. Inherited from ASPxClientComboBox.
PerformCallback(data)	Sends a callback with a parameter to update the TokenBox by processing the passed information on the server, in an Action specified by the TokenBox’s AutoCompleteBoxBaseSettings.CallbackRouteValues property.
RemoveItem(index)	Removes an item specified by its index from the client list editor. Inherited from ASPxClientComboBox.
RemoveItemCssClass(index, className)	Removes the CSS class from a combo box item specified by its index. Inherited from ASPxClientComboBox.
RemoveItemTextCellCssClass(itemIndex, textCellIndex, className)	Removes the CSS class from a combo box item’s text cell specified by its index. Inherited from ASPxClientComboBox.
RemoveToken(index)	Removes a token specified by its index from the client token box. Inherited from ASPxClientTokenBox.
RemoveTokenByText(text)	Removes a token specified by its text from the client token box. Inherited from ASPxClientTokenBox.
SelectAll	Selects all text in the text editor. Inherited from ASPxClientTextEdit.
SendMessageToAssistiveTechnology(message)	Specifies the text that Assistive Technologies (screen readers or braille display, for example) will provide to a user. Inherited from ASPxClientControlBase.
SetButtonVisible(number, value)	Specifies whether the button is visible. Inherited from ASPxClientButtonEditBase.
SetCaption(caption)	Specifies the text displayed in the editor caption. Inherited from ASPxClientEditBase.
SetCaretPosition(position)	Sets the caret position within the edited text. Inherited from ASPxClientTextEdit.
SetClientVisible(visible)	Obsolete. Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetEnabled(value)	Specifies whether an editor is enabled. Inherited from ASPxClientEditBase.
SetErrorText(errorText)	Sets the error text to be displayed within the editor’s error frame if the editor’s validation fails. Inherited from ASPxClientEdit.
SetHeight(height)	Specifies the control’s height. Note that this method is not in effect for some controls. Inherited from ASPxClientControl.
SetIsValid(isValid)	Sets a value that specifies whether the editor’s value is valid. Inherited from ASPxClientEdit.
SetItemAttribute(index, attributeName, attributeValue)	Adds a custom attribute to a combo box item. Inherited from ASPxClientComboBox.
SetItemHtml(index, html)	Defines the HTML content for the specified combo box item. Inherited from ASPxClientComboBox.
SetItemTextCellAttribute(itemIndex, textCellIndex, attributeName, attributeValue)	Adds a custom attribute to a combo box item’s text cell. Inherited from ASPxClientComboBox.
SetItemTextCellHtml(itemIndex, textCellIndex, html)	Defines the HTML content for the specified combo box item’s text cell. Inherited from ASPxClientComboBox.
SetItemTextCellTooltip(itemIndex, textCellIndex, tooltip)	Sets the tooltip text for the text cell of the editor’s item specified by its index. Inherited from ASPxClientComboBox.
SetItemTooltip(index, tooltip)	Sets the tooltip text for the combo box editor’s item specified by its index. Inherited from ASPxClientComboBox.
SetReadOnly(readOnly)	Specifies whether the control’s state is read-only on the client side. Inherited from ASPxClientEdit.
SetSelectedIndex(index)	For internal use only. Inherited from ASPxClientTokenBox.
SetSelectedItem(item)	For internal use only. Inherited from ASPxClientTokenBox.
SetSelection(startPos, endPos, scrollToSelection)	Selects the specified portion of the editor’s text. Inherited from ASPxClientTextEdit.
SetText(text)	Sets the token texts, separated with a sign, specified by the ASPxTokenBox.TextSeparator property. Inherited from ASPxClientTokenBox.
SetTokenCollection(collection)	Sets a collection of tokens. Inherited from ASPxClientTokenBox.
SetValue(value)	Sets the editor value. Inherited from ASPxClientTokenBox.
SetVisible(visible)	Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetWidth(width)	Specifies the control’s width in pixels. Inherited from ASPxClientControl.
ShowDropDown	Invokes the editor’s drop down window. Inherited from ASPxClientDropDownEditBase.
Validate	Performs the editor’s validation. Inherited from ASPxClientEdit.
ValidateEditorsInContainer(container) static	Validates all editors in a specified visibility state, which are located within a specified container and belong to a specific validation group. Inherited from ASPxClientEdit.
ValidateEditorsInContainerById(containerId) static	Performs validation of the editors which are located within the specified container and belong to a specific validation group, dependent on the visibility state specified. Inherited from ASPxClientEdit.
ValidateGroup(validationGroup) static	Performs validation of editors contained within the specified validation group, dependent on the editor visibility state specified. Inherited from ASPxClientEdit.