ExceptionMessageBox ExceptionMessageBox ExceptionMessageBox ExceptionMessageBox Class

Definition

Displays a message box that can be customized with text, buttons, and symbols to improve the customer experience with a Microsoft Windows .NET Framework-based application.

public ref class ExceptionMessageBox
[System.Runtime.InteropServices.ComVisible(false)]
public class ExceptionMessageBox
type ExceptionMessageBox = class
Public Class ExceptionMessageBox
Inheritance
ExceptionMessageBoxExceptionMessageBoxExceptionMessageBoxExceptionMessageBox
Attributes

Examples

This example displays the message box with an OK button.

try
{
    // Do something that may generate an exception.
    throw new ApplicationException("An error has occured");
}
catch (ApplicationException ex)
{
    // Define a new top-level error message.
    string str = "The action failed.";

    // Add the new top-level message to the handled exception.
    ApplicationException exTop = new ApplicationException(str, ex);
    exTop.Source = this.Text;

    // Show an exception message box with an OK button (the default).
    ExceptionMessageBox box = new ExceptionMessageBox(exTop);
    box.Show(this);
}
Try
    ' Do something that may generate an exception.
    Throw New ApplicationException("An error has occured")
Catch ex As ApplicationException
    ' Define a new top-level error message.
    Dim str As String = "The action failed."

    ' Add the new top-level message to the handled exception.
    Dim exTop As ApplicationException = New ApplicationException(str, ex)
    exTop.Source = Me.Text

    ' Show an exception message box with an OK button (the default).
    Dim box As ExceptionMessageBox = New ExceptionMessageBox(exTop)
    box.Show(Me)
End Try

This example uses the exception message box to show additional information that is helpful when troubleshooting or debugging.

try
{
    // Do something that you don't expect to generate an exception.
    throw new ApplicationException("Failed to connect to the server.");
}
catch (ApplicationException ex)
{
    string str = "An unexpected error occurred. Please call Helpdesk.";
    ApplicationException exTop = new ApplicationException(str, ex);
    exTop.Source = this.Text;

    // Information in the Data property of an exception that has a name
    // beginning with "HelpLink.Advanced" is shown when the user
    // clicks the Advanced Information button of the exception message
    // box dialog box.
    exTop.Data.Add("AdvancedInformation.FileName", "application.dll");
    exTop.Data.Add("AdvancedInformation.FilePosition", "line 355");
    exTop.Data.Add("AdvancedInformation.UserContext", "single user mode");

    // Show the exception message box with additional information that 
    // is helpful when a user calls technical support.
    ExceptionMessageBox box = new ExceptionMessageBox(exTop);

    box.Show(this);
}
Try
    ' Do something that you don't expect to generate an exception.
    Throw New ApplicationException("Failed to connect to the server.")
Catch ex As ApplicationException
    Dim str As String = "An unexpected error occurred. Please call Helpdesk."
    Dim exTop As ApplicationException = New ApplicationException(str, ex)
    exTop.Source = Me.Text

    ' Information in the Data property of an exception that has a name
    ' beginning with "HelpLink.Advanced" is shown when the user
    ' clicks the Advanced Information button of the exception message
    ' box dialog box.
    exTop.Data.Add("AdvancedInformation.FileName", "application.dll")
    exTop.Data.Add("AdvancedInformation.FilePosition", "line 355")
    exTop.Data.Add("AdvancedInformation.UserContext", "single user mode")

    ' Show the exception message box with additional information that 
    ' is helpful when a user calls technical support.
    Dim box As ExceptionMessageBox = New ExceptionMessageBox(exTop)

    box.Show(Me)

End Try

Constructors

ExceptionMessageBox() ExceptionMessageBox() ExceptionMessageBox() ExceptionMessageBox()

Creates an instance of ExceptionMessageBox with the default properties.

ExceptionMessageBox(Exception) ExceptionMessageBox(Exception) ExceptionMessageBox(Exception) ExceptionMessageBox(Exception)

Creates an instance of ExceptionMessageBox by using information from the specified Exception.

ExceptionMessageBox(String) ExceptionMessageBox(String) ExceptionMessageBox(String) ExceptionMessageBox(String)

Creates an instance of ExceptionMessageBox with the supplied top-level error message text.

