DialogResult DialogResult DialogResult DialogResult Enum

Definition

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

public enum class DialogResult
[System.Runtime.InteropServices.ComVisible(true)]
public enum DialogResult
type DialogResult = 
Public Enum DialogResult
Inheritance
Attributes

Fields

Abort Abort Abort Abort 3

The dialog box return value is Abort (usually sent from a button labeled Abort).

Cancel Cancel Cancel Cancel 2

The dialog box return value is Cancel (usually sent from a button labeled Cancel).

Ignore Ignore Ignore Ignore 5

The dialog box return value is Ignore (usually sent from a button labeled Ignore).

No No No No 7

The dialog box return value is No (usually sent from a button labeled No).

None None None None 0

Nothing is returned from the dialog box. This means that the modal dialog continues running.

OK OK OK OK 1

The dialog box return value is OK (usually sent from a button labeled OK).

Retry Retry Retry Retry 4

The dialog box return value is Retry (usually sent from a button labeled Retry).

Yes Yes Yes Yes 6

The dialog box return value is Yes (usually sent from a button labeled Yes).

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.

Applies to

See Also