This topic has not yet been rated - Rate this topic

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

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.