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 Angular UI for Vue UI for jQuery KendoReact 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 Telerik JustMock

    CMS

    Sitefinity

    AI Productivity Tools

    AI Coding Assistants

    UI/UX Tools

    ThemeBuilder Design System Kit Templates and Building Blocks

    Debugging

    Fiddler Fiddler Everywhere Fiddler Classic Fiddler Everywhere Reporter FiddlerCore

    Free Tools

    KendoReact Free 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
    • Resources Hub
    • .NET MAUI Tutorials and Learning
    • First Steps
    • Submit a Ticket
    • FAQs

    Docs & Resources

    • Docs
    • Demos
    • Migrate to .NET MAUI
    • Forums
    • Videos
    • Blogs

    Productivity and Design Tools

    • 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

The RadNavigationView control provides a common vertical layout for top-level areas in your application via a collapsible navigation menu.

Inheritance
System.Object
RadContentView
RadCompositeContentView
RadBorderContentView
RadNavigationView
Inherited Members
RadBorderContentView.BackgroundColorProperty
RadBorderContentView.BackgroundProperty
RadBorderContentView.BorderColorProperty
RadBorderContentView.BorderBrushProperty
RadBorderContentView.BorderThicknessProperty
RadBorderContentView.CornerRadiusProperty
RadBorderContentView.ContentPaddingProperty
RadBorderContentView.BackgroundColor
RadBorderContentView.Background
RadBorderContentView.BorderColor
RadBorderContentView.BorderBrush
RadBorderContentView.BorderThickness
RadBorderContentView.CornerRadius
RadBorderContentView.ContentPadding
RadCompositeContentView.StyleProperty
RadCompositeContentView.ControlTemplateProperty
RadCompositeContentView.OnBindingContextChanged()
RadCompositeContentView.Style
RadCompositeContentView.ControlTemplate
RadContentView.ActualStyleClassProperty
RadContentView.OnChildAdded(Element)
RadContentView.OnChildRemoved(Element, Int32)
RadContentView.OnHandlerChanged()
RadContentView.ActualStyleClass
Namespace: Telerik.Maui.Controls
Assembly: Telerik.Maui.Controls.dll

Syntax

public class RadNavigationView : RadBorderContentView, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayout

Constructors

RadNavigationView()

Initializes a new instance of the RadNavigationView class.

Declaration
public RadNavigationView()

Fields

AutoChangeDisplayModeProperty

Identifies the AutoChangeDisplayMode property.

Declaration
public static readonly BindableProperty AutoChangeDisplayModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

CompactModeThresholdWidthProperty

Identifies the CompactModeThresholdWidth property.

Declaration
public static readonly BindableProperty CompactModeThresholdWidthProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

CompactPaneWidthProperty

Identifies the CompactPaneWidth property.

Declaration
public static readonly BindableProperty CompactPaneWidthProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DismissOverlayBrushProperty

Identifies the DismissOverlayBrush property.

Declaration
public static readonly BindableProperty DismissOverlayBrushProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DismissOverlayColorProperty

Identifies the DismissOverlayColor property.

Declaration
public static readonly BindableProperty DismissOverlayColorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DisplayMemberConverterProperty

Identifies the DisplayMemberConverter property.

Declaration
public static readonly BindableProperty DisplayMemberConverterProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DisplayMemberPathProperty

Identifies the DisplayMemberPath property.

Declaration
public static readonly BindableProperty DisplayMemberPathProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DisplayModeProperty

Identifies the DisplayMode property.

Declaration
public static readonly BindableProperty DisplayModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ExpandedModeThresholdWidthProperty

Identifies the ExpandedModeThresholdWidth property.

Declaration
public static readonly BindableProperty ExpandedModeThresholdWidthProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ExpandedPaneWidthProperty

Identifies the ExpandedPaneWidth property.

Declaration
public static readonly BindableProperty ExpandedPaneWidthProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

HeaderStyleProperty

Identifies the HeaderStyle property.

Declaration
public static readonly BindableProperty HeaderStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

HeaderTemplateProperty

Identifies the HeaderTemplate property.

Declaration
public static readonly BindableProperty HeaderTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

HeaderTextProperty

Identifies the HeaderText property.

Declaration
public static readonly BindableProperty HeaderTextProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ImageSourceConverterProperty

Identifies the ImageSourceConverter property.

Declaration
public static readonly BindableProperty ImageSourceConverterProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ImageSourcePathProperty

Identifies the ImageSourcePath property.

Declaration
public static readonly BindableProperty ImageSourcePathProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

IsDismissOverlayVisibleProperty

Identifies the IsDismissOverlayVisible property.

Declaration
public static readonly BindableProperty IsDismissOverlayVisibleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

IsPaneOpenProperty

Identifies the IsPaneOpen property.

Declaration
public static readonly BindableProperty IsPaneOpenProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemsSourceProperty

Identifies the ItemsSource property.

Declaration
public static readonly BindableProperty ItemsSourceProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemStyleProperty

Identifies the ItemStyle property.

Declaration
public static readonly BindableProperty ItemStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemStyleSelectorProperty

Identifies the ItemStyleSelector property.

Declaration
public static readonly BindableProperty ItemStyleSelectorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemTemplateProperty

Identifies the ItemTemplate property.

Declaration
public static readonly BindableProperty ItemTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

PaneStyleProperty

Identifies the PaneStyle property.

Declaration
public static readonly BindableProperty PaneStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SelectedItemProperty

Identifies the SelectedItem property.

Declaration
public static readonly BindableProperty SelectedItemProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

