skip navigation
  • Product Bundles

    DevCraft

    All Telerik .NET tools and Kendo UI JavaScript components in one package. Now enhanced with:

    • NEW: Design Kits for Figma
    • Online Training
    • Document Processing Library
    • Embedded Reporting for web and desktop

    Web

    Kendo UI UI for jQuery UI for Angular UI for React UI for Vue UI for Blazor UI for ASP.NET Core UI for ASP.NET MVC UI for ASP.NET AJAX

    Mobile

    UI for .NET MAUI

    Document Management

    Telerik Document Processing

    Desktop

    UI for .NET MAUI UI for WinUI UI for WinForms UI for WPF

    Reporting

    Telerik Reporting Telerik Report Server

    Testing & Mocking

    Test Studio Test Studio Dev Edition Telerik JustMock

    CMS

    Sitefinity

    UI/UX Tools

    ThemeBuilder Design System Kit Templates and Building Blocks

    Debugging

    Fiddler Fiddler Everywhere Fiddler Classic Fiddler Everywhere Reporter FiddlerCore

    Free Tools

    VB.NET to C# Converter Testing Framework
    View all products
  • Overview
  • Demos
    • What's New
    • Roadmap
    • Release History
  • Support and Learning

    • Support and Learning Hub
    • First Steps
    • Docs
    • Demos
    • Virtual Classroom
    • Forums
    • Videos
    • Blogs
    • Accessibility
    • Submit a Ticket

    Productivity and Design Tools

    • Visual Studio Extensions
    • Visual Studio Templates
    • Embedded Reporting
  • Pricing
  • Shopping cart
    • Account Overview
    • Your Licenses
    • Downloads
    • Support Center
    • Forum Profile
    • Payment Methods
    • Edit Profile
    • Log out
  • Login
  • Contact Us
  • Try now

Class RadNavigationView

Represents a control that enables modern hamburger menu navigation of application content.

Inheritance
System.Object
RadNavigationView
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Navigation.dll

Syntax

[TelerikToolboxCategory("Navigation")]
public class RadNavigationView : Selector, IThemable

Constructors

RadNavigationView()

Initializes a new instance of the RadNavigationView class.

Declaration
public RadNavigationView()

Fields

AllowMultipleExpandedItemsProperty

Identifies the AllowMultipleExpandedItems dependency property.

Declaration
public static readonly DependencyProperty AllowMultipleExpandedItemsProperty
Field Value
System.Windows.DependencyProperty

AllowSingleClickExpandInCompactModeProperty

Identifies the AllowSingleClickExpandInCompactMode dependency property.

Declaration
public static readonly DependencyProperty AllowSingleClickExpandInCompactModeProperty
Field Value
System.Windows.DependencyProperty

AutoChangeDisplayModeProperty

Identifies the AutoChangeDisplayMode dependency property.

Declaration
public static readonly DependencyProperty AutoChangeDisplayModeProperty
Field Value
System.Windows.DependencyProperty

CanKeyboardNavigationSelectItemsProperty

Identifies the CanKeyboardNavigationSelectItems dependency property.

Declaration
public static readonly DependencyProperty CanKeyboardNavigationSelectItemsProperty
Field Value
System.Windows.DependencyProperty

CompactModeThresholdWidthProperty

Identifies the CompactModeThresholdWidth dependency property.

Declaration
public static readonly DependencyProperty CompactModeThresholdWidthProperty
Field Value
System.Windows.DependencyProperty

CompactPaneWidthProperty

Identifies the CompactPaneWidth dependency property.

Declaration
public static readonly DependencyProperty CompactPaneWidthProperty
Field Value
System.Windows.DependencyProperty

ContentProperty

Identifies the Content dependency property.

Declaration
public static readonly DependencyProperty ContentProperty
Field Value
System.Windows.DependencyProperty

ContentTemplateProperty

Identifies the ContentTemplate dependency property.

Declaration
public static readonly DependencyProperty ContentTemplateProperty
Field Value
System.Windows.DependencyProperty

DisplayModeProperty

Identifies the DisplayMode dependency property.

Declaration
public static readonly DependencyProperty DisplayModeProperty
Field Value
System.Windows.DependencyProperty

ExpandedModeThresholdWidthProperty

Identifies the ExpandedModeThresholdWidth dependency property.

Declaration
public static readonly DependencyProperty ExpandedModeThresholdWidthProperty
Field Value
System.Windows.DependencyProperty

ExpandedPaneWidthProperty

