Class RadNavigationView

Represents a control that has a collection of pages and displays one page at a time. The control supports hierarchy and its style is similar to the Windows Navigation View.

Inheritance
System.Object
RadControl
RadNonClientUIControl
RadNCEnabledControl
RadPageView
RadNavigationView
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Containers")]
public class RadNavigationView : RadPageView, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadNavigationView()

Declaration
public RadNavigationView()

Properties

CollapsedGlyph

Gets or sets the glyph used for the items's expander element, when the item IsExpanded property is false.

Declaration
public string CollapsedGlyph { get; set; }
Property Value
System.String

CollapsedPaneWidth

Gets or sets the width of the pane with the items when the view element is collapsed.

Declaration
public int CollapsedPaneWidth { get; set; }
Property Value
System.Int32

CompactModeThresholdWidth

Gets or sets a threshold determining at what width the view element will change from Collapsed to Compact display mode and vice versa.

Declaration
public int CompactModeThresholdWidth { get; set; }
Property Value
System.Int32

DisplayMode

Gets or sets the display mode of the view element.

Declaration
public NavigationViewDisplayModes DisplayMode { get; set; }
Property Value
NavigationViewDisplayModes

EnableUIAutomation

Declaration
public virtual bool EnableUIAutomation { get; set; }
Property Value
System.Boolean

ExpandedGlyph

Gets or sets the glyph used for the items's expander element, when the item IsExpanded property is true.

Declaration
public string ExpandedGlyph { get; set; }
Property Value
System.String

ExpandedModeThresholdWidth

Gets or sets a threshold determining at what width the view element will change from Expanded to Collapsed display mode and vice versa.

Declaration
public int ExpandedModeThresholdWidth { get; set; }
Property Value
System.Int32

ExpandedPaneWidth

Gets or sets the width of the pane with the items when the view element is expanded.

Declaration
public int ExpandedPaneWidth { get; set; }
Property Value
System.Int32

HeaderHeight

Gets or sets the height of the header element.

Declaration
public int HeaderHeight { get; set; }
Property Value
System.Int32

HierarchyIndent

Gets or sets the hierarchical indentation of the child items.

Declaration
public int HierarchyIndent { get; set; }
Property Value
System.Int32

HierarchyPopupExpandMode

Gets or sets the expand/collapse mode of navigation items when they have hierarchical children.

Declaration
public NavigationViewHierarchyPopupExpandMode HierarchyPopupExpandMode { get; set; }
Property Value
NavigationViewHierarchyPopupExpandMode

ItemDragMode

Gets or sets the mode that controls item drag operation within the element.

Declaration
public PageViewItemDragMode ItemDragMode { get; set; }
Property Value
PageViewItemDragMode

ItemExpandCollapseMode

Gets or sets the expand/collapse mode of navigation items when they have hierarchical children.

Declaration
public NavigationViewItemExpandCollapseMode ItemExpandCollapseMode { get; set; }
Property Value
NavigationViewItemExpandCollapseMode

NavigationViewElement

Gets the RadPageViewNavigationViewElement, which is the main element for RadNavigationView.

Declaration
public RadPageViewNavigationViewElement NavigationViewElement { get; }
Property Value
RadPageViewNavigationViewElement

ThemeClassName

Gets the theme class name, which is used in the themes.

Declaration
public override string ThemeClassName { get; set; }
Property Value
System.String

Overrides

ViewElement

Use NavigationViewElement instead.

Declaration
public override RadPageViewElement ViewElement { get; }
Property Value
RadPageViewElement

Overrides

ViewMode

This property is not relevant for this class.

Declaration
public override PageViewMode ViewMode { get; set; }
Property Value
PageViewMode

Overrides

Methods

AddFooterItem(RadPageViewItem)

Adds an item to the footer area.

Declaration
public void AddFooterItem(RadPageViewItem item)
Parameters
RadPageViewItem item

The item to be pinned at the footer.

AddFooterPage(RadPageViewPage)

Adds a page to the footer area.

Declaration
public void AddFooterPage(RadPageViewPage page)
Parameters
RadPageViewPage page

The page to be pinned at the footer.

