This documentation is archived and is not being maintained.

ToolStripPanel Class

Creates a container within which other controls can share horizontal or vertical space.

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

'Declaration
<ComVisibleAttribute(True)> _
<ToolboxBitmapAttribute(GetType(ToolStripPanel), "ToolStripPanel_standalone.bmp")> _
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)> _
Public Class ToolStripPanel _
	Inherits ContainerControl _
	Implements IComponent, IDisposable
'Usage
Dim instance As ToolStripPanel

Use a ToolStripPanel to hold one or more ToolStrip, MenuStrip, StatusStrip or user-defined controls.

You might find that one or more ToolStripPanel controls meet the needs of your application better than a ToolStripContainer if you do not need the four panels and the central ToolStripContentPanel.

You can use only one panel if you so choose, and ToolStripPanel works well in Multiple Document Interface (MDI) scenarios.

Each ToolStripPanel is expandable and collapsible.

The following code example demonstrates how to use ToolStripPanel controls with a multiple document interface (MDI).

' This code example demonstrates how to use ToolStripPanel 
' controls with a multiple document interface (MDI). 
Public Class Form1
   Inherits Form

   Public Sub New()
      ' Make the Form an MDI parent. 
      Me.IsMdiContainer = True 

      ' Create ToolStripPanel controls. 
      Dim tspTop As New ToolStripPanel()
      Dim tspBottom As New ToolStripPanel()
      Dim tspLeft As New ToolStripPanel()
      Dim tspRight As New ToolStripPanel()

      ' Dock the ToolStripPanel controls to the edges of the form.
      tspTop.Dock = DockStyle.Top
      tspBottom.Dock = DockStyle.Bottom
      tspLeft.Dock = DockStyle.Left
      tspRight.Dock = DockStyle.Right

      ' Create ToolStrip controls to move among the  
      ' ToolStripPanel controls. 
      ' Create the "Top" ToolStrip control and add 
      ' to the corresponding ToolStripPanel. 
      Dim tsTop As New ToolStrip()
      tsTop.Items.Add("Top")
      tspTop.Join(tsTop)

      ' Create the "Bottom" ToolStrip control and add 
      ' to the corresponding ToolStripPanel. 
      Dim tsBottom As New ToolStrip()
      tsBottom.Items.Add("Bottom")
      tspBottom.Join(tsBottom)

      ' Create the "Right" ToolStrip control and add 
      ' to the corresponding ToolStripPanel. 
      Dim tsRight As New ToolStrip()
      tsRight.Items.Add("Right")
      tspRight.Join(tsRight)

      ' Create the "Left" ToolStrip control and add 
      ' to the corresponding ToolStripPanel. 
      Dim tsLeft As New ToolStrip()
      tsLeft.Items.Add("Left")
      tspLeft.Join(tsLeft)

      ' Create a MenuStrip control with a new window. 
      Dim ms As New MenuStrip()
      Dim windowMenu As New ToolStripMenuItem("Window")
      Dim windowNewMenu As New ToolStripMenuItem("New", Nothing, New EventHandler(AddressOf windowNewMenu_Click))
      windowMenu.DropDownItems.Add(windowNewMenu)
      CType(windowMenu.DropDown, ToolStripDropDownMenu).ShowImageMargin = False
      CType(windowMenu.DropDown, ToolStripDropDownMenu).ShowCheckMargin = True 

      ' Assign the ToolStripMenuItem that displays  
      ' the list of child forms.
      ms.MdiWindowListItem = windowMenu

      ' Add the window ToolStripMenuItem to the MenuStrip.
      ms.Items.Add(windowMenu)

      ' Dock the MenuStrip to the top of the form.
      ms.Dock = DockStyle.Top

      ' The Form.MainMenuStrip property determines the merge target. 
      Me.MainMenuStrip = ms

      ' Add the ToolStripPanels to the form in reverse order. 
      Me.Controls.Add(tspRight)
      Me.Controls.Add(tspLeft)
      Me.Controls.Add(tspBottom)
      Me.Controls.Add(tspTop)

      ' Add the MenuStrip last. 
      ' This is important for correct placement in the z-order. 
      Me.Controls.Add(ms)
    End Sub 

   ' This event handler is invoked when  
   ' the "New" ToolStripMenuItem is clicked. 
   ' It creates a new Form and sets its MdiParent  
   ' property to the main form. 
    Private Sub windowNewMenu_Click(ByVal sender As Object, ByVal e As EventArgs)
        Dim f As New Form()
        f.MdiParent = Me
        f.Text = "Form - " + Me.MdiChildren.Length.ToString()
        f.Show()
    End Sub 
End Class

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

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
Show: