Skip to main content

NavigationView

C# API / Fluence.Wpf.Controls

  • Assembly: Fluence.Wpf
  • Namespace: Fluence.Wpf.Controls
public class NavigationView : Selector

A navigation control with a collapsible pane and content area, similar to WinUI NavigationView. Uses a single shared selection indicator that animates between items.

Base type: Selector (including inherited WPF and .NET members)

C# source

Constructors​

public NavigationView()

Initializes a new instance of the NavigationView class.

Properties​

Content​

public object Content { get; set; }

Gets or sets the content hosted in the main area.

ContentBackground​

public Brush ContentBackground { get; set; }

Gets or sets the background brush for the content area.

FooterMenuItems​

public ObservableCollection<object> FooterMenuItems { get; }

Gets the collection of pinned footer entries, rendered below the main menu items. Footer entries are NavigationViewItem instances that participate in the same single-selection model and selection indicator as the main menu, mirroring the WinUI NavigationView.FooterMenuItems region.

public object Header { get; set; }

Gets or sets header content displayed beside the navigation chrome.

HeaderTemplate​

public DataTemplate HeaderTemplate { get; set; }

Gets or sets the DataTemplate used to display the Header.

IsBackButtonVisible​

public bool IsBackButtonVisible { get; set; }

Gets or sets whether the back button is shown.

IsBackEnabled​

public bool IsBackEnabled { get; set; }

Gets or sets whether the back button can be invoked.

IsPaneOpen​

public bool IsPaneOpen { get; set; }

Gets or sets whether the left pane is expanded.

IsPaneToggleButtonVisible​

public bool IsPaneToggleButtonVisible { get; set; }

Gets or sets whether the pane collapse/expand toggle button is shown in left pane modes.

PaneDisplayMode​

public NavigationViewPaneDisplayMode PaneDisplayMode { get; set; }

Gets or sets whether the pane is shown on the left or across the top.

PaneFooter​

public object PaneFooter { get; set; }

Gets or sets content at the end of the pane (footer).

PaneHeader​

public object PaneHeader { get; set; }

Gets or sets content at the start of the pane chrome (title area).

SelectionFollowsFocus​

public bool SelectionFollowsFocus { get; set; }

Gets or sets whether keyboard focus on an item selects it immediately.

Methods​

ClearContainerForItemOverride​

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Documentation inherited from the Selector API.

GetContainerForItemOverride​

protected override DependencyObject GetContainerForItemOverride()

Documentation inherited from the Selector API.

IsItemItsOwnContainerOverride​

protected override bool IsItemItsOwnContainerOverride(object item)

Documentation inherited from the Selector API.

OnApplyTemplate​

public override void OnApplyTemplate()

Documentation inherited from the Selector API.

OnCreateAutomationPeer​

protected override AutomationPeer OnCreateAutomationPeer()

Documentation inherited from the Selector API.

OnItemsChanged​

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Documentation inherited from the Selector API.

OnPreviewGotKeyboardFocus​

protected override void OnPreviewGotKeyboardFocus(KeyboardFocusChangedEventArgs e)

Documentation inherited from the Selector API.

OnSelectionChanged​

protected override void OnSelectionChanged(SelectionChangedEventArgs e)

Documentation inherited from the Selector API.

PrepareContainerForItemOverride​

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Documentation inherited from the Selector API.

SelectFooterMenuItem​

public void SelectFooterMenuItem(NavigationViewItem item)

Programmatically selects a FooterMenuItems entry as if the user had invoked it: clears any main-menu selection, marks the footer item selected, moves the footer selection indicator, and raises ItemInvoked. No-op if the item is not a current footer entry.

Parameter item: The footer item to select.

Events​

BackRequested​

public event EventHandler<NavigationViewBackRequestedEventArgs>? BackRequested

Occurs when the back button is invoked.

ItemInvoked​

public event EventHandler<NavigationViewItemInvokedEventArgs>? ItemInvoked

Occurs when a navigation item is invoked before selection changes.

PaneClosed​

public event EventHandler? PaneClosed

Occurs when the pane has closed (collapsed in left mode).

PaneOpening​

public event EventHandler? PaneOpening

Occurs when the pane is opening (expanded in left mode).

Dependency property identifiers​

Use these identifiers with WPF property APIs. The matching CLR properties appear above when the control exposes them.

ContentBackgroundProperty​

public static readonly DependencyProperty ContentBackgroundProperty

Identifies the ContentBackground dependency property.

ContentProperty​

public static readonly DependencyProperty ContentProperty

Identifies the Content dependency property.

FooterMenuItemsProperty​

public static readonly DependencyProperty FooterMenuItemsProperty

Identifies the FooterMenuItems dependency property.

HeaderProperty​

public static readonly DependencyProperty HeaderProperty

Identifies the Header dependency property.

HeaderTemplateProperty​

public static readonly DependencyProperty HeaderTemplateProperty

Identifies the HeaderTemplate dependency property.

IsBackButtonVisibleProperty​

public static readonly DependencyProperty IsBackButtonVisibleProperty

Identifies the IsBackButtonVisible dependency property.

IsBackEnabledProperty​

public static readonly DependencyProperty IsBackEnabledProperty

Identifies the IsBackEnabled dependency property.

IsPaneOpenProperty​

public static readonly DependencyProperty IsPaneOpenProperty

Identifies the IsPaneOpen dependency property.

IsPaneToggleButtonVisibleProperty​

public static readonly DependencyProperty IsPaneToggleButtonVisibleProperty

Identifies the IsPaneToggleButtonVisible dependency property.

PaneDisplayModeProperty​

public static readonly DependencyProperty PaneDisplayModeProperty

Identifies the PaneDisplayMode dependency property.

PaneFooterProperty​

public static readonly DependencyProperty PaneFooterProperty

Identifies the PaneFooter dependency property.

PaneHeaderProperty​

public static readonly DependencyProperty PaneHeaderProperty

Identifies the PaneHeader dependency property.

SelectionFollowsFocusProperty​

public static readonly DependencyProperty SelectionFollowsFocusProperty

Identifies the SelectionFollowsFocus dependency property.