ICreate.Controls.Bars Send comments on this topic.
ButtonBarButtonEventArgs Class
See Also  Members   Example 
ICreate.Controls.Bars Namespace : ButtonBarButtonEventArgs Class






Identifies the ButtonBarButton for the ItemSelected, SubItemSelected, ItemHot and ItemCold events.

Object Model


Syntax

Visual Basic (Declaration) 
Public Class ButtonBarButtonEventArgs
Visual Basic (Usage)Copy Code
Dim instance As ButtonBarButtonEventArgs
C# 
public class ButtonBarButtonEventArgs
Delphi 
public class ButtonBarButtonEventArgs
JScript 
public class ButtonBarButtonEventArgs
Managed Extensions for C++ 
public __gc class ButtonBarButtonEventArgs
C++/CLI 
public ref class ButtonBarButtonEventArgs

Example

The example below shows how to implement ItemSelected, SubItemSelected, ItemHot and ItemCold events handlers. The example creates a ButtonBar containing three buttons: New; Open and Save. When the mouse cursor moves onto a ButtonBarButton the ItemHot event sets the text on the status bar to a short explanation of the purpose ButtonBarButton. The text is cleared when the mouse cursor leaves the ButtonBarButton and the ItemCold event generated.
C#Copy Code
using System; 
using System.Drawing; 
using System.Windows.Forms; 
using ICreate.Controls.Bars; 
 
namespace ExamplesButtonBarCSharp 
{ 
    public partial class EventsExample : Form 
    { 
        private StatusBar statusBar; 
 
        public EventsExample() 
        { 
            InitializeComponent(); 
            ButtonBar buttonBar = new ButtonBar(); 
            buttonBar.Dock = DockStyle.Top; 
            statusBar = new StatusBar(); 
 
            ButtonBarButton buttonNew = new ButtonBarButton("New", Image.FromFile(@"Resources\new.png")); 
            ButtonBarButton buttonOpen = new ButtonBarButton("Open", Image.FromFile(@"Resources\open.png")); 
            ButtonBarButton buttonSave = new ButtonBarButton("Save", Image.FromFile(@"Resources\save.png")); 
 
            buttonNew.SubButton = true; 
 
            buttonBar.Items.Add(buttonNew); 
            buttonBar.Items.Add(buttonOpen); 
            buttonBar.Items.Add(buttonSave); 
 
            this.Controls.Add(buttonBar); 
            this.Controls.Add(statusBar); 
 
            buttonBar.ItemHot += new ButtonBarButtonEventHandler(OnItemHot);  
            buttonBar.ItemCold += new ButtonBarButtonEventHandler(OnItemCold); 
            buttonBar.ItemSelected += new ButtonBarButtonEventHandler(OnItemSelected); 
            buttonBar.SubItemSelected += new ButtonBarButtonEventHandler(OnSubItemSelected); 
 
        } 
 
        void OnItemHot(object sender, ButtonBarButtonEventArgs e) 
        { 
            string message = ""; 
 
            if (e.Button.Text == "New") 
                message = "Creates a new document."; 
            else if (e.Button.Text == "Open") 
                message = "Opens an existing document."; 
            else if (e.Button.Text == "Save") 
                message = "Save the open document."; 
 
            statusBar.Text = message; 
        } 
 
        void OnItemCold(object sender, ButtonBarButtonEventArgs e) 
        { 
            statusBar.Text = ""; 
        } 
 
        void OnItemSelected(object sender, ButtonBarButtonEventArgs args) 
        { 
            MessageBox.Show(args.Button.Text + " clicked."); 
        } 
 
        void OnSubItemSelected(object sender, ButtonBarButtonEventArgs args) 
        { 
            MessageBox.Show(args.Button.Text + " sub button clicked."); 
        } 
    } 
}
Visual BasicCopy Code
Imports ICreate.Controls.Bars

Public Class EventsExample

    Private StatusBar As StatusBar

    Public Sub New()
        InitializeComponent()

        Dim buttonBar As ButtonBar = New ButtonBar
        buttonBar.Dock = DockStyle.Top
        StatusBar = New StatusBar

        Dim buttonNew As ButtonBarButton = New ButtonBarButton("New", Image.FromFile("Resources\new.png"))
        Dim buttonOpen As ButtonBarButton = New ButtonBarButton("Open", Image.FromFile("Resources\open.png"))
        Dim buttonSave As ButtonBarButton = New ButtonBarButton("Save", Image.FromFile("Resources\save.png"))

        buttonNew.SubButton = True
        buttonBar.Items.Add(buttonNew)
        buttonBar.Items.Add(buttonOpen)
        buttonBar.Items.Add(buttonSave)

        Me.Controls.Add(buttonBar)
        Me.Controls.Add(StatusBar)

        AddHandler buttonBar.ItemHot, AddressOf OnItemHot
        AddHandler buttonBar.ItemCold, AddressOf OnItemCold
        AddHandler buttonBar.ItemSelected, AddressOf OnItemSelected
        AddHandler buttonBar.SubItemSelected, AddressOf OnSubItemSelected

    End Sub

    Sub OnItemHot(ByVal sender As Object, ByVal e As ButtonBarButtonEventArgs)
        Dim message As String = ""
        If e.Button.Text = "New" Then
            message = "Creates a new document."
        Else
            If e.Button.Text = "Open" Then
                message = "Opens an existing document."
            Else
                If e.Button.Text = "Save" Then
                    message = "Save the open document."
                End If
            End If
        End If
        StatusBar.Text = message
    End Sub

    Sub OnItemCold(ByVal sender As Object, ByVal e As ButtonBarButtonEventArgs)
        StatusBar.Text = ""
    End Sub

    Sub OnItemSelected(ByVal sender As Object, ByVal args As ButtonBarButtonEventArgs)
        MessageBox.Show(args.Button.Text + " clicked.")
    End Sub

    Sub OnSubItemSelected(ByVal sender As Object, ByVal args As ButtonBarButtonEventArgs)
        MessageBox.Show(args.Button.Text + " sub button clicked.")
    End Sub

End Class

Remarks

The ItemSelected event is raised when the user clicks on a ButtonBarButton, or when the ButtonBarButton has input focus and the enter key or space bar is pressed. The SubItemSelected is raised when the user clicks the sub button of a ButtonBarButton, or when the sub button has input focus and the enter key or space bar is pressed. The ItemHot is raised when the mouse cursor moves onto a ButtonBarButton. The ItemCold event is raised when the mouse cursor moves off a ButtonBarButton.

Inheritance Hierarchy

System.Object
   ICreate.Controls.Bars.ButtonBarButtonEventArgs

Requirements

Namespace: ICreate.Controls.Bars

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Assembly: ICreate.Controls.Bars (in ICreate.Controls.Bars.dll)

See Also