Back to Devexpress

Menu Elements

aspnet-3576-components-site-navigation-and-layout-menu-visual-elements.md

latest10.5 KB
Original Source

Menu Elements

  • Aug 31, 2021
  • 3 minutes to read

Topics in this section describes the visual elements of menu controls from the ASPxMenu Suite. Each topic contains a screenshot and a brief overview of the element’s function.

Root Item

The Root Item represents the menu item displayed at the top level.

The table below lists the main members that affect the element’s appearance and functionality.

CharacteristicsMembers
StyleASPxMenuBase.ItemStyle, ASPxMenuBase.LinkStyle
PaddingsASPxMenuBase.Paddings
SpacingsASPxMenuBase.ItemSpacing
ImageASPxMenuBase.ItemImage
SettingsASPxMenu.ItemAutoWidth, ASPxMenuBase.RootItem, MenuItemStyleBase.Width
TemplateASPxMenuBase.RootItemTemplate, ASPxMenuBase.RootItemTextTemplate
SelectionASPxMenuBase.SelectParentItem
Gutter [1]ASPxMenuBase.GutterCssClass, ASPxMenuBase.GutterBackgroundImage, ASPxMenuBase.GutterWidth

Subitem

Subitem represents a menu item which has a parent menu item.

The table below lists the main members which affect the element’s appearance and functionality:

CharacteristicsMembers
StyleASPxMenuBase.SubMenuItemStyle, ASPxMenuBase.SubMenuStyle, MenuItem.SubMenuStyle
PositionASPxMenuBase.RootItemSubMenuOffset, ASPxMenuBase.ItemSubMenuOffset
ImageASPxMenuBase.SubMenuItemImage
GutterMenuStyle.GutterCssClass, MenuStyle.GutterBackgroundImage, MenuStyle.GutterWidth

Item Image

An Item Image represents an image that is displayed within a menu item.

The table below lists the main members that affect element appearance and functionality.

CharacteristicsMembers
SettingsASPxMenuBase.ItemImage, MenuItem.Image, MenuItem.SubMenuItemImage, ASPxMenuBase.SubMenuItemImage
Position (for root items only)ASPxMenu.ItemImagePosition
Image SpacingMenuItemStyle.ImageSpacing

Pop-Out Image

Pop-Out Image represents an image that is displayed in a menu item and indicates that this item has a submenu.

The table below lists the main members which affect the element’s appearance and functionality:

CharacteristicsMembers
VisibilityASPxMenuBase.ShowPopOutImages
Image SettingsASPxMenuBase.VerticalPopOutImage, ASPxMenuBase.HorizontalPopOutImage

Gutter

A gutter is the spacing within a menu item. A root menu gutter is the gutter displayed at the top level. The root menu gutter is displayed if the menu is vertically oriented (the ASPxMenu.Orientation property is set to Vertical ).

Note that the gutter width does not affect the position of an item image or text. Use the TextIndent property to control the text indent of an item that has no image. To control the amount of space between an image and the text content within a menu item, use the ImageSpacing property.

The table below lists the main members that affect element appearance and functionality.

CharacteristicsRoot Menu MembersSub Menu Members
Gutter Background ImageASPxMenuBase.GutterBackgroundImageMenuStyle.GutterBackgroundImage
Gutter WidthASPxMenuBase.GutterWidthMenuStyle.GutterWidth
Gutter CSS ClassASPxMenuBase.GutterCssClassMenuStyle.GutterCssClass
Image SpacingAppearanceStyle.ImageSpacing (via ASPxMenuBase.ItemStyle .ImageSpacing )via ASPxMenuBase.SubMenuItemStyle .ImageSpacing )
Text IndentASPxMenuBase.TextIndentMenuStyle.TextIndent

Separator

Separator represents the horizontal or vertical line between menu items.

The table below lists the main members which affect the element’s appearance and functionality:

CharacteristicsMembers
VisibilityASPxMenuBase.AutoSeparators
ColorASPxMenuBase.SeparatorColor
ImageASPxMenuBase.SeparatorBackgroundImage
HeightASPxMenuBase.SeparatorHeight
WidthASPxMenuBase.SeparatorWidth
PaddingsASPxMenuBase.SeparatorPaddings

Loading Panel

Loading Panel displays a custom ‘Loading…’ text and image. It notifies users that a callback is currently processing.

The table below lists the main members which affect the element’s appearance and functionality:

CharacteristicMembers
DelaySettingsLoadingPanel.Delay
VisibilitySettingsLoadingPanel.Enabled
TextSettingsLoadingPanel.Text
ImageSettingsLoadingPanel.ShowImage, SettingsLoadingPanel.ImagePosition, ASPxMenuBase.LoadingPanelImage
StyleASPxMenuBase.LoadingPanelStyle

Drop-Down Button represents a button that is located within a menu item and indicates that this item has a submenu.

The table below lists the main members which affect the element’s appearance and functionality:

CharacteristicsMembers
VisibilityMenuItem.DropDownMode
StyleMenuItemStyle.DropDownButtonStyle
SpacingMenuItemStyle.DropDownButtonSpacing

Scroll Button

Scroll Buttons appear automatically when a submenu’s content height exceeds the browser window height, and vertical scrolling is needed. Scroll buttons enable end-users to scroll items. When scrolling is not needed, the corresponding scroll buttons are hidden.

The table below lists the main members which affect the element’s appearance and functionality:

CharacteristicsControl Level MembersItem Level Members
AvailabilityASPxMenu.EnableSubMenuScrollingMenuItem.EnableScrolling
ImageASPxMenuBase.ScrollDownButtonImage, ASPxMenuBase.ScrollUpButtonImageMenuItem.ScrollDownButtonImage, MenuItem.ScrollUpButtonImage
StyleASPxMenuBase.ScrollButtonStyleMenuItem.ScrollButtonStyle

Note, that item level members override control level members.

Footnotes

  1. The root menu gutter is displayed if the menu is vertically oriented (the ASPxMenu.Orientation property is set to Vertical ).