Sansar Docs
Ask or search…
K

Modal Dialogue

ModalDialog Class

Manages a modal dialog which can be presented to the user.

Syntax

Member Details

Cancel Method

Cancels any existing dialog.

Syntax

[Sansar.Script.Interface] public void Cancel ()

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

Message Property

The message displayed on the dialog.

Syntax

[get: Sansar.Script.Interface] public string Message { get; }
Value
The string displayed on the dialog.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

Response Property

Syntax

[get: Sansar.Script.Interface] public string Response { get; }
Value
String response from the last show call.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

Show Method

Shows a Modal Dialog on the screen.

Syntax

[Sansar.Script.Interface] public void Show (string message, string leftButton, string rightButton)
Parameters
message
Text of the dialog.
leftButton
Text of the left button.
rightButton
Text of the right button.
Returns
The internal event id for the completion event.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

Show Method

Shows a Modal Dialog on the screen.

Syntax

Parameters
message
Text of the dialog.
leftButton
Text of the left button.
rightButton
Text of the right button.
handler
Handler to be called when the event completes.
Returns
The internal event id for the completion event.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

Show Method

Shows a Modal Dialog on the screen.

Syntax

Parameters
message
Text of the dialog.
leftButton
Text of the left button.
rightButton
Text of the right button.
handler
Handler to be called when the event completes.
Returns
The internal event id for the completion event.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

ToString Method

A string representation of this object.

Syntax

[Sansar.Script.Interface] public override string ToString ()
Returns
A string representation of this object.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0