Back to all docs
API Reference / Telerik.Maui.Controls / RadNavigationView

Class
RadNavigationView

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:
cs-api-definition
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.

Declaration

cs-api-definition
public RadNavigationView()

Fields

AutoChangeDisplayModeProperty

Identifies the AutoChangeDisplayMode property.

Declaration

cs-api-definition
public static readonly BindableProperty AutoChangeDisplayModeProperty

Field Value

BindableProperty

CompactModeThresholdWidthProperty

Identifies the CompactModeThresholdWidth property.

Declaration

cs-api-definition
public static readonly BindableProperty CompactModeThresholdWidthProperty

Field Value

BindableProperty

CompactPaneWidthProperty

Identifies the CompactPaneWidth property.

Declaration

cs-api-definition
public static readonly BindableProperty CompactPaneWidthProperty

Field Value

BindableProperty

DismissOverlayBrushProperty

Identifies the DismissOverlayBrush property.

Declaration

cs-api-definition
public static readonly BindableProperty DismissOverlayBrushProperty

Field Value

BindableProperty

DismissOverlayColorProperty

Identifies the DismissOverlayColor property.

Declaration

cs-api-definition
public static readonly BindableProperty DismissOverlayColorProperty

Field Value

BindableProperty

DisplayMemberConverterProperty

Identifies the DisplayMemberConverter property.

Declaration

cs-api-definition
public static readonly BindableProperty DisplayMemberConverterProperty

Field Value

BindableProperty

DisplayMemberPathProperty

Identifies the DisplayMemberPath property.

Declaration

cs-api-definition
public static readonly BindableProperty DisplayMemberPathProperty

Field Value

BindableProperty

DisplayModeProperty

Identifies the DisplayMode property.

Declaration

cs-api-definition
public static readonly BindableProperty DisplayModeProperty

Field Value

BindableProperty

ExpandedModeThresholdWidthProperty

Identifies the ExpandedModeThresholdWidth property.

Declaration

cs-api-definition
public static readonly BindableProperty ExpandedModeThresholdWidthProperty

Field Value

BindableProperty

ExpandedPaneWidthProperty

Identifies the ExpandedPaneWidth property.

Declaration

cs-api-definition
public static readonly BindableProperty ExpandedPaneWidthProperty

Field Value

BindableProperty

HeaderStyleProperty

Identifies the HeaderStyle property.

Declaration

cs-api-definition
public static readonly BindableProperty HeaderStyleProperty

Field Value

BindableProperty

HeaderTemplateProperty

Identifies the HeaderTemplate property.

Declaration

cs-api-definition
public static readonly BindableProperty HeaderTemplateProperty

Field Value

BindableProperty

HeaderTextProperty

Identifies the HeaderText property.

Declaration

cs-api-definition
public static readonly BindableProperty HeaderTextProperty

Field Value

BindableProperty

ImageSourceConverterProperty

Identifies the ImageSourceConverter property.

Declaration

cs-api-definition
public static readonly BindableProperty ImageSourceConverterProperty

Field Value

BindableProperty

ImageSourcePathProperty

Identifies the ImageSourcePath property.

Declaration

cs-api-definition
public static readonly BindableProperty ImageSourcePathProperty

Field Value

BindableProperty

IsDismissOverlayVisibleProperty

Identifies the IsDismissOverlayVisible property.

Declaration

cs-api-definition
public static readonly BindableProperty IsDismissOverlayVisibleProperty

Field Value

BindableProperty

IsPaneOpenProperty

Identifies the IsPaneOpen property.

Declaration

cs-api-definition
public static readonly BindableProperty IsPaneOpenProperty

Field Value

BindableProperty

ItemStyleProperty

Identifies the ItemStyle property.

Declaration

cs-api-definition
public static readonly BindableProperty ItemStyleProperty

Field Value

BindableProperty

ItemStyleSelectorProperty

Identifies the ItemStyleSelector property.

Declaration

cs-api-definition
public static readonly BindableProperty ItemStyleSelectorProperty

Field Value

BindableProperty

ItemTemplateProperty

Identifies the ItemTemplate property.

Declaration

cs-api-definition
public static readonly BindableProperty ItemTemplateProperty

Field Value

BindableProperty

ItemsSourceProperty

Identifies the ItemsSource property.

Declaration

cs-api-definition
public static readonly BindableProperty ItemsSourceProperty

Field Value

BindableProperty

PaneStyleProperty

Identifies the PaneStyle property.

Declaration

cs-api-definition
public static readonly BindableProperty PaneStyleProperty

Field Value

BindableProperty

SelectedItemProperty

Identifies the SelectedItem property.

Declaration

cs-api-definition
public static readonly BindableProperty SelectedItemProperty

Field Value

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

cs-api-definition
public bool AutoChangeDisplayMode { get; set; }

Property Value

bool

ClosePaneCommand

Gets the command which closes the pane.

Declaration

cs-api-definition
public ICommand ClosePaneCommand { get; }

Property Value

ICommand

CompactModeThresholdWidth

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

Declaration

cs-api-definition
public double CompactModeThresholdWidth { get; set; }

Property Value

double

CompactPaneWidth

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

Declaration

cs-api-definition
public double CompactPaneWidth { get; set; }

Property Value

double

DismissOverlayBrush

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

Declaration

cs-api-definition
public Brush DismissOverlayBrush { get; set; }

Property Value

Brush

DismissOverlayColor

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

Declaration

