ExceptionMessageBox クラス

テキスト、ボタン、および記号によってカスタマイズ可能なメッセージ ボックスを表示し、Microsoft Windows .NET Framework ベース アプリケーションでの顧客の作業能力を向上させます。

継承階層

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() () () () 既定のプロパティで ExceptionMessageBox のインスタンスを作成します。
パブリック メソッド ExceptionMessageBox(Exception) 指定した Exception の情報を使用して、ExceptionMessageBox のインスタンスを作成します。
パブリック メソッド ExceptionMessageBox(String) 指定した最上位レベルのエラー メッセージ テキストを使用して、ExceptionMessageBox のインスタンスを作成します。
パブリック メソッド ExceptionMessageBox(Exception, ExceptionMessageBoxButtons) 指定した Exception の情報を使用し、メッセージ ボックスに表示するボタンを指定して、ExceptionMessageBox のインスタンスを作成します。
パブリック メソッド ExceptionMessageBox(String, String) 例外メッセージ ボックスに表示する最上位レベルのエラー メッセージ テキストとダイアログ ボックス キャプションを指定して、ExceptionMessageBox のインスタンスを作成します。
パブリック メソッド ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol) 指定した Exception の情報を使用し、メッセージ ボックスに表示するボタンと記号を指定して、ExceptionMessageBox のインスタンスを作成します。
パブリック メソッド ExceptionMessageBox(String, String, ExceptionMessageBoxButtons) 例外メッセージ ボックスに表示する最上位レベルのエラー メッセージ テキストとダイアログ ボックス キャプションを指定して、ExceptionMessageBox のインスタンスを作成します。このメソッドは、例外メッセージ ボックスに表示するボタンも指定します。
パブリック メソッド ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton) 指定した Exception の情報を使用し、例外メッセージ ボックスに表示するボタン、記号、および既定のボタンを指定して、ExceptionMessageBox のインスタンスを作成します。.
パブリック メソッド ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol) 例外メッセージ ボックスに表示する最上位レベルのエラー メッセージ テキストとダイアログ ボックス キャプションを指定して、ExceptionMessageBox のインスタンスを作成します。このメソッドは、例外メッセージ ボックスに表示するボタンおよび記号も指定します。
パブリック メソッド ExceptionMessageBox(Exception, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton, ExceptionMessageBoxOptions) 指定した Exception の情報を使用し、例外メッセージ ボックスに表示するボタン、記号、既定のボタン、および他のプロパティを指定して、ExceptionMessageBox のインスタンスを作成します。
パブリック メソッド ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton) メッセージ ボックスに表示する最上位レベルのエラー メッセージ テキストとダイアログ ボックス キャプションを指定して、ExceptionMessageBox のインスタンスを作成します。このメソッドは、例外メッセージ ボックスに表示するボタン、記号、および既定のボタンも指定します。
パブリック メソッド ExceptionMessageBox(String, String, ExceptionMessageBoxButtons, ExceptionMessageBoxSymbol, ExceptionMessageBoxDefaultButton, ExceptionMessageBoxOptions) インフラストラクチャです。メッセージ ボックスに表示する最上位レベルのエラー メッセージ テキストとダイアログ ボックス キャプションを指定して、ExceptionMessageBox のインスタンスを作成します。このメソッドは、例外メッセージ ボックスに表示するボタン、記号、既定のボタン、およびダイアログ オプションも指定します。

先頭に戻る

プロパティ

  名前 説明
