Splitter.Dock Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

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 Splitter borders are docked to its parent control and determines how a Splitter 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 is Left.

Exceptions

ArgumentException

Dock is not set to one of the valid DockStyle values.

Remarks

Use the Dock property to define how a control is automatically resized as its parent control is resized. You can only set the Dock property to Top, Bottom, Left, or Right. The Splitter control enables the user to resize the docked control that is immediately before it in the docking order. Therefore, to enable the user to resize a docked control, dock the control to an edge of a container, and then dock a Splitter control to the same side of that container. For more information, see the example in the Splitter class.

Applies to