dundas.controls.Menu Class

 

Inheritance Hierarchy

 
Class
   dundas.EventDisposable
      dundas.controls.FocusableControl
         dundas.controls.Menu
 

Constructors

 
  Name Description
init Initializes the control. Called during construction.
 
 

Properties

 
  Name Description
background Gets or sets the brush used to fill the background of the control.
border Gets or sets the border in the control.
controlContainer Gets the container of this control. Inherited from dundas.controls.FocusableControl.
displayFolderIds Gets or sets a value specifying what folders to show if displayType is set to dundas.controls.MenuDisplayType.FOLDER.
displayType Gets or sets a value specifying what is displayed as items in this control.
hoverDelay Gets or sets the delay in milliseconds after hovering over this adapter with a mouse before the sub-items are displayed, if any. This only applies if showItemsOnHover is set to true.
isAutoCollapseDisabled Gets or sets a value indicating whether automatic collapsing other parent's on select is disabled. By default, when another parent is selected, all other parents that are expanded will be collapsed. This option cannot be enabled if showItemsOnHover or showItemsAsPopup is set to true.
isDisabled Gets or sets whether or not this control is disabled. Inherited from dundas.controls.FocusableControl.
isDisposed Gets a value indicating whether this instance has been disposed. Inherited from dundas.EventDisposable.
isFocused Gets or sets the focused state of this control. Inherited from dundas.controls.FocusableControl.
isHorizontal Gets or sets a value indicating whether the menu should be rendered horizontally instead of vertically.
itemNavigationType Gets or sets what happens when an item is clicked on that has an associated target.
itemNavigationViewContainerId Gets or sets the ID of the view container to navigate when an item is clicked if itemNavigationType is set to dundas.controls.MenuItemNavigationType.VIEW_CONTAINER.
items Gets or sets the items displayed in the control.
itemStyles Gets or sets the item styles which style items at the specified depths. This is used when the items are being dynamically populated from the file system and styles are still used.
jQControlContainer Gets the container of this control in JQuery object. Inherited from dundas.controls.FocusableControl.
parentFocusable Gets the focusable parent of this control. Inherited from dundas.controls.FocusableControl.
showItemsAsPopup Gets or sets whether the sub-menu items, if any, are shown as a pop-up instead of inline.
showItemsOnHover Gets or sets whether the sub-menu items, if any, are shown on hover instead of on click.
uiCache Gets the UI cache table Inherited from dundas.EventDisposable.
 
 

Methods

 
  Name Description
bind Bind an event to this class object. Inherited from dundas.EventDisposable.
deactivateAll Marks all items and any sub-items as not active.
dispose Performs tasks associated with releasing resources from this object once it is unneeded. Inherited from dundas.EventDisposable.
findActive Returns the first lowest active menu item found (depth first) in each of the top-level items.
focus Put this control into focus. Inherited from dundas.controls.FocusableControl.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
getContextState Set the UI context state to be saved in dundas.UIContextFocus Inherited from dundas.controls.FocusableControl.
getMenuItemStyle Given a menu item, returns the related item style for the depth, if any.
raiseBindEvent Fire the event specified with eventName, or subscribe a handler. Inherited from dundas.EventDisposable.
refresh Refresh the control to accommodate any changes that may have occurred to the items property.
refreshItems Refreshes the items in the control with those in the specified displayFolderIds.
refreshMenuItemStyle Refreshes the menu item's so it re-draws itself with the updated style.
repopulate Creates menu items and re-populates the item array with the entries provided.
searchItems Searches all the items using the specified match function in a depth-first search.
setActive When given a menu item, will de-activate all others as in-active and activate / refresh the menu item given.
setContextState Restore this control to the state as defined. Inherited from dundas.controls.FocusableControl.
subscribe Subscribe or unsubscribe an event handler for an event. Inherited from dundas.EventDisposable.
subscribeBlurred Inherited from dundas.controls.FocusableControl.
subscribeDisposed Subscribe to the disposed event. Inherited from dundas.EventDisposable.
subscribeFocused Inherited from dundas.controls.FocusableControl.
subscribeOnce Subscribe a one time event handler for an event. Inherited from dundas.EventDisposable.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.
trigger Raise an event. Inherited from dundas.EventDisposable.
unbind Unsubscribe an event. if handler is specified, unsubscribe that handler. if no parameters are specified, unbind everything. Inherited from dundas.EventDisposable.
unbindAll unsubscribe all events. Inherited from dundas.EventDisposable.