AddHeaderItem(RadPageViewItem)

Adds an item to the header area.

Declaration
public void AddHeaderItem(RadPageViewItem item)
Parameters
RadPageViewItem item

The item to be pinned at the header.

AddHeaderPage(RadPageViewPage)

Adds a page to the header area.

Declaration
public void AddHeaderPage(RadPageViewPage page)
Parameters
RadPageViewPage page

The page to be pinned at the header.

Collapse()

Collapses the NavigationView.

Declaration
public virtual void Collapse()

CreateNavigationViewElement()

Creates a RadPageViewNavigationViewElement, which is the main element for RadNavigationView.

Declaration
protected virtual RadPageViewNavigationViewElement CreateNavigationViewElement()
Returns
RadPageViewNavigationViewElement

CreateUI()

Use the CreateNavigationViewElement() method instead.

Declaration
protected override RadPageViewElement CreateUI()
Returns
RadPageViewElement

Overrides

CreateUIAutomationProvider()

Declaration
protected virtual IRawElementProviderFragmentRoot CreateUIAutomationProvider()
Returns
System.Windows.Automation.Provider.IRawElementProviderFragmentRoot

Expand()

Expands the NavigationView.

Declaration
public virtual void Expand()

OnEnabledChanged(EventArgs)

Declaration
protected override void OnEnabledChanged(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnPageAdded(RadPageViewEventArgs)

Declaration
protected override void OnPageAdded(RadPageViewEventArgs e)
Parameters
RadPageViewEventArgs e

Overrides

OnPageCollapsed(RadPageViewEventArgs)

This method is not relevant for this class.

Declaration
protected override void OnPageCollapsed(RadPageViewEventArgs e)
Parameters
RadPageViewEventArgs e

Overrides

OnPageCollapsing(RadPageViewCancelEventArgs)

This method is not relevant for this class.

Declaration
protected override void OnPageCollapsing(RadPageViewCancelEventArgs e)
Parameters
RadPageViewCancelEventArgs e

Overrides

OnPageExpanded(RadPageViewEventArgs)

This method is not relevant for this class.

Declaration
protected override void OnPageExpanded(RadPageViewEventArgs e)
Parameters
RadPageViewEventArgs e

Overrides

OnPageExpanding(RadPageViewCancelEventArgs)

This method is not relevant for this class.

Declaration
protected override void OnPageExpanding(RadPageViewCancelEventArgs e)
Parameters
RadPageViewCancelEventArgs e

Overrides

OnPageRemoved(RadPageViewEventArgs)

Declaration
protected override void OnPageRemoved(RadPageViewEventArgs e)
Parameters
RadPageViewEventArgs e

Overrides

OnPagesCleared(EventArgs)

Declaration
protected override void OnPagesCleared(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnViewModeChanged(RadPageViewModeEventArgs)

This method is not relevant for this class.

Declaration
protected override void OnViewModeChanged(RadPageViewModeEventArgs e)
Parameters
RadPageViewModeEventArgs e

Overrides

OnViewModeChanging(RadPageViewModeChangingEventArgs)

This method is not relevant for this class.

Declaration
protected override void OnViewModeChanging(RadPageViewModeChangingEventArgs e)
Parameters
RadPageViewModeChangingEventArgs e

Overrides

PinItem(RadPageViewItem, NavigationViewItemPinPosition)

Pins the item into the specified pin position.

Declaration
public void PinItem(RadPageViewItem item, NavigationViewItemPinPosition position)
Parameters
RadPageViewItem item

The item that will be pinned.
NavigationViewItemPinPosition position

The pin position.

PinPage(RadPageViewPage, NavigationViewItemPinPosition)

Pins the page item into the specified pin position.

Declaration
public void PinPage(RadPageViewPage page, NavigationViewItemPinPosition position)
Parameters
RadPageViewPage page

The page whose item will be pinned.
NavigationViewItemPinPosition position

The pin position.

UnpinItem(RadPageViewItem)

Unpins a page item.

Declaration
public void UnpinItem(RadPageViewItem item)
Parameters
RadPageViewItem item

The item to be unpinned.

UnpinPage(RadPageViewPage)

Unpins a page item.

Declaration
public void UnpinPage(RadPageViewPage page)
Parameters
RadPageViewPage page

The page to be unpinned.

WndProc(ref Message)

Declaration
protected override void WndProc(ref Message m)
Parameters
System.Windows.Forms.Message m

Overrides

Events

Collapsed

Occurs before the hamburger menu is collapsed.

Declaration
public event EventHandler Collapsed
Event Type
System.EventHandler

Collapsing

Occurs before the hamburger menu is collapsed.

Declaration
public event CancelEventHandler Collapsing
Event Type
System.ComponentModel.CancelEventHandler

Expanded

Occurs after the hamburger menu is expanded.

Declaration
public event EventHandler Expanded
Event Type
System.EventHandler

Expanding

Occurs before the hamburger menu is expanded.

Declaration
public event CancelEventHandler Expanding
Event Type
System.ComponentModel.CancelEventHandler

ItemClicked

Occurs after a navigation item click.

Declaration
public event EventHandler ItemClicked
Event Type
System.EventHandler

ItemCollapsed

Occurs after a hierarchical navigation item is collapsed.

Declaration
public event EventHandler ItemCollapsed
Event Type
System.EventHandler

ItemCollapsing

Occurs before a hierarchical navigation item is collapsed.

Declaration
public event CancelEventHandler ItemCollapsing
Event Type
System.ComponentModel.CancelEventHandler

ItemExpanded

Occurs after a hierarchical navigation item is expanded.

Declaration
public event EventHandler ItemExpanded
Event Type
System.EventHandler

ItemExpanding

Occurs before a hierarchical navigation item is expanded.

Declaration
public event CancelEventHandler ItemExpanding
Event Type
System.ComponentModel.CancelEventHandler

ItemPopupClosed

Occurs after a hierarchy popup associated with a RadPageViewNavigationViewItem has closed. The actual item is passed as the sender in the event handler.

Declaration
public event EventHandler ItemPopupClosed
Event Type
System.EventHandler

ItemPopupClosing

Occurs before a hierarchy popup associated with a RadPageViewNavigationViewItem closes. The actual item is passed as the sender in the event handler.

Declaration
public event CancelEventHandler ItemPopupClosing
Event Type
System.ComponentModel.CancelEventHandler

ItemPopupOpened

Occurs after a hierarchical popup associated with a RadPageViewNavigationViewItem has opened. The actual item is passed as the sender in the event handler.

Declaration
public event EventHandler ItemPopupOpened
Event Type
System.EventHandler

ItemPopupOpening

Occurs before a hierarchical popup associated with a RadPageViewNavigationViewItem opens. The actual item is passed as the sender in the event handler.

Declaration
public event CancelEventHandler ItemPopupOpening
Event Type
System.ComponentModel.CancelEventHandler

PageCollapsed

This event is not relevant for this class.

Declaration
public override event EventHandler<RadPageViewEventArgs> PageCollapsed
Event Type
System.EventHandler<RadPageViewEventArgs>

Overrides

PageCollapsing

This event is not relevant for this class.

Declaration
public override event EventHandler<RadPageViewCancelEventArgs> PageCollapsing
Event Type
System.EventHandler<RadPageViewCancelEventArgs>

Overrides

PageExpanded

This event is not relevant for this class.

Declaration
public override event EventHandler<RadPageViewEventArgs> PageExpanded
Event Type
System.EventHandler<RadPageViewEventArgs>

Overrides

PageExpanding

This event is not relevant for this class.

Declaration
public override event EventHandler<RadPageViewCancelEventArgs> PageExpanding
Event Type
System.EventHandler<RadPageViewCancelEventArgs>

Overrides

ViewModeChanged

This event is not relevant for this class.

Declaration
public override event EventHandler<RadPageViewModeEventArgs> ViewModeChanged
Event Type
System.EventHandler<RadPageViewModeEventArgs>

Overrides

ViewModeChanging

This event is not relevant for this class.

Declaration
public override event EventHandler<RadPageViewModeChangingEventArgs> ViewModeChanging
Event Type
System.EventHandler<RadPageViewModeChangingEventArgs>

Overrides

Extension Methods