KaxMenu Class

KaxMenu Class

A navigation control used to display a menu in a web page.

Inheritance Hierarchy

SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      System.Web.UI.WebControlsBaseDataBoundControl
        System.Web.UI.WebControlsDataBoundControl
          KaxDataBoundControl
            Kettic.AspNet.ControlsControlItemContainer
              Kettic.AspNet.ControlsHierarchicalControlItemContainer
                Kettic.AspNet.ControlsKaxMenu
                  Kettic.AspNet.ControlsKaxContextMenu

Namespace: Kettic.AspNet.Controls
Assembly: Kettic.AspNet.Controls (in Kettic.AspNet.Controls.dll) Version: 2014.4.1129.0 (2014.04.1129.0)

Syntax

C++

Copy

public class KaxMenu : HierarchicalControlItemContainer, IKaxMenuItemContainer, 
	IPostBackEventHandler

Public Class KaxMenu
	Inherits HierarchicalControlItemContainer
	Implements IKaxMenuItemContainer, IPostBackEventHandler

public ref class KaxMenu : public HierarchicalControlItemContainer, 
	IKaxMenuItemContainer, IPostBackEventHandler

type KaxMenu =  
    class
        inherit HierarchicalControlItemContainer
        interface IKaxMenuItemContainer
        interface IPostBackEventHandler
    end

The KaxMenu type exposes the following members.

Constructors

	Name	Description
	KaxMenu

Top

Methods

	Name	Description
	ClearSelectedItem	This methods clears the selected item of the current KaxMenu instance. Useful when you need to clear item selection after postback.
	FindItem	Returns the first KaxMenuItem that matches the conditions defined by the specified predicate. The predicate should returns a boolean value.
	FindItemByText(String)	Searches the KaxMenu control for the first KaxMenuItem with a Text property equal to the specified value.
	FindItemByText(String, Boolean)	Searches the KaxMenu control for the first KaxMenuItem with a Text property equal to the specified value.
	FindItemByUrl	Searches the KaxMenu control for the first Item with a NavigateUrl property equal to the specified value.
	FindItemByValue(String)	Searches the KaxMenu control for the first KaxMenuItem with a Value property equal to the specified value.
	FindItemByValue(String, Boolean)	Searches the KaxMenu control for the first KaxMenuItem with a Value property equal to the specified value.
	GetAllItems	Gets a linear list of all items in the KaxMenu control.
	LoadContentFile	Populates the KaxMenu control from external XML file. (Overrides HierarchicalControlItemContainerLoadContentFile(String).)

Top