Identifies the ExpandedPaneWidth dependency property.

Declaration
public static readonly DependencyProperty ExpandedPaneWidthProperty
Field Value
System.Windows.DependencyProperty

IsPaneOpenProperty

Identifies the IsPaneOpen dependency property.

Declaration
public static readonly DependencyProperty IsPaneOpenProperty
Field Value
System.Windows.DependencyProperty

PaneBackgroundProperty

Identifies the PaneBackground dependency property.

Declaration
public static readonly DependencyProperty PaneBackgroundProperty
Field Value
System.Windows.DependencyProperty

PaneClosedEvent

Identifies the PaneClosed routed event.

Declaration
public static readonly RoutedEvent PaneClosedEvent
Field Value
System.Windows.RoutedEvent

PaneFooterProperty

Identifies the PaneFooter dependency property.

Declaration
public static readonly DependencyProperty PaneFooterProperty
Field Value
System.Windows.DependencyProperty

PaneFooterTemplateProperty

Identifies the PaneFooterTemplate dependency property.

Declaration
public static readonly DependencyProperty PaneFooterTemplateProperty
Field Value
System.Windows.DependencyProperty

PaneFooterTemplateSelectorProperty

Identifies the PaneFooterTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty PaneFooterTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

PaneHeaderBackgroundProperty

Identifies the PaneHeaderBackground dependency property.

Declaration
public static readonly DependencyProperty PaneHeaderBackgroundProperty
Field Value
System.Windows.DependencyProperty

PaneHeaderForegroundProperty

Identifies the PaneHeaderForeground dependency property.

Declaration
public static readonly DependencyProperty PaneHeaderForegroundProperty
Field Value
System.Windows.DependencyProperty

PaneHeaderHeightProperty

Identifies the PaneHeaderHeight dependency property.

Declaration
public static readonly DependencyProperty PaneHeaderHeightProperty
Field Value
System.Windows.DependencyProperty

PaneHeaderProperty

Identifies the PaneHeader dependency property.

Declaration
public static readonly DependencyProperty PaneHeaderProperty
Field Value
System.Windows.DependencyProperty

PaneHeaderTemplateProperty

Identifies the PaneHeaderTemplate dependency property.

Declaration
public static readonly DependencyProperty PaneHeaderTemplateProperty
Field Value
System.Windows.DependencyProperty

PaneHeaderTemplateSelectorProperty

Identifies the PaneHeaderTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty PaneHeaderTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

PaneOpenedEvent

Identifies the PaneOpened routed event.

Declaration
public static readonly RoutedEvent PaneOpenedEvent
Field Value
System.Windows.RoutedEvent

PaneToggleButtonContentProperty

Identifies the PaneToggleButtonContent dependency property.

Declaration
public static readonly DependencyProperty PaneToggleButtonContentProperty
Field Value
System.Windows.DependencyProperty

PaneToggleButtonContentTemplateProperty

Identifies the PaneToggleButtonContentTemplate dependency property.

Declaration
public static readonly DependencyProperty PaneToggleButtonContentTemplateProperty
Field Value
System.Windows.DependencyProperty

PaneToggleButtonStyleProperty

Identifies the PaneToggleButtonStyle dependency property.

Declaration
public static readonly DependencyProperty PaneToggleButtonStyleProperty
Field Value
System.Windows.DependencyProperty

PaneToggleButtonVisibilityProperty

Identifies the PaneToggleButtonVisibility dependency property.

Declaration
public static readonly DependencyProperty PaneToggleButtonVisibilityProperty
Field Value
System.Windows.DependencyProperty

PaneWidthProperty

Identifies the PaneWidth dependency property.

Declaration
public static readonly DependencyProperty PaneWidthProperty
Field Value
System.Windows.DependencyProperty

SelectedItemProperty

Identifies the SelectedItem dependency property.

Declaration
public static readonly DependencyProperty SelectedItemProperty
Field Value
System.Windows.DependencyProperty

SubItemsIndentationProperty

Identifies the SubItemsIndentation dependency property.

Declaration
public static readonly DependencyProperty SubItemsIndentationProperty
Field Value
System.Windows.DependencyProperty

Properties

AllowMultipleExpandedItems

Gets or sets value specifying whether multiple top level items can get expanded at the same time. Not supported when the DisplayMode is Compact. The default value is true.

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

AllowSingleClickExpandInCompactMode

Gets or sets a value specifying whether top level RadNavigationViewItems can be expanded with a single click when the DisplayMode is compact and the items are displayed in a flyout. The default value is true.

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

AutoChangeDisplayMode

Gets or sets a value that indicates if the NavigationView will auto change the display modes depending on its width.

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

CanKeyboardNavigationSelectItems

Gets or sets the value specifying whether the keyboard navigation in the NavigationView should change the selection.

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

CompactModeThresholdWidth

Gets or sets the minimum width at which the NavigationView enters Compact display mode.

Declaration
public double CompactModeThresholdWidth { get; set; }
Property Value
System.Double

CompactPaneWidth

Gets or sets the width of the NavigationView pane in its compact display mode.

Declaration
public double CompactPaneWidth { get; set; }
Property Value
System.Double

Content

Gets or sets the content of RadNavigationView.

Declaration
public object Content { get; set; }
Property Value
System.Object

ContentTemplate

Gets or sets the content template of RadNavigationView.

Declaration
public DataTemplate ContentTemplate { get; set; }
Property Value
System.Windows.DataTemplate

DisplayMode

Gets or sets a value that indicates where the NavigationView pane is currently shown.

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

ExpandedModeThresholdWidth

Gets or sets the minimum width at which the NavigationView enters Expanded display mode.

Declaration
public double ExpandedModeThresholdWidth { get; set; }
Property Value
System.Double

ExpandedPaneWidth

Gets or sets the width of the NavigationView pane when it's fully expanded.

Declaration
public double ExpandedPaneWidth { get; set; }
Property Value
System.Double

HighlightedIndex

Gets the index of the highlighted item - it works only for top level items. For sub items the property returns -1.

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

The index of the highlighted item.

IsPaneOpen

Gets or sets a value that specifies whether the NavigationView pane is expanded to its full width.

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

LogicalChildren

Gets an enumerator for the logical child objects of the System.Windows.Controls.ItemsControl object.

Declaration
protected override IEnumerator LogicalChildren { get; }
Property Value
System.Collections.IEnumerator

PaneBackground

Gets or sets the background of the pane.

Declaration
public Brush PaneBackground { get; set; }
Property Value
System.Windows.Media.Brush

PaneFooter

Gets or sets the content for the pane footer.

Declaration
public object PaneFooter { get; set; }
Property Value
System.Object

PaneFooterTemplate

Gets or sets the content template for the pane footer.

Declaration
public DataTemplate PaneFooterTemplate { get; set; }
Property Value
System.Windows.DataTemplate

PaneFooterTemplateSelector

Gets or sets the content template selector for the pane footer.

Declaration
public DataTemplateSelector PaneFooterTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

PaneHeader

Gets or sets the content for the pane header.

Declaration
public object PaneHeader { get; set; }
Property Value
System.Object

PaneHeaderBackground

Gets or sets the background of the pane header.

Declaration
public Brush PaneHeaderBackground { get; set; }
Property Value
System.Windows.Media.Brush

PaneHeaderForeground

Gets or sets the foreground of the pane header.

Declaration
public Brush PaneHeaderForeground { get; set; }
Property Value
System.Windows.Media.Brush

PaneHeaderHeight

Gets or sets the height of the pane header.

Declaration
public double PaneHeaderHeight { get; set; }
Property Value
System.Double

PaneHeaderTemplate

Gets or sets the content template for the pane header.

Declaration
public DataTemplate PaneHeaderTemplate { get; set; }
Property Value
System.Windows.DataTemplate

PaneHeaderTemplateSelector

Gets or sets the content template selector for the pane header.

Declaration
public DataTemplateSelector PaneHeaderTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

PaneToggleButtonContent

Gets or sets the content of the pane toggle button.

Declaration
public object PaneToggleButtonContent { get; set; }
Property Value
System.Object

PaneToggleButtonContentTemplate

Gets or sets the content template of the pane toggle button.

Declaration
public DataTemplate PaneToggleButtonContentTemplate { get; set; }
Property Value
System.Windows.DataTemplate

PaneToggleButtonStyle

Gets or sets the Style of the pane toggle button.

Declaration
public Style PaneToggleButtonStyle { get; set; }
Property Value
System.Windows.Style

PaneToggleButtonVisibility

Gets or sets the Visibility of the pane toggle button.

Declaration
public Visibility PaneToggleButtonVisibility { get; set; }
Property Value
System.Windows.Visibility

PaneWidth

Gets a value that specifies the current width of the pane.

Declaration
public double PaneWidth { get; }
Property Value
System.Double

SelectedItem

Gets or sets the first item in the current selection or returns null if the selection is empty.

Declaration
public object SelectedItem { get; set; }
Property Value
System.Object

SubItemsIndentation

Gets or sets the indentation length for the sub NavigationViewItems.

Declaration
public double SubItemsIndentation { get; set; }
Property Value
System.Double

Methods

GetContainerForItemOverride()

Creates or identifies the element that is used to display the given item.

Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
System.Windows.DependencyObject

HandleKeyDown(Key)

Contains the keyboard navigation logic of RadNavigationView.

Declaration
protected virtual bool HandleKeyDown(Key key)
Parameters
System.Windows.Input.Key key

The key that has been pressed.

Returns
System.Boolean

True if the KeyDown event should be handled, otherwise false.

IsIndexSelectable(Int32)

Determines whether the index is selectable.

Declaration
protected virtual bool IsIndexSelectable(int index)
Parameters
System.Int32 index

The index.

Returns
System.Boolean

IsItemItsOwnContainerOverride(Object)

Determines if the specified item is (or is eligible to be) its own container.

Declaration
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters
System.Object item

The item to check.

Returns
System.Boolean

True if the item is (or is eligible to be) its own container; otherwise, false.

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call. System.Windows.FrameworkElement.ApplyTemplate.

Declaration
public override void OnApplyTemplate()

OnContentChanged(Object, Object)

Invoked when the Content property changes.

Declaration
protected virtual void OnContentChanged(object oldContent, object newContent)
Parameters
System.Object oldContent

The old value of the Content property.

System.Object newContent

The new value of the Content property.

OnCreateAutomationPeer()

Returns class-specific System.Windows.Automation.Peers.AutomationPeer.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.

OnDisplayModeChanged()

Invoked when the DisplayMode property changes.

Declaration
protected virtual void OnDisplayModeChanged()

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

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

The System.Windows.RoutedEventArgs that contains the event data.

OnIsPaneOpenChanged()

Invoked when the IsPaneOpen property changes.

Declaration
protected virtual void OnIsPaneOpenChanged()

OnItemClick(RoutedEventArgs)

Raises the ItemClick event.

Declaration
protected virtual void OnItemClick(RoutedEventArgs args)
Parameters
System.Windows.RoutedEventArgs args

The RoutedEventArgs instance containing the event data.

OnRenderSizeChanged(SizeChangedInfo)

This is invoked after layout update before rendering if the element's RenderSize has changed as a result of layout update.

Declaration
protected override void OnRenderSizeChanged(SizeChangedInfo sizeInfo)
Parameters
System.Windows.SizeChangedInfo sizeInfo

PrepareContainerForItemOverride(DependencyObject, Object)

Prepares the specified element to display the specified item.

Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject element

Element used to display the specified item.

System.Object item

Specified item.

ResetTheme()

Resets the theme.

Declaration
public void ResetTheme()

ScrollIntoView(Int32)

Scrolls the item on given index into view.

Declaration
public void ScrollIntoView(int index)
Parameters
System.Int32 index

The index.

ScrollIntoView(Object)

Scrolls the item into view.

Declaration
public void ScrollIntoView(object item)
Parameters
System.Object item

Events

ItemClick

Occurs when an item was clicked.

Declaration
public event RoutedEventHandler ItemClick
Event Type
System.Windows.RoutedEventHandler

ItemCollapsed

Occurs when the RadNavigationViewItem gets collapsed.

Declaration
public event RoutedEventHandler ItemCollapsed
Event Type
System.Windows.RoutedEventHandler

ItemExpanded

Occurs when the RadNavigationViewItem gets expanded.

Declaration
public event RoutedEventHandler ItemExpanded
Event Type
System.Windows.RoutedEventHandler

PaneClosed

Occurs when the NavigationView pane is closed.

Declaration
public event RoutedEventHandler PaneClosed
Event Type
System.Windows.RoutedEventHandler

PaneOpened

Occurs when the NavigationView pane is opened.

Declaration
public event RoutedEventHandler PaneOpened
Event Type
System.Windows.RoutedEventHandler

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)
EnumerableExtensions.ToEnumerable<T>(T)
Getting Started
  • Install Now
  • Demos
  • SDK Samples Browser
  • Sample Applications
Support Resources
  • Code Library
  • Knowledge Base
  • MVVM Support
  • Videos
  • GitHub SDK Repository
Community
  • Forums
  • Blogs
  • XAML Feedback Portal
  • Document Processing Feedback Portal

Copyright © 2018 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.

Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. See Trademarks for appropriate markings.