KaxNavigationBar Class

A navigation control used for building collapsible side-menu systems and Outlook-type panels.

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.ControlsKaxNavigationBar

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 KaxNavigationBar : HierarchicalControlItemContainer, 
	IKaxNavigationItemContainer, IPostBackEventHandler

Public Class KaxNavigationBar
	Inherits HierarchicalControlItemContainer
	Implements IKaxNavigationItemContainer, IPostBackEventHandler

public ref class KaxNavigationBar : public HierarchicalControlItemContainer, 
	IKaxNavigationItemContainer, IPostBackEventHandler

type KaxNavigationBar =  
    class
        inherit HierarchicalControlItemContainer
        interface IKaxNavigationItemContainer
        interface IPostBackEventHandler
    end

The KaxNavigationBar type exposes the following members.

Constructors

	Name	Description
	KaxNavigationBar	Initializes a new instance of the KaxNavigationBar class.

Top

Methods

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

Top

Properties

	Name	Description
	AllowCollapseAllItems	Gets or sets a value indicating whether all items can be collapsed. This allows all the items to be collapsed even if the navigationbar's ExpandMode is set to SingleExpandedItem or FullExpandedItem mode.
	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 panel item starts to close.
	CookieName	Specifies the name of the cookie which should be used when PersistStateInCookie is set to true.
	DataBindings
	ExpandAnimation	Gets the settings for the animation played when an item opens.
	ExpandDelay	Gets or sets a value indicating the timeout after which a panel item starts to open.
	ExpandMode	Gets of sets a value indicating the behavior of KaxNavigationBar when an item is expanded.
	Items	Gets a KaxNavigationItemCollection object that contains the root items of the current KaxNavigationBar control.
	ItemTemplate	Gets or sets the template for displaying the items in KaxNavigationBar.
	MaxDataBindDepth	Gets or sets the maximum number of levels to bind to the KaxNavigationBar control. (Overrides HierarchicalControlItemContainerMaxDataBindDepth.)
	OnClientContextMenu	Gets or sets a value indicating the client-side event handler that is called before the browser context panel shows (after right-clicking an item).
	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 panel item is clicked.
	OnClientItemClicking	Gets or sets a value indicating the client-side event handler that is called when a panel item is clicked.
	OnClientItemCollapse	Gets or sets a value indicating the client-side event handler that is called when a group of child items collapses.
	OnClientItemExpand	Gets or sets a value indicating the client-side event handler that is called when a group of child items expands.
	OnClientItemFocus	Gets or sets a value indicating the client-side event handler that is called when a panel item gets focus.
	OnClientLoad	Gets or sets a value indicating the client-side event handler that is called after the KaxNavigationBar 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 panel item in the KaxNavigationBar control.
	OnClientMouseOver	Gets or sets a value indicating the client-side event handler that is called when the mouse moves over a panel item in the KaxNavigationBar control.
	PersistStateInCookie	Gets or sets a value indicating whether the control would persists its state between pages (expanded and selected items).
	PostBackUrl	Gets or sets the URL of the page to post to from the current page when an item from the panel is clicked. (Overrides ControlItemContainerPostBackUrl.)
	SelectedItem	Gets the selected panel item.

Top

Events

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

Top

Remarks

The KaxNavigationBar control is used to display a list of items in a Web Forms page and is often used control for building collapsible side-menu interfaces. The KaxNavigationBar control supports the following features:

Databinding that allows the control to be populated from various datasources
Programmatic access to the KaxNavigationBar object model which allows to dynamic creation of navigationbars, populate items, set properties.
Customizable appearance through built-in or user-defined skins.

Items

The KaxNavigationBar control is made up of tree of items represented by KaxNavigationItem objects. Items at the first level (level 0) are called root items. A items that has a parent item is called a child item. All root items are stored in the Items collection. Child items are stored in a parent item's Items collection.

Each item has a Text and a Value property. The value of the Text property is displayed in the KaxNavigationBar 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, a item can navigate to another Web page indicated by the NavigateUrl property.

Reference

Kettic.AspNet.Controls Namespace