Class Pane

A Pane is a visual element that can be used as a child of a SplitView.

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
BaseVisualElement
Pane
Implements
Inherited Members
VisualElement.ExecuteDefaultAction(EventBase)
VisualElement.Focus()
VisualElement.Overlaps(Rect)
VisualElement.ToString()
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.cacheAsBitmap
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)
Namespace: Unity.AppUI.UI
Assembly: Unity.AppUI.dll
Syntax
public class Pane : BaseVisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IContextOverrideElement, IAdditionalDataHolder

Constructors

Pane()

Default constructor.

Declaration
public Pane()

Fields

compactUssClassName

The USS class name of a Pane in compact mode.

Declaration
public const string compactUssClassName = "appui-pane--compact"
Field Value
Type Description
string

ussClassName

The USS class name of a Pane.

Declaration
public const string ussClassName = "appui-pane"
Field Value
Type Description
string

Properties

compactThreshold

A threshold used to snap to compact mode when the pane is resized.

Declaration
public float compactThreshold { get; set; }
Property Value
Type Description
float

stretch

Whether the pane can be stretched or not.

Declaration
public bool stretch { get; set; }
Property Value
Type Description
bool

stretchFactor

The stretch factor of the pane.

Declaration
public float stretchFactor { get; set; }
Property Value
Type Description
float

Methods

RestoreState(State)

Restores the state of the Pane.

Declaration
public void RestoreState(Pane.State state)
Parameters
Type Name Description
Pane.State state

The state of the Pane.

SaveState()

Saves the state of the Pane.

Declaration
public Pane.State SaveState()
Returns
Type Description
Pane.State

The state of the Pane.

ToggleCompact()

Toggles the pane between compact and expanded mode.

Declaration
public void ToggleCompact()

Events

compactChanged

Event that is triggered when the pane is toggled between compact and expanded mode.

Declaration
public event Action<Pane> compactChanged
Event Type
Type Description
Action<Pane>

Implements

Extension Methods