Class NavigationView

Defines a wrapper for the WinUI NavigationView control.

Inheritance

System.Object

WindowsElementWrapper

NavigationView

Inherited Members

WindowsElementWrapper.Driver

WindowsElementWrapper.VerifyDriverElementShown(By, Nullable<TimeSpan>)

WindowsElementWrapper.VerifyDriverElementsShown(By, Nullable<TimeSpan>)

Namespace: Legerity.Windows.Elements.WinUI

Assembly: Legerity.WinUI.dll

Syntax

public class NavigationView : WindowsElementWrapper

Constructors

| Improve this Doc View Source

NavigationView(WindowsElement)

Initializes a new instance of the NavigationView class.

Declaration

public NavigationView(WindowsElement element)

Parameters

Type	Name	Description
WindowsElement	element	The reference.

Properties

| Improve this Doc View Source

BackButton

Gets the UI component associated with the navigation back button.

Declaration

public virtual Button BackButton { get; }

Property Value

Type	Description
Button

| Improve this Doc View Source

ExpectedCompactPaneWidth

Gets or sets the expected compact pane width used to determine the pane open state.

Declaration

public virtual int ExpectedCompactPaneWidth { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

IsPaneOpen

Gets a value indicating whether the pane is currently open.

Declaration

public virtual bool IsPaneOpen { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

MenuItems

Gets the UI components associated with the menu items.

Declaration

public virtual IEnumerable<NavigationViewItem> MenuItems { get; }

Property Value

Type	Description
IEnumerable<NavigationViewItem>

| Improve this Doc View Source

MenuItemsView

Gets the UI component associated with displaying the menu items.

Declaration

public virtual AppiumWebElement MenuItemsView { get; }

Property Value

Type	Description
AppiumWebElement

| Improve this Doc View Source

SelectedMenuItem

Gets the currently selected menu item.

Declaration

public virtual NavigationViewItem SelectedMenuItem { get; }

Property Value

Type	Description
NavigationViewItem

| Improve this Doc View Source

SettingsMenuItem

Gets the UI component associated with the settings menu item.

Declaration

public virtual AppiumWebElement SettingsMenuItem { get; }

Property Value

Type	Description
AppiumWebElement

| Improve this Doc View Source

ToggleNavigationPaneButton

Gets the UI component associated with the navigation pane toggle button.

Declaration

public virtual Button ToggleNavigationPaneButton { get; }

Property Value

Type	Description
Button

Methods

| Improve this Doc View Source

ClickMenuOption(String)

Clicks on a menu option in the navigation view with the specified item name.

Declaration

public virtual NavigationViewItem ClickMenuOption(string name)

Parameters

Type	Name	Description
System.String	name	The name of the item to click.

Returns

Type	Description
NavigationViewItem	The clicked NavigationViewItem.

| Improve this Doc View Source

ClickMenuOptionByPartialName(String)

Clicks on a menu option in the navigation view with the specified partial item name.

Declaration

public virtual NavigationViewItem ClickMenuOptionByPartialName(string name)

Parameters

Type	Name	Description
System.String	name	The partial name of the item to click.

Returns

Type	Description
NavigationViewItem	The clicked NavigationViewItem.

| Improve this Doc View Source

CloseNavigationPane()

Collapses the navigation pane.

Declaration

public virtual void CloseNavigationPane()

| Improve this Doc View Source

GoBack()

Navigates the view back.

Declaration

public virtual void GoBack()

| Improve this Doc View Source

OpenNavigationPane()

Opens the navigation pane.

Declaration

public virtual void OpenNavigationPane()

| Improve this Doc View Source

OpenSettings()

Opens the settings option.

Declaration

public virtual void OpenSettings()

| Improve this Doc View Source

VerifyPaneOpen(Int32)

Determines whether the navigation pane is open based on the specified compact pane width.

Declaration

public virtual bool VerifyPaneOpen(int expectedCompactPaneWidth)

Parameters

Type	Name	Description
System.Int32	expectedCompactPaneWidth	The expected compact pane width when closed.

Returns

Type	Description
System.Boolean	True if the pane is open; otherwise, false.

Operators

| Improve this Doc View Source

Implicit(AppiumWebElement to NavigationView)

Allows conversion of a to the NavigationView without direct casting.

Declaration

public static implicit operator NavigationView(AppiumWebElement element)

Parameters

Type	Name	Description
AppiumWebElement	element	The .

Returns

Type	Description
NavigationView	The NavigationView.

| Improve this Doc View Source

Implicit(RemoteWebElement to NavigationView)

Allows conversion of a to the NavigationView without direct casting.

Declaration

public static implicit operator NavigationView(RemoteWebElement element)

Parameters

Type	Name	Description
RemoteWebElement	element	The .

Returns

Type	Description
NavigationView	The NavigationView.

| Improve this Doc View Source

Implicit(WindowsElement to NavigationView)

Allows conversion of a to the NavigationView without direct casting.

Declaration

public static implicit operator NavigationView(WindowsElement element)

Parameters

Type	Name	Description
WindowsElement	element	The .

Returns

Type	Description
NavigationView	The NavigationView.