Properties

	Name	Description
	AutoScrollMinimumHeight	The minimum available height that is needed to enable the auto-scroll.
	AutoScrollMinimumWidth	The minimum available width that is needed to enable the auto-scroll.
	ClickToOpen	Gets or sets a value indicating whether root items should open on mouse click.
	ClientChanges	Gets a list of all client-side changes (adding an item, removing an item, changing an item's property) which have occurred.
	CollapseAnimation	Gets the settings for the animation played when an item closes.
	CollapseDelay	Gets or sets a value indicating the timeout after which a menu item starts to close.
	DataBindings	Gets a collection of KaxMenuItemBinding objects that define the relationship between a data item and the menu item it is binding to.
	DefaultGroupSettings	Specifies the default settings for child item behavior.
	EnableAutoScroll	Gets or sets a value indicating if an automatic scroll is applied if the groups are larger then the screen height.
	EnableOverlay	Gets or sets a value indicating if an overlay should be rendered (only in Internet Explorer).
	EnableRootItemScroll	Gets or sets a value indicating if scroll is enabled for the root items. Width must be set for horizontal root group, Height for vertical one.
	EnableRoundedCorners	Gets or sets a value indicating whether child items should have rounded corners.
	EnableScreenBoundaryDetection	Gets or sets a value indicating whether the screen boundary detection will be applied when menu items are expanded.
	EnableSelection	Gets or sets a value indicating if the currently selected item will be tracked and highlighted.
	EnableShadows	Gets or sets a value indicating whether child items should have shadows.
	ExpandAnimation	Gets the settings for the animation played when an item opens.
	ExpandDelay	Gets or sets a value indicating the timeout after which a menu item starts to open.
	Flow	Gets or sets a value indicating the way top level items will flow.
	Items	Gets a KaxMenuItemCollection object that contains the root items of the current KaxMenu control.
	ItemTemplate	Gets or sets the template for displaying the items in KaxMenu.
	LoadingStatusTemplate	Gets or sets the template displayed when child items are being loaded.
	MaxDataBindDepth	Gets or sets the maximum number of levels to bind to the KaxMenu control. (Overrides HierarchicalControlItemContainerMaxDataBindDepth.)
	OnClientItemBlur	Gets or sets a value indicating the client-side event handler that is called after an item loses focus.
	OnClientItemClicked	Gets or sets a value indicating the client-side event handler that is called after a menu item is clicked.
	OnClientItemClicking	Gets or sets a value indicating the client-side event handler that is called when a menu item is clicked.
	OnClientItemClosed	Gets or sets a value indicating the client-side event handler that is called when a group of child items closes.
	OnClientItemClosing	Gets or sets a value indicating the client-side event handler that is called when a group of child items is closing.
	OnClientItemFocus	Gets or sets a value indicating the client-side event handler that is called when a menu item gets focus.
	OnClientItemOpened	Gets or sets a value indicating the client-side event handler that is called when a group of child items opens.
	OnClientItemOpening	Gets or sets a value indicating the client-side event handler that is called when a group of child items begin to open.
	OnClientItemPopulated	Gets or sets a value indicating the client-side event handler that is called when a menu item children were just populated (for example from web service).
	OnClientItemPopulating	Gets or sets a value indicating the client-side event handler that is called when a menu item children are about to be populated (for example from web service).
	OnClientItemPopulationFailed	Gets or sets a value indicating the client-side event handler that is called when the operation for populating the children of a menu item has failed.
	OnClientLoad	Gets or sets a value indicating the client-side event handler that is called after the KaxMenu client-side object is initialized.
	OnClientMouseOut	Gets or sets a value indicating the client-side event handler that is called when the mouse moves out of a menu item in the KaxMenu control.
	OnClientMouseOver	Gets or sets a value indicating the client-side event handler that is called when the mouse moves over a menu item in the KaxMenu control.
	PersistLoadOnDemandItems	When set to true, the items populated through Load On Demand are persisted on the server.
	PostBackUrl	Gets or sets the URL of the page to post to from the current page when a menu item is clicked. (Overrides ControlItemContainerPostBackUrl.)
	SelectedItem	Gets a KaxMenuItem object that represents the selected item in the KaxMenu control.
	SelectedValue	Gets the Value of the selected item.
	WebServiceSettings	Gets the settings for the web service used to populate items ExpandMode set to MenuItemExpandMode.WebService.

Top

Events

	Name	Description
	ItemClick	Occurs on the server when a menu item in the KaxMenu control is clicked.
	ItemCreated	Occurs on the server when an item in the KaxMenu control is created.
	ItemDataBound	Occurs after a menu item is data bound.
	TemplateNeeded	Occurs before template is being applied to the menu item.

Top

Remarks

The KaxMenu control is used to display a list of menu items in a Web Forms page. The KaxMenu control supports the following features:

Databinding that allows the control to be populated from various datasources.
Programmatic access to the KaxMenu object model which allows dynamic creation of menus, populating with items and customizing the behavior by various properties.
Customizable appearance through built-in or user-defined skins.

Items

The KaxMenu control is made up of tree of items represented by KaxMenuItem objects. Items at the top level (level 0) are called root items. An item that has a parent item is called a child item. All root items are stored in the Items property of the KaxMenu control. Child items are stored in the Items property of their parent KaxMenuItem.

Each menu item has a Text and a Value property. The value of the Text property is displayed in the KaxMenu control, while the Value property is used to store any additional data about the item, such as data passed to the postback event associated with the item. When clicked, an item can navigate to another Web page indicated by the NavigateUrl property.

Reference

Kettic.AspNet.Controls Namespace