ExceptionMessageBox.CheckBoxText Property

Reference

Definition

Namespace:: Microsoft.SqlServer.MessageBox

Assembly:: Microsoft.ExceptionMessageBox.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 property System::String ^ CheckBoxText { System::String ^ get(); void set(System::String ^ value); };

public string CheckBoxText { get; set; }

member this.CheckBoxText : string with get, set

Public Property CheckBoxText As String

Property Value

String

A String value.

Examples

try
{
    // Do something that may cause an exception.
    throw new ApplicationException("An error has occured.");
}
catch (ApplicationException ex)
{
    string str = "The action failed.";
    ApplicationException exTop = new ApplicationException(str, ex);
    exTop.Source = this.Text;

    // Show a message box if the global variable is true.
    if (alwaysShow)
    {
        ExceptionMessageBox box = new ExceptionMessageBox(exTop);
        box.ShowCheckBox = true;
        box.IsCheckBoxChecked = true;
        box.CheckBoxText = "Always show this message";
        box.Show(this);

        // Set the global variable.
        alwaysShow = box.IsCheckBoxChecked;
    }
}

Try
    ' Do something that may cause an exception.
    Throw New ApplicationException("An error has occured.")
Catch ex As ApplicationException
    Dim str As String = "The action failed."
    Dim exTop As ApplicationException = New ApplicationException(str, ex)
    exTop.Source = Me.Text

    ' Show a message box if the global variable is true.
    If alwaysShow Then
        Dim box As ExceptionMessageBox = New ExceptionMessageBox(exTop)
        box.ShowCheckBox = True
        box.IsCheckBoxChecked = True
        box.CheckBoxText = "Always show this message"
        box.Show(Me)

        ' Set the global variable.
        alwaysShow = box.IsCheckBoxChecked
    End If
End Try

Remarks

The default value is "Do not show this message again".

Applies to