Back to all docs
API Reference / Telerik.Maui.Controls / RadNavigationView
New to Telerik UI for .NET MAUI? Start a free 30-day trial

RadNavigationView

Class

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

Definition

Namespace:Telerik.Maui.Controls

Assembly:Telerik.Maui.Controls.dll

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

Inheritance: objectRadContentViewRadCompositeContentViewRadBorderContentViewRadNavigationView

Implements: IContentViewICrossPlatformLayoutIElementIPaddingIRadContentViewITransformIView...

Inherited Members RadBorderContentView.BackgroundColorPropertyRadBorderContentView.BackgroundPropertyRadBorderContentView.BorderColorPropertyRadBorderContentView.BorderBrushPropertyRadBorderContentView.BorderThicknessPropertyRadBorderContentView.CornerRadiusPropertyRadBorderContentView.ContentPaddingPropertyRadBorderContentView.BackgroundColorRadBorderContentView.BackgroundRadBorderContentView.BorderColorRadBorderContentView.BorderBrushRadBorderContentView.BorderThicknessRadBorderContentView.CornerRadiusRadBorderContentView.ContentPaddingRadCompositeContentView.StylePropertyRadCompositeContentView.ControlTemplatePropertyRadCompositeContentView.OnBindingContextChanged()RadCompositeContentView.StyleRadCompositeContentView.ControlTemplateRadContentView.ActualStyleClassPropertyRadContentView.OnChildAdded(Element)RadContentView.OnChildRemoved(Element, int)RadContentView.OnHandlerChanged()...

Constructors

RadNavigationView()

Initializes a new instance of the RadNavigationView class.

C#
public RadNavigationView()

Fields

AutoChangeDisplayModeProperty

BindableProperty

Identifies the AutoChangeDisplayMode property.

C#
public static readonly BindableProperty AutoChangeDisplayModeProperty

CompactModeThresholdWidthProperty

BindableProperty

Identifies the CompactModeThresholdWidth property.

C#
public static readonly BindableProperty CompactModeThresholdWidthProperty

CompactPaneWidthProperty

BindableProperty

Identifies the CompactPaneWidth property.

C#
public static readonly BindableProperty CompactPaneWidthProperty

DismissOverlayBrushProperty

BindableProperty

Identifies the DismissOverlayBrush property.

C#
public static readonly BindableProperty DismissOverlayBrushProperty

DismissOverlayColorProperty

BindableProperty

Identifies the DismissOverlayColor property.

C#
public static readonly BindableProperty DismissOverlayColorProperty

DisplayMemberConverterProperty

BindableProperty

Identifies the DisplayMemberConverter property.

C#
public static readonly BindableProperty DisplayMemberConverterProperty

DisplayMemberPathProperty

BindableProperty

Identifies the DisplayMemberPath property.

C#
public static readonly BindableProperty DisplayMemberPathProperty

DisplayModeProperty

BindableProperty

Identifies the DisplayMode property.

C#
public static readonly BindableProperty DisplayModeProperty

ExpandedModeThresholdWidthProperty

BindableProperty

Identifies the ExpandedModeThresholdWidth property.

C#
public static readonly BindableProperty ExpandedModeThresholdWidthProperty

ExpandedPaneWidthProperty

BindableProperty

Identifies the ExpandedPaneWidth property.

C#
public static readonly BindableProperty ExpandedPaneWidthProperty

HeaderStyleProperty

BindableProperty

Identifies the HeaderStyle property.

C#
public static readonly BindableProperty HeaderStyleProperty

HeaderTemplateProperty

BindableProperty

Identifies the HeaderTemplate property.

C#
public static readonly BindableProperty HeaderTemplateProperty

HeaderTextProperty

BindableProperty

Identifies the HeaderText property.

C#
public static readonly BindableProperty HeaderTextProperty

ImageSourceConverterProperty

BindableProperty

Identifies the ImageSourceConverter property.

C#
public static readonly BindableProperty ImageSourceConverterProperty

ImageSourcePathProperty

BindableProperty

Identifies the ImageSourcePath property.

C#
public static readonly BindableProperty ImageSourcePathProperty

IsDismissOverlayVisibleProperty

BindableProperty

Identifies the IsDismissOverlayVisible property.

C#
public static readonly BindableProperty IsDismissOverlayVisibleProperty

IsPaneOpenProperty

BindableProperty

Identifies the IsPaneOpen property.

C#
public static readonly BindableProperty IsPaneOpenProperty

ItemsSourceProperty

BindableProperty

Identifies the ItemsSource property.

C#
public static readonly BindableProperty ItemsSourceProperty

ItemStyleProperty

BindableProperty

Identifies the ItemStyle property.

C#
public static readonly BindableProperty ItemStyleProperty

ItemStyleSelectorProperty

BindableProperty

Identifies the ItemStyleSelector property.

C#
public static readonly BindableProperty ItemStyleSelectorProperty

ItemTemplateProperty

BindableProperty

Identifies the ItemTemplate property.

C#
public static readonly BindableProperty ItemTemplateProperty

PaneStyleProperty

BindableProperty

Identifies the PaneStyle property.

C#
public static readonly BindableProperty PaneStyleProperty

SelectedItemProperty

