This documentation is archived and is not being maintained.

ToolBarButtonClickEventArgs Class

Provides data for the ButtonClick event.


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

Public Class ToolBarButtonClickEventArgs _
	Inherits EventArgs

The ToolBarButtonClickEventArgs type exposes the following members.

Public methodToolBarButtonClickEventArgsInitializes a new instance of the ToolBarButtonClickEventArgs class.

Public propertyButtonGets or sets the ToolBarButton that was clicked.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The event occurs whenever the user clicks on a button on a ToolBar control. The Button property contains the ToolBarButton wiith the information about the button that was clicked.

The following example instantiates a ToolBar and three ToolBarButton controls. The toolbar buttons are assigned to the button collection, the collection is assigned to the toolbar, and the toolbar is added to the form. On the ButtonClick event of the toolbar, the Button property of the ToolBarButtonClickEventArgs is evaluated, and the appropriate dialog opened. This code assumes that a Form, an OpenFileDialog, a SaveFileDialog, and a PrintDialog have been instantiated.

    Public Sub InitializeMyToolBar()
        ' Create and initialize the ToolBar and ToolBarButton controls.
        Dim toolBar1 As New ToolBar()
        Dim toolBarButton1 As New ToolBarButton()
        Dim toolBarButton2 As New ToolBarButton()
        Dim toolBarButton3 As New ToolBarButton()

        ' Set the Text properties of the ToolBarButton controls.
        toolBarButton1.Text = "Open"
        toolBarButton2.Text = "Save"
        toolBarButton3.Text = "Print"

        ' Add the ToolBarButton controls to the ToolBar.

        ' Add the event-handler delegate.
        AddHandler toolBar1.ButtonClick, AddressOf Me.toolBar1_ButtonClick

        ' Add the ToolBar to the Form.
    End Sub    

    Private Sub toolBar1_ButtonClick(ByVal sender As Object, _
    ByVal e As ToolBarButtonClickEventArgs)

        ' Evaluate the Button property to determine which button was clicked.
        Select Case toolBar1.Buttons.IndexOf(e.Button)
            Case 0
                ' Insert code to open the file.
            Case 1
                ' Insert code to save the file.
            Case 2
                ' Insert code to print the file.
        End Select
    End Sub

.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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.