Class MessageBoardUtil

Namespace

Hi.Common.Messages

Assembly

HiGeom.dll

Utility class for displaying messages on a message board.

public static class MessageBoardUtil

Inheritance

object

MessageBoardUtil

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

IsEnabled

Gets or sets whether message board functionality is enabled. When disabled in console applications, message board functions have no effect.

public static bool IsEnabled { get; set; }

Property Value

bool

Methods

ShowError(string, string)

Shows an error message on the message board.

public static void ShowError(string title, string message)

Parameters

title string

Title of the message

message string

Content of the message

ShowFailed(string, string)

Shows a failure message on the message board.

public static void ShowFailed(string title, string message)

Parameters

title string

Title of the message

message string

Content of the message

ShowMessage(string, string, BootstrapTheme)

Displays a message on the message board with specified title and theme color.

public static void ShowMessage(string title, string message, BootstrapTheme bootstrapThemeColor)

Parameters

title string

The title of the message

message string

The content of the message

bootstrapThemeColor BootstrapTheme

The theme color for the message display

ShowSuccess(string, string)

Shows a success message on the message board.

public static void ShowSuccess(string title, string message)

Parameters

title string

Title of the message

message string

Content of the message

ShowWarning(string, string)

Shows a warning message on the message board.

public static void ShowWarning(string title, string message)

Parameters

title string

Title of the message

message string

Content of the message

Events

ShowMessageBoard

Event that is triggered when a message needs to be displayed.

public static event ShowMessageBoardDelegate ShowMessageBoard

Event Type

ShowMessageBoardDelegate