Interface IMessageDialog

Interface for an in-game message dialog box.

Namespace: SociallyDistant.Core.Shell.Windowing
Assembly: SociallyDistant.Framework.dll
Syntax
public interface IMessageDialog

Properties

Buttons

Gets a collection of MessageBoxButtonData values representing the options visible in the message box.

Declaration
IList<MessageBoxButtonData> Buttons { get; }
Property Value
Type Description
IList<MessageBoxButtonData>

Color

Gets or sets the color of the message box, its headline, and its window border. This only affects the game's default UI skin or user-made skins that respect this value.

Declaration
CommonColor Color { get; set; }
Property Value
Type Description
CommonColor

DismissCallback

Gets or sets a callback delegate that should be invoked when the message box is dismissed.

Declaration
Action<MessageDialogResult>? DismissCallback { get; set; }
Property Value
Type Description
Action<MessageDialogResult>

Icon

Gets or sets a CompositeIcon value to use for the message dialog's window.

Declaration
CompositeIcon? Icon { get; set; }
Property Value
Type Description
CompositeIcon?
See Also

Message

Gets or sets the message displayed inside the message dialog.

Declaration
string Message { get; set; }
Property Value
Type Description
string

MessageType

Gets or sets the message box's type. This controls the sound played when it opens.

Declaration
MessageBoxType MessageType { get; set; }
Property Value
Type Description
MessageBoxType

Title

Gets or sets the headline text of the message dialog.

Declaration
string Title { get; set; }
Property Value
Type Description
string

Methods

Close()

Closes the message dialog. A dismiss type of Cancel will be used when invoking the DismissCallback.

Declaration
void Close()

Extension Methods