ToolStrip.Dock Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Source:: ToolStrip.cs

Source:: ToolStrip.cs

Source:: ToolStrip.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets which ToolStrip borders are docked to its parent control and determines how a ToolStrip is resized with its parent.

public:
 virtual property System::Windows::Forms::DockStyle Dock { System::Windows::Forms::DockStyle get(); void set(System::Windows::Forms::DockStyle value); };

public override System.Windows.Forms.DockStyle Dock { get; set; }

member this.Dock : System.Windows.Forms.DockStyle with get, set

Public Overrides Property Dock As DockStyle

Property Value

DockStyle

One of the DockStyle values. The default value is Top.

Examples

The following code example demonstrates the syntax for setting common ToolStrip properties, including the Dock property.

// This is an example of some common ToolStrip property settings.
// 
toolStrip1.AllowDrop = false;
toolStrip1.AllowItemReorder = true;
toolStrip1.AllowMerge = false;
toolStrip1.Anchor = ((System.Windows.Forms.AnchorStyles)(((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Left)
            | System.Windows.Forms.AnchorStyles.Right)));
toolStrip1.AutoSize = false;
toolStrip1.CanOverflow = false;
toolStrip1.Cursor = System.Windows.Forms.Cursors.Cross;
toolStrip1.DefaultDropDownDirection = System.Windows.Forms.ToolStripDropDownDirection.BelowRight;
toolStrip1.Dock = System.Windows.Forms.DockStyle.None;
toolStrip1.GripMargin = new System.Windows.Forms.Padding(3);
toolStrip1.Items.AddRange(new System.Windows.Forms.ToolStripItem[] {
toolStripButton1});
toolStrip1.ImageScalingSize = new System.Drawing.Size(20, 20);
toolStrip1.LayoutStyle = System.Windows.Forms.ToolStripLayoutStyle.HorizontalStackWithOverflow;
toolStrip1.Location = new System.Drawing.Point(0, 0);
toolStrip1.Margin = new System.Windows.Forms.Padding(1);
toolStrip1.Name = "toolStrip1";
toolStrip1.Padding = new System.Windows.Forms.Padding(0, 0, 2, 0);
toolStrip1.RenderMode = System.Windows.Forms.ToolStripRenderMode.System;
toolStrip1.ShowItemToolTips = false;
toolStrip1.Size = new System.Drawing.Size(109, 273);
toolStrip1.Stretch = true;
toolStrip1.TabIndex = 0;
toolStrip1.TabStop = true;
toolStrip1.Text = "toolStrip1";
toolStrip1.TextDirection = System.Windows.Forms.ToolStripTextDirection.Vertical90;

' This is an example of some common ToolStrip property settings.
' 
toolStrip1.AllowDrop = False
toolStrip1.AllowItemReorder = True
toolStrip1.AllowMerge = False
toolStrip1.Anchor = CType(System.Windows.Forms.AnchorStyles.Top Or System.Windows.Forms.AnchorStyles.Left Or System.Windows.Forms.AnchorStyles.Right, System.Windows.Forms.AnchorStyles)
toolStrip1.AutoSize = False
toolStrip1.CanOverflow = False
toolStrip1.Cursor = Cursors.Cross
toolStrip1.Dock = System.Windows.Forms.DockStyle.None
toolStrip1.DefaultDropDownDirection = ToolStripDropDownDirection.BelowRight
toolStrip1.GripMargin = New System.Windows.Forms.Padding(3)
toolStrip1.ImageScalingSize = New System.Drawing.Size(20, 20)
toolStrip1.Items.AddRange(New System.Windows.Forms.ToolStripItem() {toolStripButton1})
toolStrip1.LayoutStyle = System.Windows.Forms.ToolStripLayoutStyle.HorizontalStackWithOverflow
toolStrip1.Location = New System.Drawing.Point(0, 0)
toolStrip1.Margin = New System.Windows.Forms.Padding(1)
toolStrip1.Name = "toolStrip1"
toolStrip1.Padding = New System.Windows.Forms.Padding(0, 0, 2, 0)
toolStrip1.RenderMode = System.Windows.Forms.ToolStripRenderMode.System
toolStrip1.ShowItemToolTips = False
toolStrip1.Size = New System.Drawing.Size(109, 273)
toolStrip1.Stretch = True
toolStrip1.TabIndex = 0
toolStrip1.TabStop = True
toolStrip1.Text = "toolStrip1"
toolStrip1.TextDirection = System.Windows.Forms.ToolStripTextDirection.Vertical90

Remarks

Use the Dock property to define how a ToolStrip is automatically resized as its parent control is resized. For example, setting Dock to Left causes the ToolStrip to align itself with the left edges of its parent control and to resize as the parent control is resized. Controls are docked in their z-order, which is the visual layering of controls on a form along the form's z-axis (depth).

A control can be docked to one edge of its parent container or can be docked to all edges and fill the parent container.

If the ToolStrip control is in a ToolStripPanel, the ToolStrip can be repositioned within the ToolStripPanel and across ToolStripPanels. The Dock property is ignored, and if the Stretch property is false, the size of the ToolStrip grows as items are added to the ToolStripPanel. Typically, the ToolStrip does not participate in the tab order.

Note

The Anchor and Dock properties are mutually exclusive. Only one can be set at a time, and the last one set takes precedence.

Applies to

Jaa