cs-api-definition
public Color DismissOverlayColor { get; set; }

Property Value

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

cs-api-definition
public IValueConverter DisplayMemberConverter { get; set; }

Property Value

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

cs-api-definition
public string DisplayMemberPath { get; set; }

Property Value

string

DisplayMode

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

Declaration

cs-api-definition
public NavigationViewDisplayMode DisplayMode { get; set; }

Property Value

NavigationViewDisplayMode

ExpandedModeThresholdWidth

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

Declaration

cs-api-definition
public double ExpandedModeThresholdWidth { get; set; }

Property Value

double

ExpandedPaneWidth

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

Declaration

cs-api-definition
public double ExpandedPaneWidth { get; set; }

Property Value

double

HeaderStyle

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

Declaration

cs-api-definition
public Style HeaderStyle { get; set; }

Property Value

Style

HeaderTemplate

Gets or sets the content template for the NavigationViewHeader.

Declaration

cs-api-definition
public DataTemplate HeaderTemplate { get; set; }

Property Value

DataTemplate

HeaderText

Gets or sets the text for the NavigationViewHeader.

Declaration

cs-api-definition
public string HeaderText { get; set; }

Property Value

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

cs-api-definition
public IValueConverter ImageSourceConverter { get; set; }

Property Value

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

cs-api-definition
public string ImageSourcePath { get; set; }

Property Value

string

IsDismissOverlayVisible

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

Declaration

cs-api-definition
public bool IsDismissOverlayVisible { get; }

Property Value

bool

IsPaneOpen

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

Declaration

cs-api-definition
public bool IsPaneOpen { get; set; }

Property Value

bool

ItemStyle

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.

Declaration

cs-api-definition
public Style ItemStyle { get; set; }

Property Value

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

Declaration

cs-api-definition
public IStyleSelector ItemStyleSelector { get; set; }

Property Value

IStyleSelector

ItemTemplate

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.

Declaration

cs-api-definition
public DataTemplate ItemTemplate { get; set; }

Property Value

DataTemplate

Items

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

Declaration

cs-api-definition
public IList<NavigationViewItemBase> Items { get; }

Property Value

IList<NavigationViewItemBase>

ItemsSource

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

Declaration

cs-api-definition
public IList ItemsSource { get; set; }

Property Value

IList

OpenPaneCommand

Gets the command which opens the pane.

Declaration

cs-api-definition
public ICommand OpenPaneCommand { get; }

Property Value

ICommand

PaneStyle

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

Declaration

cs-api-definition
public Style PaneStyle { get; set; }

Property Value

Style

SelectedItem

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

Declaration

cs-api-definition
public object SelectedItem { get; set; }

Property Value

object

TogglePaneCommand

Gets the command which opens and closes the pane.

Declaration

cs-api-definition
public ICommand TogglePaneCommand { get; }

Property Value

ICommand

Methods

OnApplyTemplate()

Declaration

cs-api-definition
protected override void OnApplyTemplate()

Overrides RadCompositeContentView.OnApplyTemplate()

OnPropertyChanged(string)

Declaration

cs-api-definition
protected override void OnPropertyChanged(string propertyName = null)

Parameters

propertyName

string

Overrides RadCompositeContentView.OnPropertyChanged(string)

Events

ItemClicked

Raised when a NavigationViewItem is clicked.

Declaration

cs-api-definition
public event EventHandler<NavigationViewItemEventArgs> ItemClicked

Event Value

EventHandler<NavigationViewItemEventArgs>

PaneClosed

Raised when the NavigationViewPane close animation completes.

Declaration

cs-api-definition
public event EventHandler PaneClosed

Event Value

EventHandler

PaneOpened

Raised when the NavigationViewPane open animation completes.

Declaration

cs-api-definition
public event EventHandler PaneOpened

Event Value

EventHandler

SelectionChanged

Raised when the currently selected NavigationViewItem has changed.

Declaration

cs-api-definition
public event EventHandler SelectionChanged

Event Value

EventHandler

In this article
DefinitionConstructorsRadNavigationView()FieldsAutoChangeDisplayModePropertyCompactModeThresholdWidthPropertyCompactPaneWidthPropertyDismissOverlayBrushPropertyDismissOverlayColorPropertyDisplayMemberConverterPropertyDisplayMemberPathPropertyDisplayModePropertyExpandedModeThresholdWidthPropertyExpandedPaneWidthPropertyHeaderStylePropertyHeaderTemplatePropertyHeaderTextPropertyImageSourceConverterPropertyImageSourcePathPropertyIsDismissOverlayVisiblePropertyIsPaneOpenPropertyItemStylePropertyItemStyleSelectorPropertyItemTemplatePropertyItemsSourcePropertyPaneStylePropertySelectedItemPropertyPropertiesAutoChangeDisplayModeClosePaneCommandCompactModeThresholdWidthCompactPaneWidthDismissOverlayBrushDismissOverlayColorDisplayMemberConverterDisplayMemberPathDisplayModeExpandedModeThresholdWidthExpandedPaneWidthHeaderStyleHeaderTemplateHeaderTextImageSourceConverterImageSourcePathIsDismissOverlayVisibleIsPaneOpenItemStyleItemStyleSelectorItemTemplateItemsItemsSourceOpenPaneCommandPaneStyleSelectedItemTogglePaneCommandMethodsOnApplyTemplate()OnPropertyChanged(string)EventsItemClickedPaneClosedPaneOpenedSelectionChanged
Not finding the help you need?
Contact Support