Button.DialogResult Property


Gets or sets a value that is returned to the parent form when the button is clicked.

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

abstract DialogResult : DialogResult with get, set
override DialogResult : DialogResult with get, set

Property Value

Type: System.Windows.Forms.DialogResult

One of the DialogResult values. The default value is None.

Exception Condition

The value assigned is not one of the DialogResult values.

If the DialogResult for this property is set to anything other than None, and if the parent form was displayed through the ShowDialog method, clicking the button closes the parent form without your having to hook up any events. The form's DialogResult property is then set to the DialogResult of the button when the button is clicked.

For example, to create a "Yes/No/Cancel" dialog box, simply add three buttons and set their DialogResult properties to Yes, No, and Cancel.

The following code example creates a Button, sets its DialogResult property to OK, and adds it to a Form.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Return to top