Skip to main content
BuyLog In
ASP.NET MVC Extensions
Search in…
Docs > Client API Reference > DevExpress.Web.Mvc Scripts > MVCxClientListBox > Methods
All docs
V24.1
ASP.NET MVC Extensions
Prerequisites
Supported Browsers
What's Installed
Get Started
Upgrade to a New Version
Common Concepts
Components
Security Considerations
Redistribution and Deployment
Troubleshooting
Get More Help
.NET Framework API Reference
Client API Reference
DevExpress.Web.Mvc Scripts
MVCxClientBeforeExportRequestEventArgs
MVCxClientBeginCallbackEventArgs
MVCxClientBinaryImage
MVCxClientCalendar
MVCxClientCallbackPanel
MVCxClientCardView
MVCxClientChart
MVCxClientComboBox
MVCxClientDataView
MVCxClientDateEdit
MVCxClientDiagram
MVCxClientDockManager
MVCxClientDockPanel
MVCxClientDocumentViewer
MVCxClientFileManager
MVCxClientFilterControl
MVCxClientGantt
MVCxClientGlobalBeginCallbackEventArgs
MVCxClientGlobalEvents
MVCxClientGridView
MVCxClientHtmlEditor
MVCxClientImageGallery
MVCxClientListBox
Members
Properties
Methods
Cast(obj)
PerformCallback(data)
Events
MVCxClientNavBar
MVCxClientPageControl
MVCxClientPivotGrid
MVCxClientPopupControl
MVCxClientQueryBuilder
MVCxClientQueryBuilderSaveCommandExecutedEventArgs
MVCxClientReportDesigner
MVCxClientReportDesignerSaveCommandExecutedEventArgs
MVCxClientReportViewer
MVCxClientRichEdit
MVCxClientRoundPanel
MVCxClientScheduler
MVCxClientSchedulerStorage
MVCxClientSchedulerTemplateToolTip
MVCxClientSchedulerToolTipDisplayingEventArgs
MVCxClientSpreadsheet
MVCxClientTokenBox
MVCxClientTreeList
MVCxClientTreeView
MVCxClientUploadControl
MVCxClientUtils
MVCxClientVerticalGrid
MVCxClientWebDocumentViewer
MVCxSchedulerToolTipType
MVCxClientBeforeExportRequestEventHandler<Sender>
MVCxClientBeginCallbackEventHandler<Sender>
MVCxClientGlobalBeginCallbackEventHandler<Sender>
MVCxClientQueryBuilderSaveCommandExecutedEventHandler<Sender>
MVCxClientReportDesignerSaveCommandExecutedEventHandler<Sender>
MVCxClientSchedulerToolTipDisplayingEventHandler<Sender>
Download CHM

MVCxClientListBox Methods

