TDockTree class

In unit Controls

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

Declaration

pascal

TDockTree = class(TDockManager)

Inheritance

TDockTree
TDockManager
TPersistent

Descends from it: TLazDockTree

Description

TDockTree is a TDockManager descendant with a simple docking manager that allows docking a control into another using Align=alClient to fill the whole client area.

In this class, Docking means: Combining several windows into one. And, a window can be a TCustomForm instance, a floating (undocked) control, or a TDockForm instance. A window can be docked to another to the left, right, top, bottom, or "into". The source docking window will be resized to fit to the target docking window.

A docking manager supporting multiple controls per docksite (aka a layout) can be found in the ldocktree.pas unit.

TAnchorDockManager which supports multiple controls with a more flexible layout, store and restore, and more options can be found in the anchordocking package.

Properties

`DockZoneClass`	public	The class type for the dock zones in this tree.
`DockSite`	public	The parent control whose docked clients are managed.
`RootZone`	public	The root zone for the DockTree.

Methods

`HitTest`	protected	Returns the control and the part of the dockzone at the given coordinates.
`PaintDockFrame`	protected	Paints the dock header of the zone containing AControl.
`UpdateAll`	protected	Updates the internal TDockTreeFlags to reflect the update status for the control
`SetDockZoneClass`	protected
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`BeginUpdate`	public	Starts an update process for the class instance.
`EndUpdate`	public	Finishes an update process for the class instance.
`AdjustDockRect`	public	Adjusts the zone rectangle for AControl.
`GetControlBounds`	public	Returns the zone bounds of a docked control.
`InsertControl`	public	Positions DropCtl relative Control, using the alignment specified by InsertAt.
`LoadFromStream`	public	Has an empty implementation in TDockTree.
`MessageHandler`	public	Has an empty implementation in TDockTree.
`PositionDockRect`	public	Determines the DockRect while dragging a control over the docksite.
`RemoveControl`	public	Removes the undocked control from the docksite layout.
`SaveToStream`	public	Saves the docksite layout to Stream.
`SetReplacingControl`	public	Specifies the control to be replaced subsequently.
`ResetBounds`	public	Refreshes the layout for the dock site.
`PaintSite`	public	Handles special painting of the docksite.
`DumpLayout`	public	Stores the layout in a file.

Fields

FRootZone protected

Inherited

From TDockManager (4)

AutoFreeByControl CanBeDoubleDocked GetDockEdge IsEnabledControl

An experiment, built from Lazarus main 2dfa93c66e of 10-22-2026. Not the official Lazarus documentation.