ASPxClientListBox Methods

Represents the client-side equivalent of the ASPxListBox control.
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.
AddItemCssClass(index, className) Sets the CSS class for a list box item specified by its index.
AddItemTextCellCssClass(itemIndex, textCellIndex, className) Sets the CSS class for a list box item's text cell specified by its index.
AdjustControl Modifies the control's size against the control's container.
(Inherited from ASPxClientControl)
AdjustControls Modifies the controls size within the specified container.
(Inherited from ASPxClientControl)
AreEditorsValid 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) 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.
Cast(obj) static Converts the specified object to the ASPxClientListBox type.
ClearEditorsInContainer(container) 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) 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) 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.
DetachEditorModificationListener(handler, predicate) 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.
FindItemByText(text) Returns a list box item by its text.
FindItemByValue(value) Returns a list box item by its value.
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 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 represents 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.
GetItemCount Gets the number of items contained in the editor's item collection.
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.
GetSelectedItem Returns the list editor's selected item.
(Inherited from ASPxClientListEdit)
GetSelectedItems Returns an array of the list editor's selected items.
GetSelectedValues Returns an array of the list editor's selected items values.
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.
InsertItem(index, text) Adds a new item to the control's items collection at the specified index.
MakeItemVisible(index) Scrolls the editor's item list, so that the specified item becomes visible.
PerformCallback(parameter) Sends a callback to the server, and generates the server-side ASPxListBox.Callback event, passing it the specified argument.
RemoveItem(index) Removes an item specified by its index from the client list editor.
RemoveItemCssClass(index, className) Removes the CSS class from a list box item specified by its index.
RemoveItemTextCellCssClass(itemIndex, textCellIndex, className) Removes the CSS class from a list box item's text cell specified by its index.
SelectAll Selects all list box items.
SelectIndices(indices) Selects the items with the specified indices within a list box.
SelectItems(items) Selects the specified items within a list box.
SelectValues(values) Select the items with the specified values within a list box.
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.
SetItemHtml(index, html) Defines the HTML content for the specified list box item.
SetItemTextCellAttribute(itemIndex, textCellIndex, attributeName, attributeValue) Adds a custom attribute to a list box item's text cell.
SetItemTextCellHtml(itemIndex, textCellIndex, html) Defines the HTML content for the specified list box item's text cell.
SetItemTextCellTooltip(itemIndex, textCellIndex, tooltip) Sets the tooltip text for the text cell of the editor's item specified by its index.
SetItemTooltip(index, tooltip) Sets the tooltip text for the list box editor's item specified by its index.
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.
UnselectIndices(indices) Unselects an array of the list box items with the specified indices.
UnselectItems(items) Unselects an array of the specified list box items.
UnselectValues(values) Unselects an array of the list box items with the specified values.
Validate Performs the editor's validation.
(Inherited from ASPxClientEdit)
ValidateEditorsInContainer(container) 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) 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) Performs validation of editors contained within the specified validation group, dependent on the editor visibility state specified.
(Inherited from ASPxClientEdit)
See Also