A client-side counterpart of the ListBox and ListBoxFor extensions.
Name Description
AddItem(text) Adds a new item to the editor, specifying the item’s display text, associated value and displayed image, and returns the index of the added item. Inherited from ASPxClientListBox.
AddItemCssClass(index, className) Sets the CSS class for a list box item specified by its index. Inherited from ASPxClientListBox.
AddItemTextCellCssClass(itemIndex, textCellIndex, className) Sets the CSS class for a list box item’s text cell specified by its index. Inherited from ASPxClientListBox.
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.
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 list box editor from being rendered until the ASPxClientListBox.EndUpdate method is called. Inherited from ASPxClientListBox.
Cast(obj) static Converts the specified object to the MVCxClientListBox 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 list box editor. Inherited from ASPxClientListBox.
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 ASPxClientListBox.BeginUpdate method, and forces an immediate re-rendering. Inherited from ASPxClientListBox.
FindItemByText(text) Returns a list box item by its text. Inherited from ASPxClientListBox.
FindItemByValue(value) Returns a list box item by its value. Inherited from ASPxClientListBox.
Focus Sets input focus to the editor. Inherited from ASPxClientEdit.
GetCaption Returns the text displayed in the editor caption. Inherited from ASPxClientEditBase.
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 list box editor’s item collection. Inherited from ASPxClientListBox.
GetItemCount Gets the number of items contained in the editor’s item collection. Inherited from ASPxClientListBox.
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 list editor. Inherited from ASPxClientListEdit.
GetSelectedIndices Returns an array of the list editor’s selected items indices. Inherited from ASPxClientListBox.
GetSelectedItem Returns the list editor’s selected item. Inherited from ASPxClientListEdit.
GetSelectedItems Returns an array of the list editor’s selected items. Inherited from ASPxClientListBox.
GetSelectedValues Returns an array of the list editor’s selected items values. Inherited from ASPxClientListBox.
GetValue Returns the editor’s value. Inherited from ASPxClientEditBase.
GetVisible Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetWidth Returns the control’s width. Inherited from ASPxClientControl.
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.
InitOnContainerMadeVisible Obsolete. Initializes the ASPxClientListBox client object when its parent container becomes visible dynamically, on the client side. Inherited from ASPxClientListBox.
InsertItem(index, text) Adds a new item to the control’s items collection at the specified index. Inherited from ASPxClientListBox.
MakeItemVisible(index) Scrolls the editor’s item list, so that the specified item becomes visible. Inherited from ASPxClientListBox.
PerformCallback(data) Sends a callback with a parameter to update the ListBox by processing the passed information on the server, in an Action specified by the ListBox’s ListBoxSettings.CallbackRouteValues property.
RemoveItem(index) Removes an item specified by its index from the client list editor. Inherited from ASPxClientListBox.
RemoveItemCssClass(index, className) Removes the CSS class from a list box item specified by its index. Inherited from ASPxClientListBox.
RemoveItemTextCellCssClass(itemIndex, textCellIndex, className) Removes the CSS class from a list box item’s text cell specified by its index. Inherited from ASPxClientListBox.
SelectAll Selects all list box items. Inherited from ASPxClientListBox.
SelectIndices(indices) Selects the items with the specified indices within a list box. Inherited from ASPxClientListBox.
SelectItems(items) Selects the specified items within a list box. Inherited from ASPxClientListBox.
SelectValues(values) Select the items with the specified values within a list box. Inherited from ASPxClientListBox.
SendMessageToAssistiveTechnology(message) Specifies the text that Assistive Technologies (screen readers or braille display, for example) will provide to a user. Inherited from ASPxClientControlBase.
SetCaption(caption) Specifies the text displayed in the editor caption. Inherited from ASPxClientEditBase.
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 list box item. Inherited from ASPxClientListBox.
SetItemHtml(index, html) Defines the HTML content for the specified list box item. Inherited from ASPxClientListBox.
SetItemTextCellAttribute(itemIndex, textCellIndex, attributeName, attributeValue) Adds a custom attribute to a list box item’s text cell. Inherited from ASPxClientListBox.
SetItemTextCellHtml(itemIndex, textCellIndex, html) Defines the HTML content for the specified list box item’s text cell. Inherited from ASPxClientListBox.
SetItemTextCellTooltip(itemIndex, textCellIndex, tooltip) Sets the tooltip text for the text cell of the editor’s item specified by its index. Inherited from ASPxClientListBox.
SetItemTooltip(index, tooltip) Sets the tooltip text for the list box editor’s item specified by its index. Inherited from ASPxClientListBox.
SetReadOnly(readOnly) Specifies whether the control’s state is read-only on the client side. Inherited from ASPxClientEdit.
SetSelectedIndex(index) Sets the list editor’s selected item specified by its index. Inherited from ASPxClientListEdit.
SetSelectedItem(item) Sets the list editor’s selected item. Inherited from ASPxClientListEdit.
SetValue(value) Changes the editor’s value. Inherited from ASPxClientEditBase.
SetVisible(visible) Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetWidth(width) Specifies the control’s width in pixels. Inherited from ASPxClientControl.
UnselectAll Unselects all list box items. Inherited from ASPxClientListBox.
UnselectIndices(indices) Unselects an array of the list box items with the specified indices. Inherited from ASPxClientListBox.
UnselectItems(items) Unselects an array of the specified list box items. Inherited from ASPxClientListBox.
UnselectValues(values) Unselects an array of the list box items with the specified values. Inherited from ASPxClientListBox.
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.
See Also