ToolStripItem.Dock Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ToolStripItem.cs

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

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

[System.ComponentModel.Browsable(false)]
public System.Windows.Forms.DockStyle Dock { get; set; }

[<System.ComponentModel.Browsable(false)>]
member this.Dock : System.Windows.Forms.DockStyle with get, set

Public Property Dock As DockStyle

Property Value

DockStyle

One of the DockStyle values. The default is None.

Attributes

BrowsableAttribute

Exceptions

InvalidEnumArgumentException

The value assigned is not one of the DockStyle values.

Remarks

This property applies only to flow layouts.

Use the Dock property to define how a ToolStripItem is automatically resized as its parent control is resized. For example, setting Dock to Left causes the ToolStripItem 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.

Note

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