DialogResult Enum

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

DialogResult.cs

Specifies identifiers to indicate the return value of a dialog box.

public enum class DialogResult

public enum DialogResult

type DialogResult = 

Public Enum DialogResult

Inheritance

Object

ValueType

Enum

DialogResult

Fields

Name	Value	Description
None	0	Nothing is returned from the dialog box. This means that the modal dialog continues running.
OK	1	The dialog box return value is OK (usually sent from a button labeled OK).
Cancel	2	The dialog box return value is Cancel (usually sent from a button labeled Cancel).
Abort	3	The dialog box return value is Abort (usually sent from a button labeled Abort).
Retry	4	The dialog box return value is Retry (usually sent from a button labeled Retry).
Ignore	5	The dialog box return value is Ignore (usually sent from a button labeled Ignore).
Yes	6	The dialog box return value is Yes (usually sent from a button labeled Yes).
No	7	The dialog box return value is No (usually sent from a button labeled No).
TryAgain	10	The dialog box return value is Try Again (usually sent from a button labeled Try Again).
Continue	11	The dialog box return value is Continue (usually sent from a button labeled Continue).

Examples

The following code example demonstrates how to display a MessageBox with the options supported by this overload of Show. After verifying that a string variable, ServerName, is empty, the example displays a MessageBox, offering the user the option to cancel the operation. If the Show method's return value evaluates to Yes, the form that displayed the MessageBox is closed.

private:
   void validateUserEntry5()
   {
      // Checks the value of the text.
      if ( serverName->Text->Length == 0 )
      {
         // Initializes the variables to pass to the MessageBox::Show method.
         String^ message = "You did not enter a server name. Cancel this operation?";
         String^ caption = "No Server Name Specified";
         MessageBoxButtons buttons = MessageBoxButtons::YesNo;
         System::Windows::Forms::DialogResult result;

         // Displays the MessageBox.
         result = MessageBox::Show( this, message, caption, buttons );
         if ( result == ::DialogResult::Yes )
         {
            // Closes the parent form.
            this->Close();
         }
      }
   }

private void validateUserEntry5()
{

    // Checks the value of the text.

    if(serverName.Text.Length == 0)
    {

        // Initializes the variables to pass to the MessageBox.Show method.

        string message = "You did not enter a server name. Cancel this operation?";
        string caption = "No Server Name Specified";
        MessageBoxButtons buttons = MessageBoxButtons.YesNo;
        DialogResult result;

        // Displays the MessageBox.

        result = MessageBox.Show(this, message, caption, buttons);

        if(result == DialogResult.Yes)
        {

            // Closes the parent form.

            this.Close();
        }
    }
}

Private Sub ValidateUserEntry5()

    ' Checks the value of the text.

    If ServerName.Text.Length = 0 Then

        ' Initializes variables to pass to the MessageBox.Show method.

        Dim Message As String = "You did not enter a server name. Cancel this operation?"
        Dim Caption As String = "No Server Name Specified"
        Dim Buttons As Integer = MessageBoxButtons.YesNo

        Dim Result As DialogResult

        'Displays a MessageBox using the Question icon and specifying the No button as the default.

        Result = MessageBox.Show(Me, Message, Caption, MessageBoxButtons.YesNo)

        ' Gets the result of the MessageBox display.

        If Result = System.Windows.Forms.DialogResult.Yes Then

            ' Closes the parent form.

            Me.Close()

        End If

    End If

End Sub

Remarks

The Button.DialogResult property and the Form.ShowDialog method use this enumeration.

See also

• Button
• Form