ExceptionMessageBox(Exception, ExceptionMessageBoxButtons) ExceptionMessageBox(Exception, ExceptionMessageBoxButtons) ExceptionMessageBox(Exception, ExceptionMessageBoxButtons) ExceptionMessageBox(Exception, ExceptionMessageBoxButtons)

Creates an instance of ExceptionMessageBox by using information from the specified Exception and by specifying the buttons to display in the message box.

ExceptionMessageBox(String, String) ExceptionMessageBox(String, String) ExceptionMessageBox(String, String) ExceptionMessageBox(String, String)

Creates an instance of ExceptionMessageBox with the supplied top-level error message text and the dialog box caption of the exception message box.

ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol) ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol) ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol) ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol)

Creates an instance of ExceptionMessageBox by using information from the specified Exception and by specifying the buttons and symbol to display in the message box.

ExceptionMessageBox(String, String, ExceptionMessageBoxButtons) ExceptionMessageBox(String, String, ExceptionMessageBoxButtons) ExceptionMessageBox(String, String, ExceptionMessageBoxButtons) ExceptionMessageBox(String, String, ExceptionMessageBoxButtons)

Creates an instance of ExceptionMessageBox with the supplied top-level error message text and the dialog box caption of the exception message box. The method also specifies buttons to display in the exception message box.

ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton) ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton) ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton) ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton)

Creates an instance of ExceptionMessageBox by using information from the specified Exception and by specifying the buttons, symbol, and default button to display in the exception message box. .

ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol) ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol) ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol) ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol)

Creates an instance of ExceptionMessageBox with the supplied top-level error message text and dialog box caption of the exception message box. The method also specifies the buttons and symbol to display in the exception message box.

ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton, ExceptionMessageBoxOptions) ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton, ExceptionMessageBoxOptions) ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton, ExceptionMessageBoxOptions) ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton, ExceptionMessageBoxOptions)

Creates an instance of ExceptionMessageBox by using information from the specified Exception and by specifying the buttons, symbol, default button, and other properties to display in the exception message box.

ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton) ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton) ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton) ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton)

Creates an instance of ExceptionMessageBox with the supplied top-level error message text and dialog box caption of the message box. The method also specifies the buttons, symbol, and default button to display in the exception message box.

ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton, ExceptionMessageBoxOptions) ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton, ExceptionMessageBoxOptions) ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton, ExceptionMessageBoxOptions) ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton, ExceptionMessageBoxOptions)

Creates an instance of ExceptionMessageBox with the supplied top-level error message text and dialog box caption of the message box. The method also specifies the buttons, symbol, default button, and dialog options to display in the exception message box.

Properties

AbortButtonText AbortButtonText AbortButtonText AbortButtonText

Gets the default text for the Abort button.

Beep Beep Beep Beep

Specifies whether to play an audible sound when the message is displayed.

Buttons Buttons Buttons Buttons

Gets or sets the buttons to display in the message box.

CancelButtonText CancelButtonText CancelButtonText CancelButtonText

Gets the default text for the Cancel button.

Caption Caption Caption Caption

Gets or sets the dialog box caption of the exception message box.

CheckBoxRegistryKey CheckBoxRegistryKey CheckBoxRegistryKey CheckBoxRegistryKey

Sets an opened RegistryKey that controls the check box that is displayed on the exception message box when ShowCheckBox is true.

CheckBoxRegistryMeansDoNotShowDialog CheckBoxRegistryMeansDoNotShowDialog CheckBoxRegistryMeansDoNotShowDialog CheckBoxRegistryMeansDoNotShowDialog

Determines whether the registry value content specified by CheckBoxRegistryKey and CheckBoxRegistryValue indicates a previous user decision not to view this message.

CheckBoxRegistryValue CheckBoxRegistryValue CheckBoxRegistryValue CheckBoxRegistryValue

Gets or sets the registry value name that controls the check box on the exception message box when ShowCheckBox is true.

CheckBoxText CheckBoxText CheckBoxText CheckBoxText

Gets or sets the text to display in the check box on the exception message box when ShowCheckBox is true.

CustomDialogResult CustomDialogResult CustomDialogResult CustomDialogResult

Gets the clicked custom text dialog button.

CustomSymbol CustomSymbol CustomSymbol CustomSymbol

