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
Dim instance As ToolBarButtonClickEventArgs

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


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

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

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

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0