This documentation is archived and is not being maintained.

StatusBar.PanelClick Event

Occurs when a StatusBarPanel object on a StatusBar control is clicked.

[Visual Basic]
Public Event PanelClick As StatusBarPanelClickEventHandler
[C#]
public event StatusBarPanelClickEventHandler PanelClick;
[C++]
public: __event StatusBarPanelClickEventHandler* PanelClick;

[JScript] In JScript, you can handle the events defined by a class, but you cannot define your own.

Event Data

The event handler receives an argument of type StatusBarPanelClickEventArgs containing data related to this event. The following StatusBarPanelClickEventArgs properties provide information specific to this event.

Property Description
Button (inherited from MouseEventArgs) Gets which mouse button was pressed.
Clicks (inherited from MouseEventArgs) Gets the number of times the mouse button was pressed and released.
Delta (inherited from MouseEventArgs) Gets a signed count of the number of detents the mouse wheel has rotated. A detent is one notch of the mouse wheel.
StatusBarPanel Gets the StatusBarPanel to draw.
X (inherited from MouseEventArgs) Gets the x-coordinate of the mouse.
Y (inherited from MouseEventArgs) Gets the y-coordinate of the mouse.

Remarks

You can use this event to perform tasks when a panel within a StatusBar control is clicked. The data provided to the event through the StatusBarPanelClickEventArgs object passed as a parameter to the event handler enables you to determine the StatusBarPanel object that was clicked by the user in order to perform tasks on the selected panel.

For more information about handling events, see Consuming Events.

Example

[Visual Basic, C#] The following code example demonstrates how to use the SizingGrip, Dock, Alignment, Width, AutoSize, and BorderStyle members and how to handle the PanelClick event.

[Visual Basic, C#] To run the example, paste the following code in a form. Call the InitializeStatusBarPanels method in the form's constructor or Load method.

[Visual Basic] 

    Friend WithEvents statusBar1 As System.Windows.Forms.StatusBar

    Private Sub InitializeStatusBarPanels()

        ' Create a StatusBar control.
        statusBar1 = New StatusBar

        ' Dock the status bar at the top of the form. 
        statusBar1.Dock = DockStyle.Top

        ' Set the SizingGrip property to false so the user cannot 
        ' resize the status bar.
        statusBar1.SizingGrip = False

        ' Create two StatusBarPanel objects to display in statusBar1.
        Dim panel1 As New StatusBarPanel
        Dim panel2 As New StatusBarPanel

        ' Set the width of panel2 explicitly and set
        ' panel1 to fill in the remaining space.
        panel2.Width = 80
        panel1.AutoSize = StatusBarPanelAutoSize.Spring

        ' Set the text alignment within each panel.
        panel1.Alignment = HorizontalAlignment.Left
        panel2.Alignment = HorizontalAlignment.Right

        ' Display the first panel without a border and the second
        ' with a raised border.
        panel1.BorderStyle = StatusBarPanelBorderStyle.None
        panel2.BorderStyle = StatusBarPanelBorderStyle.Raised

        ' Set the text of the panels. The panel1 object is reserved
        ' for line numbers, while panel2 is set to the current time.
        panel1.Text = "Reserved for important information."
        panel2.Text = System.DateTime.Now.ToShortTimeString

        ' Set a tooltip for panel2
        panel2.ToolTipText = "Click time to display seconds"

        ' Display panels in statusBar1 and add them to the
        ' status bar's StatusBarPanelCollection.
        statusBar1.ShowPanels = True
        statusBar1.Panels.Add(panel1)
        statusBar1.Panels.Add(panel2)

        ' Add the StatusBar to the form.
        Me.Controls.Add(statusBar1)
    End Sub


    ' If the user clicks the status bar, check the text of the 
    ' StatusBarPanel.  If the text equals a short time string,
    ' change it to long time display.
    Private Sub statusBar1_PanelClick(ByVal sender As Object, _
        ByVal e As StatusBarPanelClickEventArgs) _
            Handles statusBar1.PanelClick
        If (e.StatusBarPanel.Text = _
            System.DateTime.Now.ToShortTimeString) Then
            e.StatusBarPanel.Text = System.DateTime.Now.ToLongTimeString
        End If
    End Sub

[C#] 

internal System.Windows.Forms.StatusBar statusBar1;

private void InitializeStatusBarPanels()
{

    // Create a StatusBar control.
    statusBar1 = new StatusBar();

    // Dock the status bar at the top of the form. 
    statusBar1.Dock = DockStyle.Top;

    // Set the SizingGrip property to false so the user cannot 
    // resize the status bar.
    statusBar1.SizingGrip = false;

    // Associate the event-handling method with the 
    // PanelClick event.
    statusBar1.PanelClick += 
        new StatusBarPanelClickEventHandler(statusBar1_PanelClick);

    // Create two StatusBarPanel objects to display in statusBar1.
    StatusBarPanel panel1 = new StatusBarPanel();
    StatusBarPanel panel2 = new StatusBarPanel();

    // Set the width of panel2 explicitly and set
    // panel1 to fill in the remaining space.
    panel2.Width = 80;
    panel1.AutoSize = StatusBarPanelAutoSize.Spring;

    // Set the text alignment within each panel.
    panel1.Alignment = HorizontalAlignment.Left;
    panel2.Alignment = HorizontalAlignment.Right;

    // Display the first panel without a border and the second
    // with a raised border.
    panel1.BorderStyle = StatusBarPanelBorderStyle.None;
    panel2.BorderStyle = StatusBarPanelBorderStyle.Raised;

    // Set the text of the panels. The panel1 object is reserved
    // for line numbers, while panel2 is set to the current time.
    panel1.Text = "Reserved for important information.";
    panel2.Text = System.DateTime.Now.ToShortTimeString();

    // Set a tooltip for panel2
    panel2.ToolTipText = "Click time to display seconds";

    // Display panels in statusBar1 and add them to the
    // status bar's StatusBarPanelCollection.
    statusBar1.ShowPanels = true;
    statusBar1.Panels.Add(panel1);
    statusBar1.Panels.Add(panel2);

    // Add the StatusBar to the form.
    this.Controls.Add(statusBar1);
}


// If the user clicks the status bar, check the text of the 
// StatusBarPanel.  If the text equals a short time string,
// change it to long time display.
private void statusBar1_PanelClick(object sender, 
    StatusBarPanelClickEventArgs e)
{
    if (e.StatusBarPanel.Text == 
        System.DateTime.Now.ToShortTimeString())
    {
        e.StatusBarPanel.Text = 
            System.DateTime.Now.ToLongTimeString();
    }
}

[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

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

See Also

StatusBar Class | StatusBar Members | System.Windows.Forms Namespace | OnPanelClick | StatusBarPanelClickEventArgs | StatusBarPanelClickEventHandler

Show: