Class Msg

Namespace

NanoByte.Common.Controls

Assembly

NanoByte.Common.WinForms.dll

Provides easier access to typical System.Windows.Forms.MessageBox configurations and automatically upgrades to TaskDialogs when available.

public static class Msg

Inheritance

object

Msg

Methods

Inform(IWin32Window?, string, MsgSeverity)

Displays a message to the user using a message box or task dialog.

public static void Inform(IWin32Window? owner, string text, MsgSeverity severity)

Parameters

owner IWin32Window

The parent window the displayed window is modal to; can be null.

text string

The message to be displayed.

severity MsgSeverity

How severe/important the message is.

OkCancel(IWin32Window?, string, MsgSeverity, string?, string?)

Asks the user a OK/Cancel-question using a message box or task dialog.

public static bool OkCancel(IWin32Window? owner, string text, MsgSeverity severity, string? okCaption = null, string? cancelCaption = null)

Parameters

owner IWin32Window

The parent window the displayed window is modal to; can be null.

text string

The message to be displayed.

severity MsgSeverity

How severe/important the message is.

okCaption string

The title and a short description (separated by a linebreak) of the System.Windows.Forms.DialogResult.OK option; null for default.

cancelCaption string

The title and a short description (separated by a linebreak) of the System.Windows.Forms.DialogResult.Cancel option; null for default.

Returns

bool

true if okCaption was selected, false if cancelCaption was selected.

Remarks

If a System.Windows.Forms.MessageBox is used, okCaption and cancelCaption are not display to the user, so don't rely on them!

YesNo(IWin32Window?, string, MsgSeverity, string?, string?)

Asks the user to choose between two options (yes/no) using a message box or task dialog.

public static bool YesNo(IWin32Window? owner, string text, MsgSeverity severity, string? yesCaption = null, string? noCaption = null)

Parameters

owner IWin32Window

The parent window the displayed window is modal to; can be null.

text string

The message to be displayed.

severity MsgSeverity

How severe/important the message is.

yesCaption string

The title and a short description (separated by a linebreak) of the System.Windows.Forms.DialogResult.Yes option; null for default.

noCaption string

The title and a short description (separated by a linebreak) of the System.Windows.Forms.DialogResult.No option; null for default.

Returns

bool

true if yesCaption was chosen, false if noCaption was chosen.

Remarks

If a System.Windows.Forms.MessageBox is used, yesCaption and noCaption are not display to the user, so don't rely on them!

YesNoCancel(IWin32Window?, string, MsgSeverity, string?, string?)

Asks the user to choose between three options (yes/no/cancel) using a message box or task dialog.

public static DialogResult YesNoCancel(IWin32Window? owner, string text, MsgSeverity severity, string? yesCaption = null, string? noCaption = null)

Parameters

owner IWin32Window

The parent window the displayed window is modal to; can be null.

text string

The message to be displayed.

severity MsgSeverity

How severe/important the message is.

yesCaption string

The title and a short description (separated by a linebreak) of the System.Windows.Forms.DialogResult.Yes option; null for default.

noCaption string

The title and a short description (separated by a linebreak) of the System.Windows.Forms.DialogResult.No option; null for default.

Returns

DialogResult

System.Windows.Forms.DialogResult.Yes if yesCaption was chosen, System.Windows.Forms.DialogResult.No if noCaption was chosen, System.Windows.Forms.DialogResult.Cancel otherwise.

Remarks

If a System.Windows.Forms.MessageBox is used, yesCaption and noCaption are not display to the user, so don't rely on them!