Partager via


Classe ExceptionMessageBox

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.

Hiérarchie d'héritage

System. . :: . .Object
  Microsoft.SqlServer.MessageBox..::..ExceptionMessageBox

Espace de noms :  Microsoft.SqlServer.MessageBox
Assembly :  Microsoft.ExceptionMessageBox (en Microsoft.ExceptionMessageBox.dll)

Syntaxe

'Déclaration
<ComVisibleAttribute(False)> _
Public Class ExceptionMessageBox
'Utilisation
Dim instance As ExceptionMessageBox
[ComVisibleAttribute(false)]
public class ExceptionMessageBox
[ComVisibleAttribute(false)]
public ref class ExceptionMessageBox
[<ComVisibleAttribute(false)>]
type ExceptionMessageBox =  class end
public class ExceptionMessageBox

Le type ExceptionMessageBox expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique ExceptionMessageBox() () () () Creates an instance of ExceptionMessageBox with the default properties.
Méthode publique ExceptionMessageBox(Exception) Creates an instance of ExceptionMessageBox by using information from the specified Exception.
Méthode publique ExceptionMessageBox(String) Creates an instance of ExceptionMessageBox with the supplied top-level error message text.
Méthode publique 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.
Méthode publique 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.
Méthode publique 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.
Méthode publique 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.
Méthode publique 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. .
Méthode publique 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.
Méthode publique 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.
Méthode publique 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.
Méthode publique ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton, ExceptionMessageBoxOptions) Infrastructure. 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.

Haut de la page

Propriétés

  Nom Description
Propriété publiqueMembre statique AbortButtonText Gets the default text for the Abort button.
Propriété publique Beep Specifies whether to play an audible sound when the message is displayed.
Propriété publique Buttons Gets or sets the buttons to display in the message box.
Propriété publiqueMembre statique CancelButtonText Gets the default text for the Cancel button.
Propriété publique Caption Gets or sets the dialog box caption of the exception message box.
Propriété publique CheckBoxRegistryKey Sets an opened RegistryKey that controls the check box that is displayed on the exception message box when ShowCheckbox()()()() is true.
Propriété publique CheckBoxRegistryMeansDoNotShowDialog Determines whether the registry value content specified by CheckBoxRegistryKey and CheckBoxRegistryValue indicates a previous user decision not to view this message.
Propriété publique CheckBoxRegistryValue Gets or sets the registry value name that controls the check box on the exception message box when ShowCheckbox()()()() is true.
Propriété publique CheckBoxText Gets or sets the text to display in the check box on the exception message box when ShowCheckbox()()()() is true.
Propriété publique CustomDialogResult Gets the clicked custom text dialog button.
Propriété publique CustomSymbol Gets or sets a custom bitmap to use as the symbol on the exception message box.
Propriété publique Data Gets the IDictionary interface that stores help link and advanced information associated with the top-level message.
Propriété publique DefaultButton Gets or sets the default button on the message box.
Propriété publique DefaultDialogResult Gets or sets the value returned by the Show method when the user has previously indicated not to show a given message again.
Propriété publiqueMembre statique FailButtonText Gets the default text for the Fail button.
Propriété publique Font Gets or sets the font used in the message box.
Propriété publique HelpLink Gets or sets the link to the help file or help Web page associated with the top-level message.
Propriété publiqueMembre statique IgnoreButtonText Gets the default text for the Ignore button.
Propriété publique InnerException Gets or sets the Exception instance associated with the lower-level message(s).
Propriété publique IsCheckBoxChecked Specifies whether the check box is selected when ShowCheckbox()()()() is true.
Propriété publique Message Gets or sets the Exception that contains the message to display.
Propriété publique MessageLevelDefault Gets or sets the number of message levels to display in the message box.
Propriété publiqueMembre statique NoButtonText Gets the default text for the No button
Propriété publiqueMembre statique OKButtonText Gets the default text for the OK button
Propriété publique Options Gets or sets miscellaneous display options for the message box
Propriété publiqueMembre statique RetryButtonText Gets the default text for the Retry button.
Propriété publique ShowCheckBox Specifies whether to show the check box in the exception message box.
Propriété publique ShowToolBar Specifies whether to show the command button toolbar on the exception message box.
Propriété publique Symbol Gets or sets the symbol to display in the exception message box.
Propriété publique Text Gets or sets the text of the top-level message to display in the exception message box
Propriété publique UseOwnerFont Specifies whether to retrieve the font of the owner window and use it as the font for the exception message box.
Propriété publiqueMembre statique YesButtonText Gets the default text for the Yes button

Haut de la page

Méthodes

  Nom Description
Méthode publique Equals (hérité de Object.)
Méthode protégée Finalize (hérité de Object.)
Méthode publique GetHashCode (hérité de Object.)
Méthode publiqueMembre statique GetMessageText Returns the string that a user can copy to the clipboard when the exception is displayed in an exception message box.
Méthode publique GetType (hérité de Object.)
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode publique SetButtonText(String) Sets the text for the custom text button when only one button is displayed in the exception message box.
Méthode publique SetButtonText(String, String) Sets the text for the custom text buttons when only two buttons are displayed in the exception message box.
Méthode publique SetButtonText(String, String, String) Sets the text for the custom text buttons when only three buttons are displayed in the exception message box.
Méthode publique SetButtonText(String, String, String, String) Sets the text for the custom text buttons when only four buttons are displayed in the exception message box.
Méthode publique 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.
Méthode publique Show(IWin32Window) Shows the exception message box as a modal dialog box centered on the parent window.
Méthode publique Show(IntPtr, String, String, String, String, String, String, String) Infrastructure. Displays the exception message box. Identifié à titre d'information uniquement. Non pris en charge. La compatibilité future n'est pas garantie.
Méthode publique ToString (hérité de Object.)

Haut de la page

Événements

  Nom Description
Événement public OnCopyToClipboard Occurs when exception message text is copied from the message box to the Clipboard.

Haut de la page

Exemples

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

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.