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.

继承层次结构

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

命名空间:  Microsoft.SqlServer.MessageBox
程序集:  Microsoft.ExceptionMessageBox(在 Microsoft.ExceptionMessageBox.dll 中)

语法

声明
<ComVisibleAttribute(False)> _
Public Class ExceptionMessageBox
用法
Dim instance As ExceptionMessageBox
[ComVisibleAttribute(false)]
public class ExceptionMessageBox
[ComVisibleAttribute(false)]
public ref class ExceptionMessageBox
[<ComVisibleAttribute(false)>]
type ExceptionMessageBox =  class end
public class ExceptionMessageBox

ExceptionMessageBox 类型公开以下成员。

构造函数

  名称 说明
公共方法 ExceptionMessageBox() () () () Creates an instance of ExceptionMessageBox with the default properties.
公共方法 ExceptionMessageBox(Exception) Creates an instance of ExceptionMessageBox by using information from the specified Exception.
公共方法 ExceptionMessageBox(String) Creates an instance of ExceptionMessageBox with the supplied top-level error message text.
公共方法 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) 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) 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) 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) 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) 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) 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) 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) 基础结构。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.

页首

属性

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

页首

方法

  名称 说明
公共方法 Equals (从 Object 继承。)
受保护方法 Finalize (从 Object 继承。)
公共方法 GetHashCode (从 Object 继承。)
公共方法静态成员 GetMessageText Returns the string that a user can copy to the clipboard when the exception is displayed in an exception message box.
公共方法 GetType (从 Object 继承。)
受保护方法 MemberwiseClone (从 Object 继承。)
公共方法 SetButtonText(String) Sets the text for the custom text button when only one button is displayed in the exception message box.
公共方法 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) Sets the text for the custom text buttons when only three buttons are displayed in the exception message box.
公共方法 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) Sets the text for the custom text buttons when only five buttons are displayed in the exception message box.
公共方法 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) 基础结构。Displays the exception message box. 标识为仅供参考。不提供支持。不保证以后的兼容性。
公共方法 ToString (从 Object 继承。)

页首

事件

  名称 说明
公共事件 OnCopyToClipboard Occurs when exception message text is copied from the message box to the Clipboard.

页首

示例

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

线程安全

此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。