DialogResult Enumeration
TOC
Collapse the table of content
Expand the table of content

DialogResult Enumeration

 

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

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

[ComVisibleAttribute(true)]
public enum DialogResult

Member nameDescription
Abort

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

Cancel

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

Ignore

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

No

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

None

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

OK

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

Retry

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

Yes

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

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

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;
		DialogResult result;

		// Displays the MessageBox.

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

		if(result == DialogResult.Yes)
		{

			// Closes the parent form.

			this.Close();

		}

	}

}

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft