DialogResult Property
Collapse the table of content
Expand the table of content

IButtonControl.DialogResult Property

 

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

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

DialogResult DialogResult { get; set; }

Property Value

Type: System.Windows.Forms.DialogResult

One of the DialogResult values.

When a form is shown as a dialog box using the ShowDialog method and one of its buttons is clicked, the button's DialogResult value is assigned to the form's DialogResult property.

The following example inherits from the ButtonBase class and implements the IButtonControl interface. Implementation is added to the DialogResult property and the NotifyDefault and PerformClick methods.

using System;
using System.Windows.Forms;
using System.Drawing;

public class MyButton : ButtonBase, IButtonControl
{
	private DialogResult myDialogResult;

	public MyButton()
	{
		// Make the button White and a Popup style
		// so it can be distinguished on the form.
		this.FlatStyle = FlatStyle.Popup;
		this.BackColor = Color.White;
	}

	// Add implementation to the IButtonControl.DialogResult property.
	public DialogResult DialogResult
	{
		get
		{
			return this.myDialogResult;
		}

		set
		{
			if(Enum.IsDefined(typeof(DialogResult), value))				
			{
				this.myDialogResult = value;
			}
		}	
	}

	// Add implementation to the IButtonControl.NotifyDefault method.
	public void NotifyDefault(bool value)
	{
		if(this.IsDefault != value)
		{
			this.IsDefault = value;
		}
	}

	// Add implementation to the IButtonControl.PerformClick method.
	public void PerformClick()
	{
		if(this.CanSelect)
		{
			this.OnClick(EventArgs.Empty);
		}
	}
}

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