BindableProperty

Identifies the SelectedItem property.

C#
public static readonly BindableProperty SelectedItemProperty

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.

C#
public bool AutoChangeDisplayMode { get; set; }

ClosePaneCommand

Gets the command which closes the pane.

C#
public ICommand ClosePaneCommand { get; }

CompactModeThresholdWidth

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

C#
public double CompactModeThresholdWidth { get; set; }

CompactPaneWidth

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

C#
public double CompactPaneWidth { get; set; }

DismissOverlayBrush

Brush

Gets or sets the Brush used to display the dismiss overlay.

C#
public Brush DismissOverlayBrush { get; set; }

DismissOverlayColor

Color

Gets or sets the Color used to display the dismiss overlay.

C#
public Color DismissOverlayColor { get; set; }

DisplayMemberConverter

IValueConverter

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.

C#
public IValueConverter DisplayMemberConverter { get; set; }

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.

C#
public string DisplayMemberPath { get; set; }

DisplayMode

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

C#
public NavigationViewDisplayMode DisplayMode { get; set; }

ExpandedModeThresholdWidth

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

C#
public double ExpandedModeThresholdWidth { get; set; }

ExpandedPaneWidth

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

C#
public double ExpandedPaneWidth { get; set; }

HeaderStyle

Style

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

C#
public Style HeaderStyle { get; set; }

HeaderTemplate

DataTemplate

Gets or sets the content template for the NavigationViewHeader.

C#
public DataTemplate HeaderTemplate { get; set; }

HeaderText

Gets or sets the text for the NavigationViewHeader.

C#
public string HeaderText { get; set; }

ImageSourceConverter

IValueConverter

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.

C#
public IValueConverter ImageSourceConverter { get; set; }

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.

C#
public string ImageSourcePath { get; set; }

IsDismissOverlayVisible

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

C#
public bool IsDismissOverlayVisible { get; }

IsPaneOpen

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

C#
public bool IsPaneOpen { get; set; }

Items

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

C#
public IList<NavigationViewItemBase> Items { get; }

ItemsSource

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

C#
public IList ItemsSource { get; set; }

ItemStyle

Style

Gets or sets the 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 Style is NavigationViewItemView.

C#
public Style ItemStyle { get; set; }

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 Style is NavigationViewItemView.

C#
public IStyleSelector ItemStyleSelector { get; set; }

ItemTemplate

DataTemplate

Gets or sets the 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.

C#
public DataTemplate ItemTemplate { get; set; }

OpenPaneCommand

Gets the command which opens the pane.

C#
public ICommand OpenPaneCommand { get; }

PaneStyle

Style

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

C#
public Style PaneStyle { get; set; }

SelectedItem

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

C#
public object SelectedItem { get; set; }

TogglePaneCommand

Gets the command which opens and closes the pane.

C#
public ICommand TogglePaneCommand { get; }

Methods

OnApplyTemplate()

C#
protected override void OnApplyTemplate()

Overrides: RadCompositeContentView.OnApplyTemplate()

OnPropertyChanged(string)

C#
protected override void OnPropertyChanged(string propertyName = null)
Parameters:propertyNamestring

Overrides: RadCompositeContentView.OnPropertyChanged(string)

Events

ItemClicked

Raised when a NavigationViewItem is clicked.

C#
public event EventHandler<NavigationViewItemEventArgs> ItemClicked

PaneClosed

Raised when the NavigationViewPane close animation completes.

C#
public event EventHandler PaneClosed

PaneOpened

Raised when the NavigationViewPane open animation completes.

C#
public event EventHandler PaneOpened

SelectionChanged

Raised when the currently selected NavigationViewItem has changed.

C#
public event EventHandler SelectionChanged
In this article
DefinitionConstructorsRadNavigationView()FieldsAutoChangeDisplayModePropertyCompactModeThresholdWidthPropertyCompactPaneWidthPropertyDismissOverlayBrushPropertyDismissOverlayColorPropertyDisplayMemberConverterPropertyDisplayMemberPathPropertyDisplayModePropertyExpandedModeThresholdWidthPropertyExpandedPaneWidthPropertyHeaderStylePropertyHeaderTemplatePropertyHeaderTextPropertyImageSourceConverterPropertyImageSourcePathPropertyIsDismissOverlayVisiblePropertyIsPaneOpenPropertyItemStylePropertyItemStyleSelectorPropertyItemTemplatePropertyItemsSourcePropertyPaneStylePropertySelectedItemPropertyPropertiesAutoChangeDisplayModeClosePaneCommandCompactModeThresholdWidthCompactPaneWidthDismissOverlayBrushDismissOverlayColorDisplayMemberConverterDisplayMemberPathDisplayModeExpandedModeThresholdWidthExpandedPaneWidthHeaderStyleHeaderTemplateHeaderTextImageSourceConverterImageSourcePathIsDismissOverlayVisibleIsPaneOpenItemStyleItemStyleSelectorItemTemplateItemsItemsSourceOpenPaneCommandPaneStyleSelectedItemTogglePaneCommandMethodsOnApplyTemplate()OnPropertyChanged(string)EventsItemClickedPaneClosedPaneOpenedSelectionChanged
Not finding the help you need?
Contact Support