Back to Devexpress

ASPxMenu Properties

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

latest52.2 KB
Original Source

ASPxMenu Properties

A menu control.

NameDescription
AccessibilityCompliantEnables accessibility support. Inherited from ASPxMenuBase.
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.
AdaptiveMenuImageGets the settings of an image displayed in an adaptive menu, when it contains hidden items.
AllowSelectItemGets or sets a value specifying whether items can be selected within the menu. Inherited from ASPxMenuBase.
AppearAfterGets or sets the delay in displaying submenus within the menu. Inherited from ASPxMenuBase.
ApplyItemStyleToTemplatesGets or sets a value that specifies whether the styles defined for menu items can be applied to templated menu items. Inherited from ASPxMenuBase.
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 for specific predefined user actions. Inherited from ASPxMenuBase.
AutoSeparatorsGets or sets a value that specifies the manner in which a specific separator is displayed to separate menu items from each other. Inherited from ASPxMenuBase.
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.
BorderBetweenItemAndSubMenuGets or sets a value that specifies how the border is displayed between a menu item and its submenu. Inherited from ASPxMenuBase.
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.
ChildControlsCreated protectedGets a value that indicates whether the server control’s child controls have been created. Inherited from Control.
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.
ClientInstanceNameGets or sets the ASPxMenuBase‘s client programmatic identifier. Inherited from ASPxMenuBase.
ClientSideEventsGets an object that lists the client-side events specific to the menu. Inherited from ASPxMenuBase.
ClientVisibleGets or sets a value that specifies the initial visibility state of a web control on the client.
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 ASPxWebControlBase.
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 web control’s appearance. Inherited from ASPxWebControl.
CssPostfixGets or sets a CSS class name postfix that identifies style settings to be applied to the control. Inherited from ASPxWebControl.
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.
DataSourceSpecifies the object from which the data-bound control retrieves its data items. Inherited from ASPxDataWebControlBase.
DataSourceIDGets or sets the ID of the control from which the data-bound control retrieves its list of data items. Inherited from ASPxHierarchicalDataWebControl.
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.
DisappearAfterGets or sets the duration after which a dynamic menu (a menu item’s submenu or a popup menu) disappears when the mouse pointer is no longer positioned over the menu. Inherited from ASPxMenuBase.
EmptyImage staticObsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
EnableAnimationGets or sets a value that specifies whether a specific animation effect is used when invoking/hiding submenus. Inherited from ASPxMenuBase.
EnableCallbackCompressionGets or sets whether callback result compression is enabled. Inherited from ASPxMenuBase.
EnableCallBacksGets or sets a value that specifies how and when the menu’s submenu items are loaded. Inherited from ASPxMenuBase.
EnableClientSideAPIGets or sets a value that specifies whether the menu can be manipulated on the client side via code. Inherited from ASPxMenuBase.
EnabledGets or sets a value that indicates whether a web control is enabled, allowing it to respond to user interactions. Inherited from ASPxWebControl.
EnableDefaultAppearanceObsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
EnableHotTrackGets or sets a value that specifies whether menu items can visually respond to mouse hovering. Inherited from ASPxMenuBase.
EnableSubMenuFullWidthGets or sets whether a sub-menu is displayed with full page width.
EnableSubMenuScrollingGets or sets a value indicating whether submenu scrolling is enabled in the menu.
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 value and content. Inherited from ASPxWebControl.
Events protectedGets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
FirstSubMenuDirectionGets or sets the direction in which the first sub-menu appears.
FontGets the font properties associated with the Web server control. Inherited from WebControl.
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.
GutterBackgroundImageGets a gutter‘s background image. Inherited from ASPxMenuBase.
GutterColorObsolete. Gets the menu gutter’s color. Inherited from ASPxMenuBase.
GutterCssClassGets or sets the name of the cascading style sheet (CSS) class that defines a root menu gutter‘s style settings. Inherited from ASPxMenuBase.
GutterImageSpacingObsolete. Gets or sets the amount of space between the menu gutter’s image and the text contents within a menu item. Inherited from ASPxMenuBase.
GutterWidthGets or sets a root menu gutter‘s width. Inherited from ASPxMenuBase.
HamburgerButtonCssClassGets or sets the name of the cascading style sheet (CSS) class that defines a hamburger button’s style settings.
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.
HeightGets or sets the height of the web server control. Inherited from ASPxWebControl.
HorizontalAlignGets or sets the horizontal alignment of menu items.
HorizontalPopOutImageGets the settings of a pop-out image displayed in a horizontally oriented menu. Inherited from ASPxMenuBase.
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 the control. Inherited from ASPxMenuBase.
ImageUrlFieldGets or sets the name of a data field (or an xml element’s attribute) which provides URLs for images displayed within menu items. Inherited from ASPxMenuBase.
InitializedGets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase.
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.
IsContentCallback staticGets a value that specifies whether a callback was sent by a menu. Inherited from ASPxMenuBase.
IsTrackingViewState protectedGets a value that indicates whether the server control is saving changes to its view state. Inherited from Control.
IsViewStateEnabled protectedGets a value indicating whether view state is enabled for this control. Inherited from Control.
ItemAutoWidthGets or sets a value that specifies whether root item widths are calculated automatically, so that root items are resized (stretched or shrinked) proportionally to the menu control’s width.
ItemImageGets the settings of a common image displayed by all the root menu items. Inherited from ASPxMenuBase.
ItemImagePositionGets or sets a value that specifies how item images are positioned within the menu’s root items.
ItemLinkModeGets or sets a value that specifies how menu items are represented as links within the menu. Inherited from ASPxMenuBase.
ItemsGets a collection that contains menu items of the menu’s root level. Inherited from ASPxMenuBase.
ItemSpacingGets or sets the amount of space between the menu items of the root menu level. Inherited from ASPxMenuBase.
ItemStyleGets the style settings for all menu items of the menu control’s root level. Inherited from ASPxMenuBase.
ItemSubMenuOffsetGets specific offset settings for submenus of the submenu items. Inherited from ASPxMenuBase.
ItemTemplateGets or sets a common template used for displaying the content of all menu items within a menu control. Inherited from ASPxMenuBase.
ItemTextTemplateGets or sets a common template used for displaying the text content of all menu items within a menu control. Inherited from ASPxMenuBase.
ItemWrapGets or sets a value that specifies whether the menu items can be wrapped.
JSPropertiesEnables you to supply any server data that can then be parsed on the client. Inherited from ASPxMenuBase.
LinkStyleGets an object that contains style settings to be applied to links in a menu control. Inherited from ASPxMenuBase.
LoadedIndicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase.
LoadingPanelImageGets the settings of an image to be displayed within a specific loading panel while waiting for a callback response. Inherited from ASPxMenuBase.
LoadingPanelImagePositionObsolete. Gets or sets the position of an image displayed within a loading panel. Inherited from ASPxMenuBase.
LoadingPanelStyleGets the style settings of a specific loading panel displayed as a submenu’s content while waiting for a callback response. Inherited from ASPxMenuBase.
LoadingPanelTextObsolete. Gets or sets the text to be displayed within a loading panel while waiting for a callback response. Inherited from ASPxMenuBase.
LoadViewStateByID protectedGets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control.
MaximumDisplayLevelsGets or sets the number of menu levels to render. Inherited from ASPxMenuBase.
NameFieldGets or sets the name of a data field (or an xml element’s attribute) which provides menu item unique identifier names. Inherited from ASPxMenuBase.
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.
NavigateUrlFieldGets or sets the name of a data field (or an xml element’s attribute) which provides menu item navigation locations. Inherited from ASPxMenuBase.
NavigateUrlFormatStringGets or sets the pattern used to format item navigation URLs. Inherited from ASPxMenuBase.
OpacityGets or sets the opacity level of popup menus within the control. Inherited from ASPxMenuBase.
OrientationGets or sets the direction in which to render the menu.
PaddingsGets the padding settings of a menu control. Inherited from ASPxMenuBase.
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 ASPxWebControl class. Inherited from ASPxWebControl.
ParentStylesThis property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
RenderIFrameForPopupElementsGets or sets a value that specifies whether submenu pop-ups are displayed above Java applets that may be present on the web page. Inherited from ASPxMenuBase.
RenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
RenderModeObsolete. Gets or sets a value that specifies the render mode of the menu elements. Inherited from ASPxMenuBase.
RightToLeftSpecifies whether to apply right-to-left representation to the control. Inherited from ASPxMenuBase.
RootItemGets the root item of the menu. Inherited from ASPxMenuBase.
RootItemSubMenuOffsetGets specific offset settings for submenus of the root menu items. Inherited from ASPxMenuBase.
RootItemTemplateGets or sets a common template used for displaying the content of all root items within a menu control. Inherited from ASPxMenuBase.
RootItemTextTemplateGets or sets a common template used for displaying the text content of all root menu items within a menu control. Inherited from ASPxMenuBase.
ScrollButtonStyleGets the style settings that define the appearance of scroll buttons. Inherited from ASPxMenuBase.
ScrollDownButtonImageGets the settings which define an image, displayed within scroll down buttons. Inherited from ASPxMenuBase.
ScrollUpButtonImageGets the settings which define an image, displayed within scroll up buttons. Inherited from ASPxMenuBase.
SelectedItemGets or sets the selected menu item within a menu control. Inherited from ASPxMenuBase.
SelectParentItemGets or sets whether a root menu item is displayed selected when selecting any of its subitems. Inherited from ASPxMenuBase.
SeparatorBackgroundImageGets a separator‘s background image. Inherited from ASPxMenuBase.
SeparatorColorGets or sets a separator‘s color. Inherited from ASPxMenuBase.
SeparatorCssClassGets or sets the name of the cascading style sheet (CSS) class that defines a separator style settings. Inherited from ASPxMenuBase.
SeparatorHeightGets or sets a separator‘s height. Inherited from ASPxMenuBase.
SeparatorPaddingsGets the padding settings of separators. Inherited from ASPxMenuBase.
SeparatorWidthGets or sets a separator‘s width. Inherited from ASPxMenuBase.
SettingsAdaptivityProvides access to the menu layout adaptivity settings.
SettingsLoadingPanelProvides access to the loading panel settings. Inherited from ASPxMenuBase.
ShadowImage staticObsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
ShowAsToolbarSpecifies whether a menu is displayed as a toolbar.
ShowLoadingPanelObsolete. Gets or sets whether the loading panel can be displayed. Inherited from ASPxMenuBase.
ShowLoadingPanelImageObsolete. Specifies whether or not the image can be displayed within a loading panel while waiting for a callback response. Inherited from ASPxMenuBase.
ShowPopOutImagesGets or sets a value specifying whether pop-out images that indicate that a menu item has a submenu are displayed. Inherited from ASPxMenuBase.
ShowSubMenuShadowGets or sets a value that specifies whether a submenu casts a shadow. Inherited from ASPxMenuBase.
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 ASPxMenuBase.
SpriteImageUrlGets or sets the path to a sprite image. Inherited from ASPxMenuBase.
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.
SubMenuItemImageGets the settings of an image displayed by all submenu items. Inherited from ASPxMenuBase.
SubMenuItemStyleGets the style settings for all submenu items within the current menu control. Inherited from ASPxMenuBase.
SubMenuStyleGets the style settings for the client regions of all submenus within the current menu control. Inherited from ASPxMenuBase.
SubMenuTemplateGets or sets a common template used for displaying the client region’s content of all submenus within a menu control. Inherited from ASPxMenuBase.
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.
SyncSelectionModeGets or sets whether the menu item, whose navigation location points to the currently browsed web page, is automatically selected. Inherited from ASPxMenuBase.
SyncSelectionWithCurrentPathObsolete. Gets or sets whether the menu item, whose navigation location points to the currently browsed web page, is automatically selected. Inherited from ASPxMenuBase.
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.
TargetGets or sets the window or frame at which to target the contents of the URLs associated with all links within a menu. Inherited from ASPxMenuBase.
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 name of a data field (or an xml element’s attribute) which provides menu item texts. Inherited from ASPxMenuBase.
TextFormatStringGets or sets the pattern used to format menu item texts. Inherited from ASPxMenuBase.
TextIndentGets or sets the amount of space between an item‘s left border and text. Inherited from ASPxMenuBase.
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.
ToolTipFieldGets or sets the name of a data field (or an xml element’s attribute) which provides menu item tooltip texts. Inherited from ASPxMenuBase.
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.
VerticalAlignGets or sets the vertical alignment of menu items.
VerticalPopOutImageGets the settings of a pop-out image displayed in a vertically oriented menu. Inherited from ASPxMenuBase.
VerticalPopOutRtlImageGets the settings of a pop-out image displayed in a vertically oriented menu, when the right-to-left layout is applied. Inherited from ASPxMenuBase.
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 that indicates whether a server control is rendered as UI on the page. Inherited from Control.
WidthGets or sets the width of the web server control. Inherited from ASPxWebControl.

See Also

ASPxMenu Class

ASPxMenu Members

DevExpress.Web Namespace