Class Panel

This is the main UI element of any Runtime App. The Panel class will create different UI layers for the main user-interface, popups, notifications and tooltips. It also inherits from ContextProvider, hence this element must not have any ContextProvider ancestors.

Inheritance

object

Panel

Implements

IEventHandler

ITransform

ITransitionAnimations

IExperimentalFeatures

IVisualElementScheduler

IResolvedStyle

Inherited Members

ContextProvider.ussClassName

ContextProvider.contextPrefix

ContextProvider.lang

ContextProvider.preferredTooltipPlacement

ContextProvider.scale

ContextProvider.theme

ContextProvider.tooltipDelayMs

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.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.experimental

VisualElement.hierarchy

VisualElement.cacheAsBitmap

VisualElement.parent

VisualElement.panel

VisualElement.visualTreeAssetSource

VisualElement.this[int]

VisualElement.childCount

VisualElement.schedule

VisualElement.style

VisualElement.customStyle

VisualElement.styleSheets

VisualElement.tooltip

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.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Unity.AppUI.UI

Assembly: solution.dll

Syntax

public class Panel : ContextProvider, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle

Constructors

Name	Description
Panel()	Default constructor.

Fields

Name	Description
mainContainerName	The name of the main UI layer.
notificationContainerName	The name of the Notifications layer.
popupContainerName	The name of the Popups layer.
tooltipContainerName	The name of the Tooltip layer.

Properties

Name	Description
contentContainer	The main UI layer container.
context	The application context. This property is overriden for this class since the Panel must be the root context.
notificationContainer	The Notifications layer container.
popupContainer	The Popups layer container.
tooltipContainer	The Tooltip layer container.

Methods

Name	Description
FindNotificationLayer(VisualElement)	Utility method to quickly find the current application's Notification layer.
FindPopupLayer(VisualElement)	Utility method to quickly find the current application's Popup layer.
FindTooltipLayer(VisualElement)	Utility method to quickly find the current application's Tooltip layer.
UnregisterPopup(Popup)	Unregister a Popup from the list of dismissable popups.

Extension Methods

VisualElementExtensions.FindNavController(VisualElement)

VisualElementExtensions.GetChildren<T>(VisualElement, bool)

VisualElementExtensions.GetContext(VisualElement)

VisualElementExtensions.GetContextProvider<T>(VisualElement)

VisualElementExtensions.GetContext<T>(VisualElement)

VisualElementExtensions.GetPreferredTooltipPlacement(VisualElement)

VisualElementExtensions.GetSelfContext<T>(VisualElement)

VisualElementExtensions.GetTooltipTemplate(VisualElement)

VisualElementExtensions.GetWorldBoundingBox(VisualElement)

VisualElementExtensions.IsContextProvider<T>(VisualElement)

VisualElementExtensions.ProvideContext<T>(VisualElement, T)

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

VisualElementExtensions.SetPreferredTooltipPlacement(VisualElement, PopoverPlacement)

VisualElementExtensions.SetTooltipTemplate(VisualElement, VisualElement)

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