Class RadNavigationView
Represents a control that enables modern hamburger menu navigation of application content.
Inheritance
System.Object
RadNavigationView
Assembly: Telerik.Windows.Controls.Navigation.dll
Syntax
[TelerikToolboxCategory("Navigation")]
public class RadNavigationView : Selector, IThemable
Constructors
Declaration
public RadNavigationView()
Fields
Declaration
public static readonly DependencyProperty AllowMultipleExpandedItemsProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty AllowSingleClickExpandInCompactModeProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty AutoChangeDisplayModeProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty CanKeyboardNavigationSelectItemsProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty CompactModeThresholdWidthProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty CompactPaneWidthProperty
Field Value
System.Windows.DependencyProperty
|
Identifies the Content dependency property.
Declaration
public static readonly DependencyProperty ContentProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty ContentTemplateProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty DisplayModeProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty ExpandedModeThresholdWidthProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty ExpandedPaneWidthProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty IsPaneOpenProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty PaneBackgroundProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly RoutedEvent PaneClosedEvent
Field Value
System.Windows.RoutedEvent
|
Declaration
public static readonly RoutedEvent PaneOpenedEvent
Field Value
System.Windows.RoutedEvent
|
Declaration
public static readonly DependencyProperty PaneToggleButtonContentProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty PaneToggleButtonContentTemplateProperty
Field Value
System.Windows.DependencyProperty
|
Identifies the PaneWidth dependency property.
Declaration
public static readonly DependencyProperty PaneWidthProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty SelectedItemProperty
Field Value
System.Windows.DependencyProperty
|
Declaration
public static readonly DependencyProperty SubItemsIndentationProperty
Field Value
System.Windows.DependencyProperty
|
Properties
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
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
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
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
Gets or sets the minimum width at which the NavigationView enters Compact display mode.
Declaration
public double CompactModeThresholdWidth { get; set; }
Property Value
Gets or sets the width of the NavigationView pane in its compact display mode.
Declaration
public double CompactPaneWidth { get; set; }
Property Value
Declaration
public object Content { get; set; }
Property Value
Declaration
public DataTemplate ContentTemplate { get; set; }
Property Value
System.Windows.DataTemplate
|
Gets or sets a value that indicates where the NavigationView pane is currently shown.
Declaration
public NavigationViewDisplayMode DisplayMode { get; set; }
Property Value
Gets or sets the minimum width at which the NavigationView enters Expanded display mode.
Declaration
public double ExpandedModeThresholdWidth { get; set; }
Property Value
Gets or sets the width of the NavigationView pane when it's fully expanded.
Declaration
public double ExpandedPaneWidth { get; set; }
Property Value
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.
|
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
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
|
Gets or sets the background of the pane.
Declaration
public Brush PaneBackground { get; set; }
Property Value
System.Windows.Media.Brush
|
Gets or sets the content of the pane toggle button.
Declaration
public object PaneToggleButtonContent { get; set; }
Property Value
Gets or sets the content template of the pane toggle button.
Declaration
public DataTemplate PaneToggleButtonContentTemplate { get; set; }
Property Value
System.Windows.DataTemplate
|
Gets a value that specifies the current width of the pane.
Declaration
public double PaneWidth { get; }
Property Value
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
Gets or sets the indentation length for the sub NavigationViewItems.
Declaration
public double SubItemsIndentation { get; set; }
Property Value
Methods
Creates or identifies the element that is used to display the given item.
Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
System.Windows.DependencyObject
|
Determines whether the index is selectable.
Declaration
protected virtual bool IsIndexSelectable(int index)
Parameters
System.Int32
index
The index.
|
Returns
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.
|
When overridden in a derived class, is invoked whenever application code or internal processes call.
System.Windows.FrameworkElement.ApplyTemplate.
Declaration
public override void OnApplyTemplate()
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.
|
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.
|
Invoked when the DisplayMode property changes.
Declaration
protected virtual void OnDisplayModeChanged()
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.
|
Invoked when the IsPaneOpen property changes.
Declaration
protected virtual void OnIsPaneOpenChanged()
Raises the ItemClick event.
Declaration
protected virtual void OnItemClick(RoutedEventArgs args)
Parameters
System.Windows.RoutedEventArgs
args
The RoutedEventArgs instance containing the event data.
|
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
|
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.
|
Events
Occurs when an item was clicked.
Declaration
public event RoutedEventHandler ItemClick
Event Type
System.Windows.RoutedEventHandler
|
Declaration
public event RoutedEventHandler ItemCollapsed
Event Type
System.Windows.RoutedEventHandler
|
Declaration
public event RoutedEventHandler ItemExpanded
Event Type
System.Windows.RoutedEventHandler
|
Occurs when the NavigationView pane is closed.
Declaration
public event RoutedEventHandler PaneClosed
Event Type
System.Windows.RoutedEventHandler
|
Occurs when the NavigationView pane is opened.
Declaration
public event RoutedEventHandler PaneOpened
Event Type
System.Windows.RoutedEventHandler
|
Extension Methods