StatusBarPanel.Width Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Gets or sets the width of the status bar panel within the StatusBar control.

public:
 property int Width { int get(); void set(int value); };

public int Width { get; set; }

member this.Width : int with get, set

Public Property Width As Integer

Property Value

Int32

The width, in pixels, of the StatusBarPanel.

Exceptions

ArgumentException

The width specified is less than the value of the MinWidth property.

Examples

The following code example demonstrates how to use the StatusBar.SizingGrip, Alignment, Width, AutoSize, and BorderStyle properties, and how to handle the StatusBar.PanelClick event.

To run the example, paste the following code into a form. Call the InitializeStatusBarPanels method in the form's constructor or Load event-handling method.

internal:
   System::Windows::Forms::StatusBar^ statusBar1;

private:
   void InitializeStatusBarPanels()
   {
      
      // Create a StatusBar control.
      statusBar1 = gcnew 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 += gcnew StatusBarPanelClickEventHandler( this, &Form1::statusBar1_PanelClick );
      
      // Create two StatusBarPanel objects to display in statusBar1.
      StatusBarPanel^ panel1 = gcnew StatusBarPanel;
      StatusBarPanel^ panel2 = gcnew 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.
   void statusBar1_PanelClick( Object^ /*sender*/, StatusBarPanelClickEventArgs^ e )
   {
      if ( e->StatusBarPanel->Text == System::DateTime::Now.ToShortTimeString() )
      {
         e->StatusBarPanel->Text = System::DateTime::Now.ToLongTimeString();
      }
   }

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();
    }
}

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

Remarks

The Width property always reflects the actual width of a StatusBarPanel and cannot be smaller than the MinWidth property. To automatically resize the width of the StatusBarPanel to the contents of the StatusBarPanel, you can use the AutoSize property.

See also

• MinWidth
• AutoSize