IButtonControl Interface

Allows a control to act like a button on a form.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

'Declaration
Public Interface IButtonControl
'Usage
Dim instance As IButtonControl

public interface IButtonControl
public interface IButtonControl

An example of where this interface might be implemented is default and cancel button processing. Default buttons are notified when an unprocessed ENTER key is entered for a form, just like a dialog box would be closed. Similarly, cancel buttons are notified whenever an unprocessed ESC key is entered on a form, much like a dialog box would be dismissed.

Notes to Implementers Implement this interface in classes that act as button controls. The members of this interface will provide basic button functionality, such as providing a DialogResult to the parent form or the ability to perform a Click event, or acting as the default button of a form.

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.

Imports System
Imports System.Windows.Forms
Imports System.Drawing


Public Class MyButton
   Inherits ButtonBase
   Implements IButtonControl 
   Private myDialogResult As DialogResult
      
   Public Sub New()
      ' Make the button White and a Popup style
      ' so it can be distinguished on the form.
      Me.FlatStyle = FlatStyle.Popup
      Me.BackColor = Color.White
   End Sub
   
   ' Add implementation to the IButtonControl.DialogResult property.
   Public Property DialogResult() As DialogResult Implements IButtonControl.DialogResult
      Get
         Return Me.myDialogResult
      End Get
      
      Set
         If [Enum].IsDefined(GetType(DialogResult), value) Then
            Me.myDialogResult = value
         End If
      End Set
   End Property
   
   ' Add implementation to the IButtonControl.NotifyDefault method.
   Public Sub NotifyDefault(value As Boolean) Implements IButtonControl.NotifyDefault
      If Me.IsDefault <> value Then
         Me.IsDefault = value
      End If
   End Sub 
      
   ' Add implementation to the IButtonControl.PerformClick method.
   Public Sub PerformClick() Implements IButtonControl.PerformClick
      If Me.CanSelect Then
         Me.OnClick(EventArgs.Empty)
      End If
   End Sub

End Class

import System.*;
import System.Windows.Forms.*;
import System.Drawing.*;

public class MyButton extends ButtonBase implements IButtonControl
{
    private DialogResult myDialogResult;

    public MyButton()
    {
        // Make the button White and a Popup style
        // so it can be distinguished on the form.
        this.set_FlatStyle(get_FlatStyle().Popup);
        this.set_BackColor(Color.get_White());
    } //MyButton

    // Add implementation to the IButtonControl.DialogResult property.
    /** @property 
     */
    public DialogResult get_DialogResult()
    {
        return this.myDialogResult;
    } //get_DialogResult

    /** @property 
     */
    public void set_DialogResult(DialogResult value)
    {
        if (Enum.IsDefined(get_DialogResult().getClass().ToType(), value)) {
            this.myDialogResult = value;
        }
    }

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

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

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

Community Additions

ADD
Show: