The requested page is not available for the requested platform. You are viewing the content for Default platform.

MVCxListBox 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
AccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control.
(Inherited from WebControl)
AccessibilityCompliant

Enables accessibility support.

(Inherited from ASPxListBox)
Adapter Gets the browser-specific adapter for the control.
(Inherited from Control)
AllowEllipsisInText

Specifies if the list box can automatically truncate the item's text if it doesn't fit into the item's width.

(Inherited from ASPxListBox)
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)
AutoPostBack

Gets or sets a value that specifies whether server-side processing is required to respond to specific predefined user actions.

(Inherited from ASPxEdit)
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)
BindingContainer

For internal use only.

(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)
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 ASPxListBox)
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 ListBoxSettings.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)
CheckBoxCheckedImage

Provides access to the settings that define the image of check boxes in the checked state within the ASPxListBox control.

(Inherited from ASPxListBox)
CheckBoxFocusedStyle

Gets the style settings that define the check box appearance in the focused state within the ASPxListBox control.

(Inherited from ASPxListBox)
CheckBoxGrayedImage

Provides access to the settings that define the image of the "Select All" check box when one or more list box items are selected.

(Inherited from ASPxListBox)
CheckBoxStyle

Gets the style settings that define the check box appearance within the ASPxListBox control.

(Inherited from ASPxListBox)
CheckBoxUncheckedImage

Provides access to the settings that define the image of check boxes in the unchecked state within the ASPxListBox control.

(Inherited from ASPxListBox)
ChildControlsCreated Gets a value that indicates whether the server control's child controls have been created.
(Inherited from Control)
ClearFilterImage

Gets the settings of an image displayed within the "Clear filter" button in the list box.

(Inherited from ASPxListBox)
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 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 ASPxListBox.

(Inherited from ASPxListBox)
ClientVisible

Gets or sets a value that specifies the initial visibility state of an editor on the client.

(Inherited from ASPxEditBase)
Columns

Provides access to the editor's column collection.

(Inherited from ASPxListBox)
Context Gets the HttpContext object associated with the server control for the current Web request.
(Inherited from Control)
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)
Controls

Gets the web control's collection of child controls.

(Inherited from ASPxEditBase)
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)
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 ASPxListEdit.Items.

(Inherited from ASPxListBox)
DataSource

Gets or sets the object from which a data-bound combo box editor retrieves its list of data items.

(Inherited from ASPxListEdit)
DataSourceID

Gets or sets the ID of the control from which the data-bound editor retrieves its list of data items.

(Inherited from ASPxListEdit)
DesignMode

For internal use only.

(Inherited from ASPxWebControl)
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)
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)
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 ASPxListBox)
EnableClientSideAPI

Gets or sets a value that specifies whether the editor can be manipulated on the client side via code.

(Inherited from ASPxEditBase)
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)
EnableItemsVirtualRendering

Specifies whether the editor's items are rendered virtually.

(Inherited from ASPxListBox)
EnableSelectAll

Gets or sets whether selecting all items within a list box is available.

(Inherited from ASPxListBox)
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 Items collection.

(Inherited from ASPxListBox)
EnableSynchronizationOnPerformCallback

Gets or sets a value specifying whether automatic item synchronization should work when a callback initiated by the editor's client ASPxClientComboBox.PerformCallback method is being proccessed on the server side.

(Inherited from ASPxListBox)
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)
Enabled

Gets or sets a value that indicates whether the editor is enabled, allowing it to respond to end-user interactions.

(Inherited from ASPxEdit)
EncodeHtml

Gets or sets a value that specifies whether the editor's element content is rendered as a pure HTML, or HTML markers are stripped out.

(Inherited from ASPxListBox)
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 Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from Control)
FilterEditorStyle

Gets the style settings which define a filter editor appearance in the list box.

(Inherited from ASPxListBox)
FilterImage

Gets the settings of an image displayed within the filter button in the list box.

(Inherited from ASPxListBox)
FilterStyle

Gets the style settings which define a filtering area appearance in the list box.

(Inherited from ASPxListBox)
FilteringSettings

Gets the editor's filtering settings.

(Inherited from ASPxListBox)
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 ASPxListEdit)
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 Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from Control)
HasSampleItem

For internal use only.

(Inherited from ASPxListBox)
Height

Gets or sets the height of the web server control.

(Inherited from ASPxWebControl)
HideFilterImage

Gets the settings of an image displayed within the list box's filter button that hides the filter.

(Inherited from ASPxListBox)
HideFilterRtlImage

Gets the settings of an image displayed within the list box's filter button that hides the filter when the list box is in RTL mode.

(Inherited from ASPxListBox)
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)
ID Gets or sets the programmatic identifier assigned to the server control.
(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)
IdSeparator 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 ASPxListEdit)
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 Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control)
IsRendering

