Share via

  • Article

ExceptionMessageBox.CheckBoxRegistryKey Property

Sets an opened RegistryKey that controls the check box that is displayed on the exception message box when ShowCheckbox() is true.

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

Syntax

'Declaration
Public Property CheckBoxRegistryKey As RegistryKey
    Get
    Set
'Usage
Dim instance As ExceptionMessageBox
Dim value As RegistryKey

value = instance.CheckBoxRegistryKey

instance.CheckBoxRegistryKey = value

public RegistryKey CheckBoxRegistryKey { get; set; }

public:
property RegistryKey^ CheckBoxRegistryKey {
    RegistryKey^ get ();
    void set (RegistryKey^ value);
}

member CheckBoxRegistryKey : RegistryKey with get, set

function get CheckBoxRegistryKey () : RegistryKey
function set CheckBoxRegistryKey (value : RegistryKey)

Property Value

Type: Microsoft.Win32.RegistryKey

Remarks

This property is used with CheckBoxRegistryValue to initialize the selected state of the check box. If the specified registry value exists and contains a non-zero value, the check box is displayed as selected; otherwise, the check box is displayed as clear. If CheckBoxRegistryMeansDoNotShowDialog is true and the registry value exists and contains a non-zero value, the message box is not displayed and ExceptionMessageBox returns DefaultDialogResult when Show is called.

The RegistryKey must be opened by the application prior to calling Show.

Examples

           try
            {
                // Do something that could generate an exception.
                throw new ApplicationException("An error has occured.");
            }
            catch (ApplicationException ex)
            {
                string str = "The action failed. Do you want to continue?";
                ApplicationException exTop = new ApplicationException(str, ex);
                exTop.Source = this.Text;

                // Show a message box with Yes and No buttons
                ExceptionMessageBox box = new ExceptionMessageBox(exTop,
                    ExceptionMessageBoxButtons.YesNo,
                    ExceptionMessageBoxSymbol.Question,
                    ExceptionMessageBoxDefaultButton.Button2);

                // Enable the check box.
                box.ShowCheckBox = true;

                // Define the registry key to use.
                box.CheckBoxRegistryKey =
                    Microsoft.Win32.Registry.CurrentUser.CreateSubKey(
                    @"Software\TestApp");
                box.CheckBoxRegistryValue = "DontShowActionFailedMessage";
                box.CheckBoxRegistryMeansDoNotShowDialog = true;
                box.DefaultDialogResult = DialogResult.Yes;

                // The message box won�t be displayed if the
                // "DontShowActionFailedMessage" value of the registry key 
                // contains a non-zero value.
                if (box.Show(this) == DialogResult.No)
                {
                    // Do something if the user clicks the No button.
                    this.Close();
                }
            }

Try
    ' Do something that could generate an exception.
    Throw New ApplicationException("An error has occured.")
Catch ex As ApplicationException
    Dim str As String = "The action failed. Do you want to continue?"
    Dim exTop As ApplicationException = New ApplicationException(str, ex)
    exTop.Source = Me.Text

    ' Show a message box with Yes and No buttons
    Dim box As ExceptionMessageBox = New ExceptionMessageBox(exTop, _
     ExceptionMessageBoxButtons.YesNo, _
     ExceptionMessageBoxSymbol.Question, _
     ExceptionMessageBoxDefaultButton.Button2)

    ' Enable the check box.
    box.ShowCheckBox = True

    ' Define the registry key to use.
    box.CheckBoxRegistryKey = _
    Microsoft.Win32.Registry.CurrentUser.CreateSubKey( _
     "Software\TestApp")
    box.CheckBoxRegistryValue = "DontShowActionFailedMessage"
    box.CheckBoxRegistryMeansDoNotShowDialog = True
    box.DefaultDialogResult = Windows.Forms.DialogResult.Yes

    ' The message box won�t be displayed if the
    ' "DontShowActionFailedMessage" value of the registry key 
    ' contains a non-zero value.
    If box.Show(Me) = Windows.Forms.DialogResult.No Then
        ' Do something if the user clicks the No button.
        Me.Close()
    End If
End Try