RadNavigationView
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, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadNonClientUIControlRadNCEnabledControlRadPageViewRadNavigationView...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadNavigationView class with NavigationView mode.
public RadNavigationView()Properties
Gets or sets the glyph icon displayed for navigation item expander elements when the item is in collapsed state.
public string CollapsedGlyph { get; set; }Gets or sets the width of the navigation pane when the view is in collapsed display mode.
public int CollapsedPaneWidth { get; set; }Gets or sets the width threshold that determines when the navigation view automatically switches between Collapsed and Compact display modes.
public int CompactModeThresholdWidth { get; set; }Gets or sets the display mode of the navigation view, controlling how the navigation pane appears (Expanded, Compact, Minimal, or Auto).
public NavigationViewDisplayModes DisplayMode { get; set; }Gets or sets a value indicating whether UI Automation functionality is enabled for this navigation view control, allowing accessibility tools to interact with it.
public override bool EnableUIAutomation { get; set; }Overrides:
Gets or sets the glyph icon displayed for navigation item expander elements when the item is in expanded state.
public string ExpandedGlyph { get; set; }Gets or sets the width threshold that determines when the navigation view automatically switches between Expanded and Collapsed display modes.
public int ExpandedModeThresholdWidth { get; set; }Gets or sets the width of the navigation pane when the view is in expanded display mode.
public int ExpandedPaneWidth { get; set; }Gets or sets the height of the header area at the top of the navigation view in pixels.
public int HeaderHeight { get; set; }Gets or sets the indentation amount in pixels for child navigation items to create a visual hierarchy.
public int HierarchyIndent { get; set; }Gets or sets the expand mode for hierarchical popup menus that appear when hovering over or clicking navigation items with children.
public NavigationViewHierarchyPopupExpandMode HierarchyPopupExpandMode { get; set; }Gets or sets the drag operation mode for navigation items, controlling how items can be dragged within the navigation view.
public PageViewItemDragMode ItemDragMode { get; set; }Gets or sets the expand and collapse behavior mode for navigation items that contain hierarchical children.
public NavigationViewItemExpandCollapseMode ItemExpandCollapseMode { get; set; }Gets the main RadPageViewNavigationViewElement that contains the navigation view functionality and visual representation.
public RadPageViewNavigationViewElement NavigationViewElement { get; }Gets or sets the theme class name used for applying themes to this control. Returns the theme class name of RadPageView.
public override string ThemeClassName { get; set; }Overrides:
Methods
Adds a navigation item to the footer area of the navigation view.
public void AddFooterItem(RadPageViewItem item)The navigation item to be added to the footer
Adds a page's navigation item to the footer area of the navigation view.
public void AddFooterPage(RadPageViewPage page)The page whose navigation item will be added to the footer
Adds a navigation item to the header area of the navigation view.
public void AddHeaderItem(RadPageViewItem item)The navigation item to be added to the header
Adds a page's navigation item to the header area of the navigation view.
public void AddHeaderPage(RadPageViewPage page)The page whose navigation item will be added to the header
Collapses the NavigationNiew, showing only icons for navigation items.
public virtual void Collapse()Creates a new instance of the RadPageViewNavigationViewElement which serves as the main element for this RadNavigationView.
protected virtual RadPageViewNavigationViewElement CreateNavigationViewElement()RadPageViewNavigationViewElement
A new RadPageViewNavigationViewElement instance
Creates and returns a new UI Automation provider for this navigation view control.
protected virtual IRawElementProviderFragmentRoot CreateUIAutomationProvider()IRawElementProviderFragmentRoot
A new RadNavigationViewUIAutomationProvider instance
Expands the NavigationNiew, making navigation items fully visible with text labels.
public virtual void Expand()Handles the addition of a new page to the navigation view, raising UI Automation structure change events when appropriate.
protected override void OnPageAdded(RadPageViewEventArgs e)The event arguments containing information about the added page
Overrides:
Handles the removal of a page from the navigation view, raising UI Automation structure change events when appropriate.
protected override void OnPageRemoved(RadPageViewEventArgs e)The event arguments containing information about the removed page
Overrides:
Handles the clearing of all pages from the navigation view, raising UI Automation structure change events when appropriate.
protected override void OnPagesCleared(EventArgs e)The event arguments
Overrides:
Pins a navigation item to the specified position in the navigation view (Header, Footer, or None).
public void PinItem(RadPageViewItem item, NavigationViewItemPinPosition position)The navigation item to be pinned
positionNavigationViewItemPinPositionThe pin position where the item should be placed
Pins a page's navigation item to the specified position in the navigation view (Header, Footer, or None).
public void PinPage(RadPageViewPage page, NavigationViewItemPinPosition position)The page whose navigation item will be pinned
positionNavigationViewItemPinPositionThe pin position where the item should be placed
Removes the pin from a navigation item, returning it to its normal position in the navigation view.
public void UnpinItem(RadPageViewItem item)The navigation item to be unpinned
Removes the pin from a page's navigation item, returning it to its normal position in the navigation view.
public void UnpinPage(RadPageViewPage page)The page whose navigation item will be unpinned
Processes Windows messages, handling UI Automation requests and provider lifecycle management.
protected override void WndProc(ref Message m)The Windows message to process
Overrides:
Events
Occurs after the hamburger menu has been collapsed.
public event EventHandler CollapsedOccurs before the hamburger menu is collapsed, allowing the operation to be cancelled.
public event CancelEventHandler CollapsingOccurs after the hamburger menu has been expanded.
public event EventHandler ExpandedOccurs before the hamburger menu is expanded, allowing the operation to be cancelled.
public event CancelEventHandler ExpandingOccurs when a navigation item is clicked by the user.
public event EventHandler ItemClickedOccurs after a hierarchical navigation item has been collapsed.
public event EventHandler ItemCollapsedOccurs before a hierarchical navigation item is collapsed, allowing the operation to be cancelled.
public event CancelEventHandler ItemCollapsingOccurs after a hierarchical navigation item has been expanded.
public event EventHandler ItemExpandedOccurs before a hierarchical navigation item is expanded, allowing the operation to be cancelled.
public event CancelEventHandler ItemExpandingOccurs after a hierarchical popup associated with a RadPageViewNavigationViewItem has closed. The navigation item is passed as the sender in the event handler.
public event EventHandler ItemPopupClosedOccurs 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.
public event CancelEventHandler ItemPopupClosingOccurs after a hierarchical popup associated with a RadPageViewNavigationViewItem has opened. The navigation item is passed as the sender in the event handler.
public event EventHandler ItemPopupOpenedOccurs 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.
public event CancelEventHandler ItemPopupOpening