パブリック プロパティ静的メンバー AbortButtonText [中止] ボタンの既定のテキストを取得します。
パブリック プロパティ Beep メッセージが表示されるときに、サウンドを再生するかどうかを指定します。
パブリック プロパティ Buttons メッセージ ボックスに表示するボタンを取得します。値の設定も可能です。
パブリック プロパティ静的メンバー CancelButtonText [キャンセル] ボタンの既定のテキストを取得します。
パブリック プロパティ Caption 例外メッセージ ボックスのダイアログ ボックス キャプションを取得します。値の設定も可能です。
パブリック プロパティ CheckBoxRegistryKey 開いている RegistryKey を設定して、ShowCheckbox()()()() が true の場合に例外メッセージ ボックスに表示されるチェック ボックスを制御します。
パブリック プロパティ CheckBoxRegistryMeansDoNotShowDialog CheckBoxRegistryKey および CheckBoxRegistryValue により指定されたレジストリ値の内容が、このメッセージを表示しないというユーザーの以前の決定を示しているかどうかを判別します。
パブリック プロパティ CheckBoxRegistryValue ShowCheckbox()()()() が true の場合に例外メッセージ ボックスのチェック ボックスを制御するレジストリ値名を取得します。値の設定も可能です。
パブリック プロパティ CheckBoxText ShowCheckbox()()()() が true の場合に例外メッセージ ボックスのチェック ボックスに表示するテキストを取得します。値の設定も可能です。
パブリック プロパティ CustomDialogResult クリックしたカスタム テキスト ダイアログ ボタンを取得します。
パブリック プロパティ CustomSymbol 例外メッセージ ボックスで記号として使用するカスタム ビットマップを取得します。値の設定も可能です。
パブリック プロパティ Data 最上位レベル メッセージに関連付けられたヘルプ リンクおよび詳細情報を格納する IDictionary インターフェイスを取得します。
パブリック プロパティ DefaultButton メッセージ ボックスの既定のボタンを取得します。値の設定も可能です。
パブリック プロパティ DefaultDialogResult 特定のメッセージを再度表示しないようにユーザーに前回指示が行われた際に、Show メソッドによって返された値を取得します。値の設定も可能です。
パブリック プロパティ静的メンバー FailButtonText [失敗] ボタンの既定のテキストを取得します。
パブリック プロパティ Font メッセージ ボックスで使用するフォントを取得します。値の設定も可能です。
パブリック プロパティ HelpLink 最上位レベル メッセージに関連付けられるヘルプ ファイルまたはヘルプ Web ページへのリンクを取得します。値の設定も可能です。
パブリック プロパティ静的メンバー IgnoreButtonText [無視] ボタンの既定のテキストを取得します。
パブリック プロパティ InnerException 下位レベル メッセージに関連付けられた Exception インスタンスを取得します。値の設定も可能です。
パブリック プロパティ IsCheckBoxChecked ShowCheckbox()()()() が true の場合にチェック ボックスをオンにするかどうかを指定します。
パブリック プロパティ Message 表示するメッセージが含まれる Exception を取得します。値の設定も可能です。
パブリック プロパティ MessageLevelDefault メッセージ ボックスに表示するメッセージ レベルの数を取得します。値の設定も可能です。
パブリック プロパティ静的メンバー NoButtonText [いいえ] ボタンの既定のテキストを取得します。
パブリック プロパティ静的メンバー OKButtonText [OK] ボタンの既定のテキストを取得します。
パブリック プロパティ Options メッセージ ボックスのその他の表示オプションを取得します。値の設定も可能です。
パブリック プロパティ静的メンバー RetryButtonText [再試行] ボタンの既定のテキストを取得します。
パブリック プロパティ ShowCheckBox 例外メッセージ ボックスにチェック ボックスを表示するかどうかを指定します。
パブリック プロパティ ShowToolBar 例外メッセージ ボックスにコマンド ボタン ツール バーを表示するかどうかを指定します。
パブリック プロパティ Symbol 例外メッセージ ボックスに表示される記号を取得します。値の設定も可能です。
パブリック プロパティ Text 例外メッセージ ボックスに表示される最上位レベル メッセージのテキストを取得します。値の設定も可能です。
パブリック プロパティ UseOwnerFont オーナー ウィンドウのフォントを取得して、それを例外メッセージ ボックスのフォントとして使用するかどうかを指定します。
パブリック プロパティ静的メンバー YesButtonText [はい] ボタンの既定のテキストを取得します。

先頭に戻る

メソッド

  名前 説明
パブリック メソッド Equals (Object から継承されています。)
プロテクト メソッド Finalize (Object から継承されています。)
パブリック メソッド GetHashCode (Object から継承されています。)
パブリック メソッド静的メンバー GetMessageText 例外メッセージ ボックスに例外が表示されたときにユーザーがクリップボードにコピー可能な文字列を返します。
パブリック メソッド GetType (Object から継承されています。)
プロテクト メソッド MemberwiseClone (Object から継承されています。)
パブリック メソッド SetButtonText(String) 例外メッセージ ボックスにボタンが 1 つだけ表示される場合の、カスタム テキスト ボタンのテキストを設定します。
パブリック メソッド SetButtonText(String, String) 例外メッセージ ボックスにボタンが 2 つだけ表示される場合の、カスタム テキスト ボタンのテキストを設定します。
パブリック メソッド SetButtonText(String, String, String) 例外メッセージ ボックスにボタンが 3 つだけ表示される場合の、カスタム テキスト ボタンのテキストを設定します。
パブリック メソッド SetButtonText(String, String, String, String) 例外メッセージ ボックスにボタンが 4 つだけ表示される場合の、カスタム テキスト ボタンのテキストを設定します。
パブリック メソッド SetButtonText(String, String, String, String, String) 例外メッセージ ボックスにボタンが 5 つだけ表示される場合の、カスタム テキスト ボタンのテキストを設定します。
パブリック メソッド Show(IWin32Window) 例外メッセージ ボックスを、親ウィンドウの中央にモーダル ダイアログ ボックスとして表示します。
パブリック メソッド Show(IntPtr, String, String, String, String, String, String, String) インフラストラクチャです。例外メッセージ ボックスを表示します。単に情報を示すためだけに特定されます。サポートされていません。将来の互換性は保証されません。
パブリック メソッド ToString (Object から継承されています。)

先頭に戻る

イベント

  名前 説明
パブリック イベント OnCopyToClipboard 例外メッセージ テキストがメッセージ ボックスからクリップボードにコピーされた場合に発生します。

先頭に戻る

使用例

この例では、[OK] ボタンの付いたメッセージ ボックスを表示します。

           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

この例では、例外メッセージ ボックスを使用して、トラブルシューティングやデバッグに役立つ追加情報を表示します。

            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

スレッド セーフ

この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。