Back to Devexpress

ASPxListBox Properties

aspnet-devexpress-dot-web-dot-aspxlistbox-dot-underscore-properties.md

latest43.3 KB
Original Source

ASPxListBox Properties

A list box control.

NameDescription
AccessibilityCompliantEnables accessibility support.
AccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl.
Adapter protectedGets the browser-specific adapter for the control. Inherited from Control.
AllowEllipsisInTextSpecifies if the list box can automatically truncate the item’s text if it doesn’t fit into the item’s width.
AppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control.
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl.
AutoPostBackGets or sets a value that specifies whether server-side processing is required to respond to specific predefined user actions. Inherited from ASPxEdit.
BackColorGets or sets the background color of the Web server control. Inherited from WebControl.
BackgroundImageGets the web control’s background image. Inherited from ASPxWebControl.
BackwardCompatibility staticProvides access to the control’s backward compatibility settings. Inherited from ASPxWebControl.
BorderGets the web control’s border settings. Inherited from ASPxWebControl.
BorderBottomGets the settings of the web control’s bottom border. Inherited from ASPxWebControl.
BorderLeftGets the settings of the web control’s left border. Inherited from ASPxWebControl.
BorderRightGets the settings of the web control’s right border. Inherited from ASPxWebControl.
BorderTopGets the settings of the web control’s top border. Inherited from ASPxWebControl.
BoundGets a value that specifies whether the control is data bound. Inherited from ASPxDataWebControlBase.
CallbackPageSizeGets or sets the number of items returned from the server on each callback request performed in response to a predefined client user action.
CaptionGets or sets the editor caption. Inherited from ASPxEditBase.
CaptionCellStyleGets the style settings that define the caption cell appearance. Inherited from ASPxEditBase.
CaptionSettingsProvides access to the editor caption settings. Inherited from ASPxEdit.
CaptionStyleGets the style settings that define the caption appearance. Inherited from ASPxEditBase.
CheckBoxCheckedImageProvides access to the settings that define the image of check boxes in the checked state within the ASPxListBox control.
CheckBoxFocusedStyleGets the style settings that define the check box appearance in the focused state within the ASPxListBox control.
CheckBoxGrayedImageProvides access to the settings that define the image of the “Select All” check box when one or more list box items are selected.
CheckBoxStyleGets the style settings that define the check box appearance within the ASPxListBox control.
CheckBoxUncheckedImageProvides access to the settings that define the image of check boxes in the unchecked state within the ASPxListBox control.
ChildControlsCreated protectedGets a value that indicates whether the server control’s child controls have been created. Inherited from Control.
ClearFilterImageGets the settings of an image displayed within the “Clear filter” button in the list box.
ClientEnabledGets or sets a value that indicates whether an editor is enabled on the client. Inherited from ASPxEditBase.
ClientIDGets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase.
ClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control.
ClientIDSeparator protectedGets a character value representing the separator character used in the ClientID property. Inherited from Control.
ClientInstanceNameSpecifies the editor’s client programmatic identifier. Inherited from ASPxEditBase.
ClientReadOnlyGets or sets whether the editor is read only on the client-side. Inherited from ASPxEdit.
ClientSideEventsGets an object that lists the client-side events specific to the ASPxListBox.
ClientVisibleGets or sets a value that specifies the initial visibility state of an editor on the client. Inherited from ASPxEditBase.
ColumnsProvides access to the editor’s column collection.
Context protectedGets the HttpContext object associated with the server control for the current Web request. Inherited from Control.
ControlsGets the web control’s collection of child controls. Inherited from ASPxEditBase.
ControlStyleGets the style of the Web server control. This property is used primarily by control developers. Inherited from WebControl.
ControlStyleCreatedGets 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.
CssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. Inherited from WebControl.
CssFilePathGets or sets the path to a CSS file that defines the editor’s appearance. Inherited from ASPxEditBase.
CssPostfixGets or sets a CSS class name postfix that identifies style settings to be applied to the editor. Inherited from ASPxEditBase.
CursorGets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl.
DataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control.
DataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control.
DataSecurityModeProvides the capability to restrict setting the editor value on the client side to values listed in the server ASPxListEdit.Items.
DataSourceGets or sets the object from which a data-bound combo box editor retrieves its list of data items. Inherited from ASPxListEdit.
DataSourceIDSpecifies the ID of the data source control from which the editor gets data items. Inherited from ASPxListEdit.
DisabledCssClass staticGets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl.
DisabledStyleGets the style settings which define a control’s appearance in the disabled state. Inherited from ASPxWebControl.
EmptyImage staticObsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
EnableCallbackModeGets or sets a value that specifies whether the editor’s list items can be loaded to the client side on demand via callbacks.
EnableClientSideAPIGets or sets a value that specifies whether the editor can be manipulated on the client side via code. Inherited from ASPxEditBase.
EnabledGets or sets a value that indicates whether the editor is enabled, allowing it to respond to end-user interactions. Inherited from ASPxEdit.
EnableDefaultAppearanceObsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
EnableFocusedStyleGets or sets a value that specifies whether an editor in a focused state is displayed with predefined style settings. Inherited from ASPxEdit.
EnableSelectAllGets or sets whether selecting all items within a list box is available.
EnableSynchronizationGets 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.
EnableThemingGets or sets a value indicating whether themes apply to this control. Inherited from WebControl.
EnableViewStateGets 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.
EncodeHtmlGets or sets whether to encode editor content.
ErrorTextGets 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 protectedGets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
FilterEditorStyleGets the style settings which define a filter editor appearance in the list box.
FilterImageGets the settings of an image displayed within the filter button in the list box.
FilteringSettingsGets the editor’s filtering settings.
FilterStyleGets the style settings which define a filtering area appearance in the list box.
FocusedStyleGets the style settings which define an editor’s appearance in the focused state. Inherited from ASPxEdit.
FontGets the font properties associated with the Web server control. Inherited from WebControl.
ForceDataBindingGets or sets a value that specifies whether the editor should be rebound to a data source automatically. Inherited from ASPxListEdit.
ForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. Inherited from WebControl.
GlobalAccessibilityCompliant staticGets 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 staticGets or sets whether links to external client scripts (such as jQuery, Knockout, and others), which are used by some DevExpress web components, are checked for presence and correctness. Inherited from ASPxWebControl.
GlobalEmbedRequiredClientLibraries staticObsolete. 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 staticGets 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 staticGets 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 staticGets 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 staticGets 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 staticGets 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.
HasAttributesGets a value indicating whether the control has attributes set. Inherited from WebControl.
HasChildViewState protectedGets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control.
HasSampleItemFor internal use only.
HeightGets or sets the height of the web server control. Inherited from ASPxWebControl.
HideFilterImageGets the settings of an image displayed within the list box’s filter button that hides the filter.
HideFilterRtlImageGets 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.
IDGets or sets the programmatic identifier assigned to the server control. Inherited from Control.
IdSeparator protectedGets the character used to separate control identifiers. Inherited from Control.
ImageFolderGets or sets the path to the folder that contains images used by an editor. Inherited from ASPxEdit.
ImageUrlFieldGets or sets the data source field that provides image locations for the editor’s items. Inherited from ASPxListEdit.
InitializedGets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase.
InvalidStyleGets the style settings which define an editor’s appearance in the invalid state. Inherited from ASPxEdit.
IsCallbackGets a value indicating whether the request is the result of a callback sent by the control. Inherited from ASPxWebControl.
IsChildControlStateCleared protectedGets a value indicating whether controls contained within this control have control state. Inherited from Control.
IsTrackingViewState protectedGets a value that indicates whether the server control is saving changes to its view state. Inherited from Control.
IsValidGets or sets a value that indicates whether the editor’s value passes validation. Inherited from ASPxEdit.
IsViewStateEnabled protectedGets a value indicating whether view state is enabled for this control. Inherited from Control.
ItemImageGets the settings of a common image which is displayed by all the items within the editor.
ItemsGets the collection of items in the list editor. Inherited from ASPxListEdit.
ItemStyleGets the style settings for all items within the editor.
ItemTemplateGets or sets a common template used for displaying the content of all items within the list box.
JSPropertiesEnables you to supply any server data that can then be parsed on the client. Inherited from ASPxEditBase.
LoadedIndicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase.
LoadingPanelDelayObsolete. Gets or sets the delay before displaying the loading panel in the list box.
LoadingPanelImageGets the settings of an image displayed within a Loading Panel.
LoadingPanelImagePositionObsolete. Gets or sets the position of an image displayed within a loading panel.
LoadingPanelStyleGets the style settings used to paint the Loading Panel.
LoadingPanelTextObsolete. Gets or sets the text to be displayed within a loading panel while waiting for a callback response.
LoadViewStateByID protectedGets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control.
NamingContainerGets 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.
NativeGets or sets a value specifying whether the ASPxListBox control is rendered as a native HTML list box element.
NativeCheckBoxesGets or sets a value specifying whether check boxes are rendered as native HTML check box elements within the ASPxListBox control.
PageGets a reference to the Page instance that contains the server control. Inherited from Control.
ParentGets a reference to the server control’s parent control in the page control hierarchy. Inherited from Control.
ParentImagesThis property is not in effect for the ASPxEditBase class. Inherited from ASPxEditBase.
ParentSkinOwnerFor internal use only. Inherited from ASPxEditBase.
ParentStylesThis property is not in effect for the ASPxEditBase class. Inherited from ASPxEditBase.
ReadOnlyGets or sets a value indicating whether an end-user can change the editor’s contents at runtime. Inherited from ASPxEdit.
ReadOnlyStyleGets style settings for the read-only editor state. Inherited from ASPxEdit.
RenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
RightToLeftSpecifies whether to apply right-to-left representation to the control.
RootStyleGets the style settings defining the appearance of an editor container. Inherited from ASPxEditBase.
RowsGets or sets the number of rows displayed within the editor when it’s used in native mode.
SelectAllStyleGets the style settings that define the appearance of the list box’s “Select All” element.
SelectAllTextGets or sets the text (or tooltip) for the “Select All” check box in a list box.
SelectedIndexSpecifies the selected list item’s index. Inherited from ASPxListEdit.
SelectedIndicesGets the collection of the selected items’ indexes within the list box.
SelectedItemGets or sets the editor’s selected list item. Inherited from ASPxListEdit.
SelectedItemsGets the collection of selected items within the list box.
SelectedValuesGets the collection of selected item values within the list box.
SelectionModeGets or sets a value that specifies item selection behavior.
SettingsLoadingPanelProvides access to the loading panel settings.
ShadowImage staticObsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
ShowLoadingPanelObsolete. Gets or sets whether the loading panel can be displayed.
ShowLoadingPanelImageObsolete. Specifies whether or not the image can be displayed within a loading panel while waiting for a callback response.
SiteGets information about the container that hosts the current control when rendered on a design surface. Inherited from Control.
SkinIDGets or sets the skin to apply to the control. Inherited from WebControl.
SpriteCssFilePathGets or sets the path to a CSS file that defines the control’s sprite image settings. Inherited from ASPxEdit.
SpriteImageUrlGets or sets the path to a sprite image. Inherited from ASPxEdit.
StyleGets 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.
SupportsDisabledAttributeGets 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.ControlBuilderFor a description of this member, see ControlBuilder. Inherited from Control.
IControlDesignerAccessor.UserDataFor a description of this member, see UserData. Inherited from Control.
IDataBindingsAccessor.DataBindingsFor a description of this member, see DataBindings. Inherited from Control.
IDataBindingsAccessor.HasDataBindingsFor a description of this member, see HasDataBindings. Inherited from Control.
IExpressionsAccessor.ExpressionsFor a description of this member, see Expressions. Inherited from Control.
IExpressionsAccessor.HasExpressionsFor a description of this member, see HasExpressions. Inherited from Control.
TabIndexGets or sets the tab index of the Web server control. Inherited from WebControl.
TagKey protectedGets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl.
TagName protectedGets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl.
TemplateControlGets or sets a reference to the template that contains this control. Inherited from Control.
TemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control.
TextFieldGets or sets the data source field that provides display texts for the editor’s items. Inherited from ASPxListEdit.
ThemeGets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl.
ToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. Inherited from WebControl.
UniqueIDGets the unique, hierarchically qualified identifier for the server control. Inherited from Control.
ValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control.
ValidationSettingsGets the editor’s validation settings. Inherited from ASPxEdit.
ValueGets or sets the editor’s value.
ValueFieldGets or sets the data source field that provides values for the editor’s items. Inherited from ASPxListEdit.
ValueTypeGets the data type of the editor’s values. Inherited from ASPxListEdit.
ViewState protectedGets 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 protectedGets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control.
ViewStateModeGets or sets the view-state mode of this control. Inherited from Control.
VisibleGets or sets a value specifying the editor’s visibility. Inherited from ASPxEdit.
WidthGets or sets the width of the web server control. Inherited from ASPxWebControl.

See Also

ASPxListBox Class

ASPxListBox Members

DevExpress.Web Namespace