Properties

AutoChangeDisplayMode

Gets or sets a value that indicates if the NavigationView will auto change its display mode depending on the values of the CompactModeThresholdWidth and ExpandedModeThresholdWidth properties.

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

ClosePaneCommand

Gets the command which closes the pane.

Declaration
public ICommand ClosePaneCommand { get; }
Property Value
System.Windows.Input.ICommand

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

DismissOverlayBrush

Gets or sets the Microsoft.Maui.Controls.Brush used to display the dismiss overlay.

Declaration
public Brush DismissOverlayBrush { get; set; }
Property Value
Microsoft.Maui.Controls.Brush

DismissOverlayColor

Gets or sets the Microsoft.Maui.Graphics.Color used to display the dismiss overlay.

Declaration
public Color DismissOverlayColor { get; set; }
Property Value
Microsoft.Maui.Graphics.Color

DisplayMemberConverter

Gets or sets a converter for the display member of the generated navigation items. This property is used in combination with the ItemsSource property, when generating navigation items automatically from a custom collection of items.

Declaration
public IValueConverter DisplayMemberConverter { get; set; }
Property Value
Microsoft.Maui.Controls.IValueConverter

DisplayMemberPath

Gets or sets the path to the display member of the generated navigation items. This property is used in combination with the ItemsSource property, when generating navigation items automatically from a custom collection of items.

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

DisplayMode

Gets or sets a value that indicates how the NavigationView pane is displayed - Minimal, Compact or Expanded.

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

HeaderStyle

Gets or sets the style that will be applied to the NavigationViewHeader.

Declaration
public Style HeaderStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

HeaderTemplate

Gets or sets the content template for the NavigationViewHeader.

Declaration
public DataTemplate HeaderTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

HeaderText

Gets or sets the text for the NavigationViewHeader.

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

ImageSourceConverter

Gets or sets a converter for the image source of the generated navigation items. This property is used in combination with the ItemsSource property, when generating navigation items automatically from a custom collection of items.

Declaration
public IValueConverter ImageSourceConverter { get; set; }
Property Value
Microsoft.Maui.Controls.IValueConverter

ImageSourcePath

Gets or sets the path to the image source member of the generated navigation items. This property is used in combination with the ItemsSource property, when generating navigation items automatically from a custom collection of items.

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

IsDismissOverlayVisible

Gets a value indicating whether the dismiss overlay is currently visible.

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

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

Items

Gets a collection of NavigationViewItemBases to display in the navigation view.

Declaration
public IList<NavigationViewItemBase> Items { get; }
Property Value
System.Collections.Generic.IList<NavigationViewItemBase>

ItemsSource

Gets or sets a collection of items to display in the navigation view.

Declaration
public IList ItemsSource { get; set; }
Property Value
System.Collections.IList

ItemStyle

Gets or sets the Microsoft.Maui.Controls.Style applied to the generated navigation items. This property is used in combination with the ItemsSource property, when generating navigation items automatically from a custom collection of items. The target type of the Microsoft.Maui.Controls.Style is NavigationViewItemView.

Declaration
public Style ItemStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

ItemStyleSelector

Gets or sets a IStyleSelector used with the generated navigation items. This property is used in combination with the ItemsSource property, when generating navigation items automatically from a custom collection of items. The target type of the Microsoft.Maui.Controls.Style is NavigationViewItemView.

Declaration
public IStyleSelector ItemStyleSelector { get; set; }
Property Value
IStyleSelector

ItemTemplate

Gets or sets the Microsoft.Maui.Controls.DataTemplate applied to the generated navigation items. This property is used in combination with the ItemsSource property, when generating navigation items automatically from a custom collection of items.

Declaration
public DataTemplate ItemTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

OpenPaneCommand

Gets the command which opens the pane.

Declaration
public ICommand OpenPaneCommand { get; }
Property Value
System.Windows.Input.ICommand

PaneStyle

Gets or sets the style that will be applied to the NavigationViewPane.

Declaration
public Style PaneStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

SelectedItem

Gets or sets the currently selected item in the navigation view.

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

TogglePaneCommand

Gets the command which opens and closes the pane.

Declaration
public ICommand TogglePaneCommand { get; }
Property Value
System.Windows.Input.ICommand

Methods

OnApplyTemplate()

Declaration
protected override void OnApplyTemplate()
Overrides
RadCompositeContentView.OnApplyTemplate()

OnPropertyChanged(String)

Declaration
protected override void OnPropertyChanged(string propertyName = null)
Parameters
System.String propertyName

Overrides
RadCompositeContentView.OnPropertyChanged(String)

Events

ItemClicked

Raised when a NavigationViewItem is clicked.

Declaration
public event EventHandler<NavigationViewItemEventArgs> ItemClicked
Event Type
System.EventHandler<NavigationViewItemEventArgs>

PaneClosed

Raised when the NavigationViewPane close animation completes.

Declaration
public event EventHandler PaneClosed
Event Type
System.EventHandler

PaneOpened

Raised when the NavigationViewPane open animation completes.

Declaration
public event EventHandler PaneOpened
Event Type
System.EventHandler

SelectionChanged

Raised when the currently selected NavigationViewItem has changed.

Declaration
public event EventHandler SelectionChanged
Event Type
System.EventHandler

Extension Methods

AndroidTypeConversionExtensions.ToJavaObject(Object)
Sample Applications
  • Controls Samples App
  • Crypto Tracker App
Support Resources
  • .NET MAUI SDKBrowser App
Community
  • Forums
  • Blogs
  • Feedback Portal
  • YouTube Channel

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.