Gets or sets a custom bitmap to use as the symbol on the exception message box.

Data Data Data Data

Gets the IDictionary interface that stores help link and advanced information associated with the top-level message.

DefaultButton DefaultButton DefaultButton DefaultButton

Gets or sets the default button on the message box.

DefaultDialogResult DefaultDialogResult DefaultDialogResult DefaultDialogResult

Gets or sets the value returned by the Show(IWin32Window) method when the user has previously indicated not to show a given message again.

FailButtonText FailButtonText FailButtonText FailButtonText

Gets the default text for the Fail button.

Font Font Font Font

Gets or sets the font used in the message box.

HelpLink HelpLink HelpLink HelpLink

Gets or sets the link to the help file or help Web page associated with the top-level message.

IgnoreButtonText IgnoreButtonText IgnoreButtonText IgnoreButtonText

Gets the default text for the Ignore button.

InnerException InnerException InnerException InnerException

Gets or sets the Exception instance associated with the lower-level message(s).

IsCheckBoxChecked IsCheckBoxChecked IsCheckBoxChecked IsCheckBoxChecked

Specifies whether the check box is selected when ShowCheckBox is true.

Message Message Message Message

Gets or sets the Exception that contains the message to display.

MessageLevelDefault MessageLevelDefault MessageLevelDefault MessageLevelDefault

Gets or sets the number of message levels to display in the message box.

NoButtonText NoButtonText NoButtonText NoButtonText

Gets the default text for the No button

OKButtonText OKButtonText OKButtonText OKButtonText

Gets the default text for the OK button

Options Options Options Options

Gets or sets miscellaneous display options for the message box

RetryButtonText RetryButtonText RetryButtonText RetryButtonText

Gets the default text for the Retry button.

ShowCheckBox ShowCheckBox ShowCheckBox ShowCheckBox

Specifies whether to show the check box in the exception message box.

ShowToolBar ShowToolBar ShowToolBar ShowToolBar

Specifies whether to show the command button toolbar on the exception message box.

Symbol Symbol Symbol Symbol

Gets or sets the symbol to display in the exception message box.

Text Text Text Text

Gets or sets the text of the top-level message to display in the exception message box

UseOwnerFont UseOwnerFont UseOwnerFont UseOwnerFont

Specifies whether to retrieve the font of the owner window and use it as the font for the exception message box.

YesButtonText YesButtonText YesButtonText YesButtonText

Gets the default text for the Yes button

Methods

GetMessageText(Exception) GetMessageText(Exception) GetMessageText(Exception) GetMessageText(Exception)

Returns the string that a user can copy to the clipboard when the exception is displayed in an exception message box.

SetButtonText(String) SetButtonText(String) SetButtonText(String) SetButtonText(String)

Sets the text for the custom text button when only one button is displayed in the exception message box.

SetButtonText(String, String) SetButtonText(String, String) SetButtonText(String, String) SetButtonText(String, String)

Sets the text for the custom text buttons when only two buttons are displayed in the exception message box.

SetButtonText(String, String, String) SetButtonText(String, String, String) SetButtonText(String, String, String) SetButtonText(String, String, String)

Sets the text for the custom text buttons when only three buttons are displayed in the exception message box.

SetButtonText(String, String, String, String) SetButtonText(String, String, String, String) SetButtonText(String, String, String, String) SetButtonText(String, String, String, String)

Sets the text for the custom text buttons when only four buttons are displayed in the exception message box.

SetButtonText(String, String, String, String, String) SetButtonText(String, String, String, String, String) SetButtonText(String, String, String, String, String) SetButtonText(String, String, String, String, String)

Sets the text for the custom text buttons when only five buttons are displayed in the exception message box.

Show(IWin32Window) Show(IWin32Window) Show(IWin32Window) Show(IWin32Window)

Shows the exception message box as a modal dialog box centered on the parent window.

Show(IntPtr, String, String, String, String, String, String, String) Show(IntPtr, String, String, String, String, String, String, String) Show(IntPtr, String, String, String, String, String, String, String) Show(IntPtr, String, String, String, String, String, String, String)

Displays the exception message box. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Events

OnCopyToClipboard OnCopyToClipboard OnCopyToClipboard OnCopyToClipboard

Occurs when exception message text is copied from the message box to the Clipboard.

Applies to