Infragistics(R) NetAdvantage(R) ASP.NET
WebMenu Object
E-mail your feedback on this topic.

Glossary Item Box

UltraWebMenu

The Menu object on the provides access to the control-level features of the UltraWebMenu control. A reference to a menu object can be obtained by calling igmenu_getMenuById and passing in the server side id of the control. The id of the menu is also passed as the first parameter of all menu client events.


Note: Any method or property marked with (EnhancedRendering) at the beginning of the description, is only available when EnhancedRendering is enabled on the WebMenu.

UltraWebMenu Methods

dismiss

(EnhancedRendering) Dismisses all open submenus on the page associated with this menu

getClientID

Returns the client side name of the menu, including all container prefixes if the menu is within a user control or other form of container.

getElement

Returns the main html element associated with the menu.

getItems

Returns an array of Root Menu Items.

isDrillDown

(EnhancedRendering) Returns a boolean value that is true if the menu has a WebMenuStyle of DrillDown.

isHorizontal

(EnhancedRendering) Returns a boolean value that is true if the menu has a WebMenuTarget of Horizontal.

isPopup

(EnhancedRendering) Returns a boolean value that is true if the menu has a WebMenuStyle of Popup.

isRichClient

(EnhancedRendering) Returns a boolean value that is true if the menu has a WebMenuStyle of WinClient.

isVertical

(EnhancedRendering) Returns a boolean value that is true if the menu has a WebMenuTarget of Vertical.

isWebStandard

(EnhancedRendering) Returns a boolean value that is true if the menu has a WebMenuStyle of WebStandard.

isXPClient

(EnhancedRendering) Returns a boolean value that is true if the menu has a WebMenuStyle of XPClient.


UltraWebMenu Properties

CancelPostBack

A boolean value that can be set during the processing of a client-side event to cancel a pending postback to the server.

CheckedImage

The image name used for displaying checked menu items. If no image is specified, the WebDings letter 'a' is used.

DefaultItemClass

The CSS class name used by default for items.

DisabledClass

The CSS class name used by default for items that are disabled.

Events

An object containing references to the names of JavaScript functions that will be called in response to various client-side events.

ExpandEffects

An object representing the corresponding ExpandEffects object as it exists within the UltraWebMenu server control.

HeaderClass

The CSS class name that is applied to the header area of submenus when the DrillDown style is in effect.

HideDropDowns

A boolean value that determines whether or not Select dropdown controls will be automatically hidden when submenus are being displayed.

HoverClass

The CSS class name used by default for items when the mouse is hovered over them.

LeftHandDisplay

A boolean value that determines whether or not submenus are displayed to the left of parent menus or to the right.

MenuElement

The HTML element associated with the main menu. This property should not be changed.

MenuId

The id of the main menu object within the HTML document. This property should not be changed.

MenuLoaded

A boolean value that is true or false to indicate if the menu has been completely loaded and ready for processing events or not.

MenuTarget

The type of menu that is being targeted. This property is ReadOnly and should not be changed. Values:

1 - Horizontal

2 - Vertical

3 - Popup

MergeStyles

Returns or sets a Boolean value that determines whether hover styles for items will merge with the underlying style of the item or be set to the HoverItemStyle explicitly. The default value for this property is set to true so that items that are hovered with the mouse will take on the hover attributes in addition to the normal attributes.

NeedPostBack

A boolean value that can be set during the processing of a client-side event to force a postback to the server of the page.

ScrollImageBottom

The URL of the image that will be displayed when a menu needs to be scrolled downward.

ScrollImageBottomDisabled

The URL of the image that will be displayed when a menu can be scrolled, but not in the downward direction.

ScrollImageTop

The URL of the image that will be displayed when a menu needs to be scrolled upward.

ScrollImageTopDisabled

The URL of the image that will be displayed when a menu needs to be scrolled upward.

TargetFrame

The frame used for all menu items if the TargetFrame on a menu item is not set.

TargetUrl

The URL used for all menu items if the TargetURL on a menu item is not set.

TopSelectedClass

The CSS class name used for top-level items that are selected. This property applies to menus using WebClient and XPClient WebMenuStyle and Horizontal MenuTarget settings.

UncheckedImage

The image name used for displaying unchecked menu items. If no image is specified, nothing is displayed.

UniqueId

The UniqueID of the UltraWebMenu.

WebMenuStyle

The style of menu that is being targeted. Values:

1 - WebStandard

2 - WinClient

3 - XPClient