Class Dialog

Dialog UI element.

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
BaseVisualElement
BaseDialog
Dialog
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 Dialog : BaseDialog, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IContextOverrideElement, ISizeableElement, IDismissInvocator

Constructors

Dialog()

Default constructor.

Declaration
public Dialog()

Fields

closeButtonUssClassName

The Dialog close button styling class.

Declaration
public const string closeButtonUssClassName = "appui-dialog__closebutton"
Field Value
Type Description
string

dismissableUssClassName

The Dialog dismissable mode styling class.

Declaration
public const string dismissableUssClassName = "appui-dialog--dismissable"
Field Value
Type Description
string

Properties

closeButton

The close button. The button is only visible if dismissable is True.

Declaration
public Button closeButton { get; }
Property Value
Type Description
Button

dismissable

Set the Dialog dismissable by itself using a closeButton.

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

Methods

ShouldHideHeading()

Check if the heading should be hidden. Override this method to change the default behavior. By default, the heading is hidden if the title is null or empty.

Declaration
protected override bool ShouldHideHeading()
Returns
Type Description
bool

True if the heading should be hidden, false otherwise.
Overrides

Events

dismissRequested

Event fired when the Dialog is dismissed.

Declaration
public event Action<DismissType> dismissRequested
Event Type
Type Description
Action<DismissType>

Implements

Extension Methods