Class Dialog

Helper class for showing user dialogs.

System.IComparable
Namespace: FlaxEditor.GUI.Dialogs
Assembly: FlaxEngine.CSharp.dll
Syntax
public abstract class Dialog : ContainerControl, IComparable, IDrawable

Constructors

Dialog(String)

Initializes a new instance of the Dialog class.

Declaration
protected Dialog(string title)
Parameters
System.String title

The title.

Fields

_dialogSize

The dialog size.

Declaration
protected Float2 _dialogSize
Field Value
Float2

_isWaitingForDialog

Flag used to block the calling thread if it used ShowDialog option.

Declaration
protected long _isWaitingForDialog
Field Value
System.Int64

_result

The dialog result.

Declaration
protected DialogResult _result
Field Value
DialogResult

_window

The parent window.

Declaration
protected Window _window
Field Value
Window

Properties

DialogSize

Returns the size of the dialog.

Declaration
public Float2 DialogSize { get; }
Property Value
Float2

Result

Gets the dialog result.

Declaration
public DialogResult Result { get; }
Property Value
DialogResult

Methods

CanCloseWindow(ClosingReason)

Determines whether this dialog can be closed.

Declaration
protected virtual bool CanCloseWindow(ClosingReason reason)
Parameters
ClosingReason reason

The reason.
Returns
System.Boolean

true if this dialog can be closed; otherwise, false.

Close()

Closes this dialog.

Declaration
public void Close()

Close(DialogResult)

Closes dialog with the specified result.

Declaration
protected void Close(DialogResult result)
Parameters
DialogResult result

The result.

OnCancel()

Called to cancel action and close the dialog.

Declaration
public virtual void OnCancel()

OnKeyDown(KeyboardKeys)

When key goes down

Declaration
public override bool OnKeyDown(KeyboardKeys key)
Parameters
KeyboardKeys key

Key value
Returns
System.Boolean

True if event has been handled, otherwise false
Overrides

OnShow()

Called when dialogs popups.

Declaration
protected virtual void OnShow()

OnSubmit()

Generic user interaction event for a control used by UI navigation (eg. user submits on the currently focused control).

Declaration
public override void OnSubmit()
Overrides

SetupWindowSettings(ref CreateWindowSettings)

Setups the window settings.

Declaration
protected virtual void SetupWindowSettings(ref CreateWindowSettings settings)
Parameters
CreateWindowSettings settings

The settings.

Show()

Shows the dialog.

Declaration
public void Show()

Show(Control)

Shows the dialog.

Declaration
public void Show(Control control)
Parameters
Control control

The control calling.

Show(WindowRootControl)

Shows the dialog.

Declaration
public void Show(WindowRootControl parentWindow)
Parameters
FlaxEngine.GUI.WindowRootControl parentWindow

The parent window.

Show(Window)

Shows the dialog.

Declaration
public void Show(Window parentWindow)
Parameters
Window parentWindow

The parent window.

ShowDialog()

Shows the dialog and waits for the result.

Declaration
public DialogResult ShowDialog()
Returns
DialogResult

The dialog result.

ShowDialog(Control)

Shows the dialog and waits for the result.

Declaration
public DialogResult ShowDialog(Control control)
Parameters
Control control

The control calling.
Returns
DialogResult

The dialog result.

ShowDialog(WindowRootControl)

Shows the dialog and waits for the result.

Declaration
public DialogResult ShowDialog(WindowRootControl parentWindow)
Parameters
FlaxEngine.GUI.WindowRootControl parentWindow

The parent window.
Returns
DialogResult

The dialog result.

ShowDialog(Window)

Shows the dialog and waits for the result.

Declaration
public DialogResult ShowDialog(Window parentWindow)
Parameters
Window parentWindow

The parent window.
Returns
DialogResult

The dialog result.

Extension Methods

See Also