ClassRadNavigationView
Represents a navigation control with a collection of pages that displays one page at a time, featuring hierarchical support and a Windows Navigation View-style interface including hamburger menu functionality.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Containers")]
public class RadNavigationView : RadPageView, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadNonClientUIControlRadNCEnabledControlRadPageViewRadNavigationView
Implements:
Inherited Members
Constructors
RadNavigationView()
Initializes a new instance of the RadNavigationView class with NavigationView mode.
Declaration
public RadNavigationView()
Properties
CollapsedGlyph
Gets or sets the glyph icon displayed for navigation item expander elements when the item is in collapsed state.
CollapsedPaneWidth
Gets or sets the width of the navigation pane when the view is in collapsed display mode.
CompactModeThresholdWidth
Gets or sets the width threshold that determines when the navigation view automatically switches between Collapsed and Compact display modes.
DisplayMode
Gets or sets the display mode of the navigation view, controlling how the navigation pane appears (Expanded, Compact, Minimal, or Auto).
Declaration
public NavigationViewDisplayModes DisplayMode { get; set; }
Property Value
EnableUIAutomation
Gets or sets a value indicating whether UI Automation functionality is enabled for this navigation view control, allowing accessibility tools to interact with it.
Declaration
public override bool EnableUIAutomation { get; set; }
Property Value
Overrides
ExpandedGlyph
Gets or sets the glyph icon displayed for navigation item expander elements when the item is in expanded state.
ExpandedModeThresholdWidth
Gets or sets the width threshold that determines when the navigation view automatically switches between Expanded and Collapsed display modes.
Declaration
public int ExpandedModeThresholdWidth { get; set; }
Property Value
ExpandedPaneWidth
Gets or sets the width of the navigation pane when the view is in expanded display mode.
HeaderHeight
Gets or sets the height of the header area at the top of the navigation view in pixels.
HierarchyIndent
Gets or sets the indentation amount in pixels for child navigation items to create a visual hierarchy.
HierarchyPopupExpandMode
Gets or sets the expand mode for hierarchical popup menus that appear when hovering over or clicking navigation items with children.
Declaration
public NavigationViewHierarchyPopupExpandMode HierarchyPopupExpandMode { get; set; }
Property Value
ItemDragMode
Gets or sets the drag operation mode for navigation items, controlling how items can be dragged within the navigation view.
Declaration
public PageViewItemDragMode ItemDragMode { get; set; }
Property Value
ItemExpandCollapseMode
Gets or sets the expand and collapse behavior mode for navigation items that contain hierarchical children.
Declaration
public NavigationViewItemExpandCollapseMode ItemExpandCollapseMode { get; set; }
Property Value
NavigationViewElement
Gets the main RadPageViewNavigationViewElement that contains the navigation view functionality and visual representation.
Declaration
public RadPageViewNavigationViewElement NavigationViewElement { get; }
Property Value
ThemeClassName
Gets or sets the theme class name used for applying themes to this control. Returns the theme class name of RadPageView.
Declaration
public override string ThemeClassName { get; set; }
Property Value
Overrides
Methods
AddFooterItem(RadPageViewItem)
Adds a navigation item to the footer area of the navigation view.
Declaration
public void AddFooterItem(RadPageViewItem item)
Parameters
item
The navigation item to be added to the footer
AddFooterPage(RadPageViewPage)
Adds a page's navigation item to the footer area of the navigation view.
Declaration
public void AddFooterPage(RadPageViewPage page)
Parameters
page
The page whose navigation item will be added to the footer
AddHeaderItem(RadPageViewItem)
Adds a navigation item to the header area of the navigation view.
Declaration
public void AddHeaderItem(RadPageViewItem item)
Parameters
item
The navigation item to be added to the header
AddHeaderPage(RadPageViewPage)
Adds a page's navigation item to the header area of the navigation view.
Declaration
public void AddHeaderPage(RadPageViewPage page)
Parameters
page
The page whose navigation item will be added to the header
Collapse()
Collapses the NavigationNiew, showing only icons for navigation items.
Declaration
public virtual void Collapse()
CreateNavigationViewElement()
Creates a new instance of the RadPageViewNavigationViewElement which serves as the main element for this RadNavigationView.
Declaration
protected virtual RadPageViewNavigationViewElement CreateNavigationViewElement()
Returns
RadPageViewNavigationViewElement
A new RadPageViewNavigationViewElement instance
CreateUIAutomationProvider()
Creates and returns a new UI Automation provider for this navigation view control.
Declaration
protected virtual IRawElementProviderFragmentRoot CreateUIAutomationProvider()
Returns
IRawElementProviderFragmentRoot
A new RadNavigationViewUIAutomationProvider instance
Expand()
Expands the NavigationNiew, making navigation items fully visible with text labels.
Declaration
public virtual void Expand()
OnPageAdded(RadPageViewEventArgs)
Handles the addition of a new page to the navigation view, raising UI Automation structure change events when appropriate.
Declaration
protected override void OnPageAdded(RadPageViewEventArgs e)
Parameters
e
The event arguments containing information about the added page
Overrides
OnPageRemoved(RadPageViewEventArgs)
Handles the removal of a page from the navigation view, raising UI Automation structure change events when appropriate.
Declaration
protected override void OnPageRemoved(RadPageViewEventArgs e)
Parameters
e
The event arguments containing information about the removed page
Overrides
OnPagesCleared(EventArgs)
Handles the clearing of all pages from the navigation view, raising UI Automation structure change events when appropriate.
Declaration
protected override void OnPagesCleared(EventArgs e)
Parameters
e
The event arguments
Overrides
PinItem(RadPageViewItem, NavigationViewItemPinPosition)
Pins a navigation item to the specified position in the navigation view (Header, Footer, or None).
Declaration
public void PinItem(RadPageViewItem item, NavigationViewItemPinPosition position)
Parameters
item
The navigation item to be pinned
position
The pin position where the item should be placed
PinPage(RadPageViewPage, NavigationViewItemPinPosition)
Pins a page's navigation item to the specified position in the navigation view (Header, Footer, or None).
Declaration
public void PinPage(RadPageViewPage page, NavigationViewItemPinPosition position)
Parameters
page
The page whose navigation item will be pinned
position
The pin position where the item should be placed
UnpinItem(RadPageViewItem)
Removes the pin from a navigation item, returning it to its normal position in the navigation view.
Declaration
public void UnpinItem(RadPageViewItem item)
Parameters
item
The navigation item to be unpinned
UnpinPage(RadPageViewPage)
Removes the pin from a page's navigation item, returning it to its normal position in the navigation view.
Declaration
public void UnpinPage(RadPageViewPage page)
Parameters
page
The page whose navigation item will be unpinned
WndProc(ref Message)
Processes Windows messages, handling UI Automation requests and provider lifecycle management.
Declaration
protected override void WndProc(ref Message m)
Parameters
m
The Windows message to process
Overrides
Events
Collapsed
Occurs after the hamburger menu has been collapsed.
Collapsing
Occurs before the hamburger menu is collapsed, allowing the operation to be cancelled.
Declaration
public event CancelEventHandler Collapsing
Event Value
Expanded
Occurs after the hamburger menu has been expanded.
Expanding
Occurs before the hamburger menu is expanded, allowing the operation to be cancelled.
Declaration
public event CancelEventHandler Expanding
Event Value
ItemClicked
Occurs when a navigation item is clicked by the user.
ItemCollapsed
Occurs after a hierarchical navigation item has been collapsed.
ItemCollapsing
Occurs before a hierarchical navigation item is collapsed, allowing the operation to be cancelled.
Declaration
public event CancelEventHandler ItemCollapsing
Event Value
ItemExpanded
Occurs after a hierarchical navigation item has been expanded.
ItemExpanding
Occurs before a hierarchical navigation item is expanded, allowing the operation to be cancelled.
Declaration
public event CancelEventHandler ItemExpanding
Event Value
ItemPopupClosed
Occurs after a hierarchical popup associated with a RadPageViewNavigationViewItem has closed. The navigation item is passed as the sender in the event handler.
ItemPopupClosing
Occurs before a hierarchical popup associated with a RadPageViewNavigationViewItem closes, allowing the operation to be cancelled. The navigation item is passed as the sender in the event handler.
Declaration
public event CancelEventHandler ItemPopupClosing
Event Value
ItemPopupOpened
Occurs after a hierarchical popup associated with a RadPageViewNavigationViewItem has opened. The navigation item is passed as the sender in the event handler.
ItemPopupOpening
Occurs before a hierarchical popup associated with a RadPageViewNavigationViewItem opens, allowing the operation to be cancelled. The navigation item is passed as the sender in the event handler.
Declaration
public event CancelEventHandler ItemPopupOpening
Event Value