[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] | Reference for unit 'Controls' (#lcl)

# TDockZone

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Represents a node in a TDockTree

## Declaration

Source position: controls.pp line 2524

`type TDockZone = class`
`protected`
`function GetHeight; virtual;` |  | Gets the value for the Height property.
`function GetLeft; virtual;` |  | Gets the value for the Left property.
`function GetLimitBegin; virtual;` |  | Gets the value for the LimitBegin property.
`function GetLimitSize; virtual;` |  | Gets the value for the LimitSize property.
`function GetTop; virtual;` |  | Gets the value for the Top property.
`function GetVisible; virtual;` |  | Gets the value for the Visible property.
`function GetVisibleChildCount; virtual;` |  | Gets the value for the VisibleChildCount property.
`function GetWidth; virtual;` |  | Gets the value for the Width property.
`procedure SetLimitBegin(); virtual;` |  | Sets the value for the LimitBegin property.
`procedure SetLimitSize(); virtual;` |  | New value for the LimitSize property.
`procedure SetHeight(); virtual;` |  | Sets the value for the Height property.
`procedure SetLeft(); virtual;` |  | Sets the value for the Left property.
`procedure SetTop(); virtual;` |  | Sets the value for the Top property.
`procedure SetWidth(); virtual;` |  | Sets the value for the Width property.
`public`
`constructor Create();` |  | Constructor for the class instance.
`function FindZone();` |  | Returns the dock zone containing the given control.
`function FirstVisibleChild;` |  | The first visible child zone.
`function GetNextVisibleZone;` |  | The next visible zone.
`function NextVisible;` |  | The next visible zone.
`function PrevVisible;` |  | The preceding visible zone.
`procedure AddSibling();` |  | Inserts NewZone as preceding or following sibling.
`procedure AddAsFirstChild();` |  | Adds the given zone as the first child.
`procedure AddAsLastChild();` |  | Adds the given zone as the last child.
`procedure ReplaceChild();` |  | Replace the OldChild zone by NewChild.
`function GetLastChild;` |  | The last child zone.
`function GetIndex;` |  | Calculates the index of the zone within its parent zone.
`procedure Remove();` |  | Unlinks the given child zone.
`property ChildControl: TControl; [r]` |  | The control docked in this zone.
`property ChildCount: Integer; [r]` |  | The number of child zones.
`property FirstChild: TDockZone; [r]` |  | The first child zone.
`property Height: Integer; [rw]` |  | The height of the zone.
`property Left: Integer; [rw]` |  | The left coordinate of the zone.
`property LimitBegin: Integer; [rw]` |  | The free coordinate of the DockZone (Left or Top).
`property LimitSize: Integer; [rw]` |  | The free size of the DockZone (Width or Height).
`property Orientation: TDockOrientation; [rw]` |  | Whether docking is oriented vertically, horizontally, in pages, or not at all.
`property Parent: TDockZone; [r]` |  | The parent zone in the DockTree.
`property Top: Integer; [rw]` |  | The top coordinate for the dock zone.
`property Tree: TDockTree; [r]` |  | The dock tree of which this dock zone is a part.
`property Visible: Boolean; [r]` |  | A zone is visible if it contains a visible control, or if any child zone is visible.
`property VisibleChildCount: Integer; [r]` |  | The number of visible child zones.
`property Width: Integer; [rw]` |  | The width of this zone.
`property NextSibling: TDockZone; [r]` |  | The next sibling zone.
`property PrevSibling: TDockZone; [r]` |  | The preceding sibling zone.
`end;`

## Inheritance

`TDockZone` |  | Represents a node in a TDockTree
`TObject`

## Description

It encapsulates a dock zone, containing either other zones or a single control.

This implementation is specific to TDockTree. Another DockManager can (and should) use its own class instead.

## See also

TDockTree |  | A tree of TDockZone instances where each docked window has one tree.