• Article

ExceptionMessageBox.ShowCheckBox Property

Specifies whether to show the check box in the exception message box.

Namespace:  Microsoft.SqlServer.MessageBox
Assembly:  Microsoft.ExceptionMessageBox (in Microsoft.ExceptionMessageBox.dll)

Syntax

'Declaration
Public Property ShowCheckBox As Boolean
    Get
    Set
'Usage
Dim instance As ExceptionMessageBox
Dim value As Boolean

value = instance.ShowCheckBox

instance.ShowCheckBox = value

public bool ShowCheckBox { get; set; }

public:
property bool ShowCheckBox {
    bool get ();
    void set (bool value);
}

member ShowCheckBox : bool with get, set

function get ShowCheckBox () : boolean
function set ShowCheckBox (value : boolean)

Property Value

Type: System.Boolean
A Boolean value.

Remarks

The value of the check box can be evaluated at runtime when an exception occurs to determine whether to display the exception message box. For more information, see How to: Program Exception Message Box.

The default value is false.

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