[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 an node in an TDockTree.

## Declaration

Source position: controls.pp line 2054

`type TDockZone = class`
`protected`
`function GetHeight; virtual;` |  | GetHeight - returns height for dock zone
`function GetLeft; virtual;` |  | GetLeft - returns the position of the left hand border
`function GetLimitBegin; virtual;` |  | GetLimitBegin - returns the limit for the beginning of the zone
`function GetLimitSize; virtual;` |  | GetLimitSize - returns the limit for the size of the zone
`function GetTop; virtual;` |  | GetTop - returns the position of the top
`function GetVisible; virtual;` |  | GetVisible - returns the Visible status
`function GetVisibleChildCount; virtual;` |  | GetVisibleChildCount - returns the number of visible children
`function GetWidth; virtual;` |  | GetWidth - returns the width of the zone
`procedure SetLimitBegin(); virtual;` |  | SetLimitBegin - specifies the limit for the beginning of the zone
`procedure SetLimitSize(); virtual;` |  | SetLimitSize - specifies the limit for the size of the zone
`procedure SetHeight(); virtual;` |  | SetHeight - specifies the height of the zone
`procedure SetLeft(); virtual;` |  | SetLeft - specifies the left side of the zone
`procedure SetTop(); virtual;` |  | SetTop - specifies the top of the zone
`procedure SetWidth(); virtual;` |  | SetWidth - specifies the width of the zone
`public`
`constructor Create();` |  | Create - constructor for TDockZone: sets local variables to show the Tree and the ChildControl, sets default bounds and then performs inherited Create
`function FindZone();` |  | FindZone - returns the Dockzone for the nominated control
`function FirstVisibleChild;` |  | FirstVisibleChild - returns the first visible child zone
`function GetNextVisibleZone;` |  | GetNextVisibleZone - returns the next visible zone
`function NextVisible;` |  | NextVisible - returns next visible
`function PrevVisible;` |  | PrevVisible - returns the previous visible
`procedure AddSibling();` |  | AddSibling - insers a new sibling control into the dock zone
`procedure AddAsFirstChild();` |  | AddAsFirstChild - add a new zone as the first child
`procedure AddAsLastChild();` |  | AddAsLastChild - add an new zone as the last child
`procedure ReplaceChild();` |  | ReplaceChild - replace the OldChild zone with the NewChild
`function GetLastChild;` |  | GetLastChild - returns the last child zone
`function GetIndex;` |  | GetIndex - returns the index of the current zone
`procedure Remove();` |  | Remove the nominated child zone
`property ChildControl: TControl; [r]` |  | The child control to be docked here
`property ChildCount: Integer; [r]` |  | The number of child controls for docking
`property FirstChild: TDockZone; [r]` |  | The first child control in the list of controls for docking
`property Height: Integer; [rw]` |  | The height of this control
`property Left: Integer; [rw]` |  | The position of the left side to the control
`property LimitBegin: Integer; [rw]` |  | The beginning limit of the DockZone (Left or Top)
`property LimitSize: Integer; [rw]` |  | The size of the limits 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 dock zone to which this control is docked
`property Top: Integer; [rw]` |  | The top coordinate of this control
`property Tree: TDockTree; [r]` |  | The dock tree of which this dock zone is a part
`property Visible: Boolean; [r]` |  | Is the control visible?
`property VisibleChildCount: Integer; [r]` |  | VisibleChildCount - the number of visible child controls
`property Width: Integer; [rw]` |  | The width of this control
`property NextSibling: TDockZone; [r]` |  | The next sibling (related control atthe same level) in the list of docked controls
`property PrevSibling: TDockZone; [r]` |  | The previous sibling (control at the same level) in the list of docked controls
`end;`

## Inheritance

`TDockZone` |  | Represents an node in an TDockTree.
`TObject`

## Description

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

The latest version of this document can be found at lazarus-ccr.sourceforge.net.