Class NavigationScreen

Base class for all navigation screens. A navigation screen is a VisualElement that can be pushed to a NavHost. Classes that inherit from this class can be used as template in a NavDestination with the value of typeof(YourScreenType).AssemblyQualifiedName.

Inheritance

object

CallbackEventHandler

Focusable

VisualElement

NavigationScreen

Implements

IEventHandler

IVisualElementScheduler

IExperimentalFeatures

ITransitionAnimations

ITransform

IResolvedStyle

Inherited Members

VisualElement.disabledUssClassName

VisualElement.ExecuteDefaultAction(EventBase)

VisualElement.Focus()

VisualElement.SendEvent(EventBase)

VisualElement.SetEnabledFromHierarchy(bool)

VisualElement.SetEnabled(bool)

VisualElement.MarkDirtyRepaint()

VisualElement.ContainsPoint(Vector2)

VisualElement.Overlaps(Rect)

VisualElement.DoMeasure(float, VisualElement.MeasureMode, float, VisualElement.MeasureMode)

VisualElement.ToString()

VisualElement.GetClasses()

VisualElement.ClearClassList()

VisualElement.AddToClassList(string)

VisualElement.RemoveFromClassList(string)

VisualElement.ToggleInClassList(string)

VisualElement.EnableInClassList(string, bool)

VisualElement.ClassListContains(string)

VisualElement.FindAncestorUserData()

VisualElement.Add(VisualElement)

VisualElement.Insert(int, VisualElement)

VisualElement.Remove(VisualElement)

VisualElement.RemoveAt(int)

VisualElement.Clear()

VisualElement.ElementAt(int)

VisualElement.IndexOf(VisualElement)

VisualElement.Children()

VisualElement.Sort(Comparison<VisualElement>)

VisualElement.BringToFront()

VisualElement.SendToBack()

VisualElement.PlaceBehind(VisualElement)

VisualElement.PlaceInFront(VisualElement)

VisualElement.RemoveFromHierarchy()

VisualElement.GetFirstOfType<T>()

VisualElement.GetFirstAncestorOfType<T>()

VisualElement.Contains(VisualElement)

VisualElement.FindCommonAncestor(VisualElement)

VisualElement.style

VisualElement.customStyle

VisualElement.styleSheets

VisualElement.schedule

VisualElement.tooltip

VisualElement.experimental

VisualElement.viewDataKey

VisualElement.userData

VisualElement.canGrabFocus

VisualElement.focusController

VisualElement.usageHints

VisualElement.transform

VisualElement.layout

VisualElement.contentRect

VisualElement.paddingRect

VisualElement.worldBound

VisualElement.localBound

VisualElement.worldTransform

VisualElement.pickingMode

VisualElement.name

VisualElement.enabledInHierarchy

VisualElement.enabledSelf

VisualElement.visible

VisualElement.generateVisualContent

VisualElement.hierarchy

VisualElement.cacheAsBitmap

VisualElement.parent

VisualElement.panel

VisualElement.visualTreeAssetSource

VisualElement.this[int]

VisualElement.childCount

VisualElement.resolvedStyle

Focusable.Blur()

Focusable.focusable

Focusable.tabIndex

Focusable.delegatesFocus

CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)

CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)

CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)

CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)

CallbackEventHandler.HandleEvent(EventBase)

CallbackEventHandler.HasTrickleDownHandlers()

CallbackEventHandler.HasBubbleUpHandlers()

CallbackEventHandler.ExecuteDefaultActionAtTarget(EventBase)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Unity.AppUI.Navigation

Assembly: Unity.AppUI.Navigation.dll

Syntax

public class NavigationScreen : VisualElement, IEventHandler, IVisualElementScheduler, IExperimentalFeatures, ITransitionAnimations, ITransform, IResolvedStyle

Constructors

NavigationScreen()

Base Constructor.

Declaration

public NavigationScreen()

Fields

containerUssClassName

The NavigationScreen container styling class.

Declaration

public const string containerUssClassName = "appui-navigation-screen__container"

Field Value

Type	Description
string

ussClassName

The NavigationScreen main styling class.

Declaration

public const string ussClassName = "appui-navigation-screen"

Field Value

Type	Description
string

withAppBarUssClassName

The NavigationScreen with app bar styling class.

Declaration

public const string withAppBarUssClassName = "appui-navigation-screen--with-appbar"

Field Value

Type	Description
string

withCompactAppBarUssClassName

The NavigationScreen with compact app bar styling class.

Declaration

public const string withCompactAppBarUssClassName = "appui-navigation-screen--with-appbar--compact"

Field Value

Type	Description
string

withDrawerUssClassName

The NavigationScreen with drawer styling class.

Declaration

public const string withDrawerUssClassName = "appui-navigation-screen--with-drawer--"

Field Value

Type	Description
string

withRailUssClassName

The NavigationScreen with rail styling class.

Declaration

public const string withRailUssClassName = "appui-navigation-screen--with-rail--"

Field Value

Type	Description
string

Properties

contentContainer

Child elements are added to this element.

Declaration

public override VisualElement contentContainer { get; }

Property Value

Type	Description
VisualElement

Overrides

VisualElement.contentContainer

scrollView

The ScrollView that will be used to display the content of the screen.

Declaration

public ScrollView scrollView { get; }

Property Value

Type	Description
ScrollView

Methods

OnEnter(NavController, NavDestination, Argument[])

Called when the screen is pushed to a NavHost.

Declaration

protected virtual void OnEnter(NavController controller, NavDestination destination, Argument[] args)

Parameters

Type	Name	Description
NavController	controller	The NavController that manages the navigation stack.
NavDestination	destination	The NavDestination associated with this screen.
Argument[]	args	The arguments associated with this screen.

OnExit(NavController, NavDestination, Argument[])

Called when the screen is popped from a NavHost.

Declaration

protected virtual void OnExit(NavController controller, NavDestination destination, Argument[] args)

Parameters

Type	Name	Description
NavController	controller	The NavController that manages the navigation stack.
NavDestination	destination	The NavDestination associated with this screen.
Argument[]	args	The arguments associated with this screen.

Remarks

This method is called before the screen is removed from the NavHost.

SetupAppBar(AppBar)

Implement this method to setup the AppBar of this screen specifically.

Declaration

protected virtual void SetupAppBar(AppBar appBar)

Parameters

Type	Name	Description
AppBar	appBar	The AppBar to setup.

Remarks

To setup the AppBar globally, use SetupAppBar(AppBar, NavDestination, NavController) in your implementation of INavVisualController.

SetupBottomNavBar(BottomNavBar)

Implement this method to setup the BottomNavBar of this screen specifically.

Declaration

protected virtual void SetupBottomNavBar(BottomNavBar bottomNavBar)

Parameters

Type	Name	Description
BottomNavBar	bottomNavBar	The BottomNavBar to setup.

Remarks

To setup the BottomNavBar globally, use SetupBottomNavBar(BottomNavBar, NavDestination, NavController) in your implementation of INavVisualController.

SetupDrawer(Drawer)

Implement this method to setup the Drawer of this screen specifically.

Declaration

protected virtual void SetupDrawer(Drawer drawer)

Parameters

Type	Name	Description
Drawer	drawer	The Drawer to setup.

Remarks

To setup the Drawer globally, use SetupDrawer(Drawer, NavDestination, NavController) in your implementation of INavVisualController.

SetupNavigationRail(NavigationRail)

Implement this method to setup the NavigationRail of this screen specifically.

Declaration

protected virtual void SetupNavigationRail(NavigationRail navigationRail)

Parameters

Type	Name	Description
NavigationRail	navigationRail	The NavigationRail to setup.

Implements

IEventHandler

IVisualElementScheduler

IExperimentalFeatures

ITransitionAnimations

ITransform

IResolvedStyle

Extension Methods

VisualElementExtensions.FindNavController(VisualElement)

RegisterUpdateCallbackExtensions.RegisterUpdateCallback(VisualElement, EventCallback<UpdateEvent>)

RegisterUpdateCallbackExtensions.UnregisterUpdateCallback(VisualElement, EventCallback<UpdateEvent>)

VisualElementExtensions.EnableDynamicTransform(VisualElement, bool)

VisualElementExtensions.EnablePicking(VisualElement, bool)

VisualElementExtensions.GetChildren<T>(VisualElement, bool)

VisualElementExtensions.GetContextProvider<T>(VisualElement)

VisualElementExtensions.GetContextProvider<T>(VisualElement, string)

VisualElementExtensions.GetContext<T>(VisualElement)

VisualElementExtensions.GetContext<T>(VisualElement, string)

VisualElementExtensions.GetExclusiveRootElement(VisualElement)

VisualElementExtensions.GetLastAncestorOfType<T>(VisualElement)

VisualElementExtensions.GetPreferredTooltipPlacement(VisualElement)

VisualElementExtensions.GetSelfContext<T>(VisualElement)

VisualElementExtensions.GetSelfContext<T>(VisualElement, string)

VisualElementExtensions.GetTooltipContent(VisualElement)

VisualElementExtensions.GetTooltipTemplate(VisualElement)

VisualElementExtensions.HasAncestorsOfType<T>(VisualElement)

VisualElementExtensions.IsContextProvider<T>(VisualElement)

VisualElementExtensions.IsContextProvider<T>(VisualElement, string)

VisualElementExtensions.IsInvisible(VisualElement)

VisualElementExtensions.IsOnScreen(VisualElement)

VisualElementExtensions.ProvideContext<T>(VisualElement, string, T)

VisualElementExtensions.ProvideContext<T>(VisualElement, T)

VisualElementExtensions.RegisterContextChangedCallback<T>(VisualElement, string, EventCallback<ContextChangedEvent<T>>)

VisualElementExtensions.RegisterContextChangedCallback<T>(VisualElement, EventCallback<ContextChangedEvent<T>>)

VisualElementExtensions.SetPreferredTooltipPlacement(VisualElement, OptionalEnum<PopoverPlacement>)

VisualElementExtensions.SetTooltipContent(VisualElement, VisualElementExtensions.TooltipContentCallback)

VisualElementExtensions.SetTooltipTemplate(VisualElement, VisualElement)

VisualElementExtensions.UnregisterContextChangedCallback<T>(VisualElement, string, EventCallback<ContextChangedEvent<T>>)

VisualElementExtensions.UnregisterContextChangedCallback<T>(VisualElement, EventCallback<ContextChangedEvent<T>>)