For internal use only.

(Inherited from ASPxWebControlBase)
IsTrackingViewState 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 Gets a value indicating whether view state is enabled for this control.
(Inherited from Control)
ItemImage

Gets the settings of a common image which is displayed by all the items within the editor.

(Inherited from ASPxListBox)
ItemStyle

Gets the style settings for all items within the editor.

(Inherited from ASPxListBox)
ItemTemplate

Gets or sets a common template used for displaying the content of all items within the list box.

(Inherited from ASPxListBox)
Items

Gets the collection of items in the list editor.

(Inherited from ASPxListEdit)
JSProperties

Enables you to supply any server data that can then be parsed on the client.

(Inherited from ASPxEditBase)
LoadViewStateByID Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(Inherited from Control)
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 list box.

(Inherited from ASPxListBox)
LoadingPanelImage

Gets the settings of an image displayed within a Loading Panel.

(Inherited from ASPxListBox)
LoadingPanelImagePosition

Obsolete. Gets or sets the position of an image displayed within a loading panel.

(Inherited from ASPxListBox)
LoadingPanelStyle

Gets the style settings used to paint the Loading Panel.

(Inherited from ASPxListBox)
LoadingPanelText

Obsolete. Gets or sets the text to be displayed within a loading panel while waiting for a callback response.

(Inherited from ASPxListBox)
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)
Native

Gets or sets a value specifying whether the ASPxListBox control is rendered as a native HTML list box element.

(Inherited from ASPxListBox)
NativeCheckBoxes

Gets or sets a value specifying whether check boxes are rendered as native HTML check box elements within the ASPxListBox control.

(Inherited from ASPxListBox)
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)
PostDataLoading

For internal use only.

(Inherited from ASPxWebControl)
PreRendered

For internal use only.

(Inherited from ASPxWebControlBase)
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 ASPxEdit)
ReadOnlyStyle

Gets style settings for the read-only editor state.

(Inherited from ASPxEdit)
RenderingCompatibility Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from Control)
Request

For internal use only.

(Inherited from ASPxWebControl)
Response

For internal use only.

(Inherited from ASPxWebControl)
RightToLeft

Gets or sets a value specifying whether or not the current control supports right-to-left representation.

(Inherited from ASPxListBox)
RootStyle

Gets the style settings defining the appearance of an editor container.

(Inherited from ASPxEditBase)
Rows

Gets or sets the number of rows displayed within the editor when it's used in native mode.

(Inherited from ASPxListBox)
SelectAllStyle

Gets the style settings that define the appearance of the list box's "Select All" element.

(Inherited from ASPxListBox)
SelectAllText

Gets or sets the text (or tooltip) for the "Select All" check box in a list box.

(Inherited from ASPxListBox)
SelectedIndex

Gets or sets the selected list item's index.

(Inherited from ASPxListEdit)
SelectedIndices

Gets the collection of the selected items' indexes within the list box.

(Inherited from ASPxListBox)
SelectedItem

Gets or sets the editor's selected list item.

(Inherited from ASPxListEdit)
SelectedItems

Gets the collection of selected items within the list box.

(Inherited from ASPxListBox)
SelectedValues

Gets the collection of selected item values within the list box.

(Inherited from ASPxListBox)
SelectionMode

Gets or sets a value that specifies item selection behavior.

(Inherited from ASPxListBox)
SettingsLoadingPanel

Provides access to the loading panel settings.

(Inherited from ASPxListBox)
ShadowImage static

Obsolete. Gets the shadow image properties.

(Inherited from ASPxWebControl)
ShowLoadingPanel

Obsolete. Gets or sets whether the loading panel can be displayed.

(Inherited from ASPxListBox)
ShowLoadingPanelImage

Obsolete. Specifies whether or not the image can be displayed within a loading panel while waiting for a callback response.

(Inherited from ASPxListBox)
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.

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)
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)
TabIndex Gets or sets the tab index of the Web server control.
(Inherited from WebControl)
TagKey Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
(Inherited from WebControl)
TagName 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)
TextField

Gets or sets the data source field that provides display texts for the editor's items.

(Inherited from ASPxListEdit)
Theme

Gets or sets the name of the Theme to be applied to the control.

(Inherited from ASPxWebControl)
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 list box's validation settings.

Value

Gets or sets the editor's value.

(Inherited from ASPxListBox)
ValueField

Gets or sets the data source field that provides values for the editor's items.

(Inherited from ASPxListEdit)
ValueType

Gets the data type of the editor's values.

(Inherited from ASPxListEdit)
ViewState 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 Gets a value that indicates whether the StateBag object is case-insensitive.
(Inherited from Control)
ViewStateLoading

For internal use only.

(Inherited from ASPxWebControl)
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 width of the web server control.

(Inherited from ASPxWebControl)
See Also