[アーティクル]
04/01/2012

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) のメンバーはすべて、スレッドセーフです。インスタンスメンバーの場合は、スレッドセーフであるとは限りません。

ExceptionMessageBox クラス

継承階層

構文

コンストラクター

プロパティ

メソッド

イベント

使用例

スレッドセーフ

関連項目

参照

その他のリソース

ExceptionMessageBox クラス

継承階層

構文

コンストラクター

プロパティ

メソッド

イベント

使用例

スレッド セーフ

関連項目

参照

その他のリソース

スレッドセーフ