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

# TLazDockConfigNode

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

TLazDockConfigNode - a node to be configured in a docking control

## Declaration

Source position: ldockctrl.pas line 83

`type TLazDockConfigNode = class(TPersistent)`
`public`
`procedure Create();` |  | Create - constructor for a new node given a parent node and an optional name for the new node
`destructor Destroy; override;` |  | Destroy - destructor for TLazDocConfigNode: frees parents and children, the calls inherited Destroy
`procedure Clear;` |  | Clear - performs Free and Clear for all child nodes
`procedure Assign(); override;` |  | Assign - systematically copies sizes, anchors, titles and other details from Source to a new node.
`function FindByName();` |  | FindByName - searches through a tree of nodes to find one that matches the given name
`function IndexOf();` |  | IndexOf - returns the index value of the given string in the list of child nodes
`function GetScreenBounds;` |  | GetScreenBounds - returns the bounds of the area occupied by the node, as screen coordinates
`function FindNeighbour();` |  | FindNeighbour - returns the identity of the neighbouring node on the given side; optionally ignores splitters.
`function IsTheOnlyNeighbour();` |  | IsTheOnlyNeighbour - returns True if the nominated node is the only neighbour on the specified side
`procedure SaveToConfig();` |  | SaveToConfig - saves details of the configuration to a config file in the given Path
`procedure LoadFromConfig();` |  | LoadFromConfig - loads configuration details from a file in the given path
`function GetPath;` |  | GetPath - returns the path name for the configuration file relevant to the current node
`procedure WriteDebugReport;` |  | WriteDebugReport - produces a formatted report with details of the node for which debugging is needed
`function DebugLayoutAsString;` |  | DebugLayoutAsString - returns a string specifying the layout of the required debugging report
`property Bounds: TRect; [rw]` |  | The Bounds of the current node
`property ClientBounds: TRect; [rw]` |  | ClientBounds - the bounds of the node's clients
`property Parent: TLazDockConfigNode; [rw]` |  | The Parent of the current node
`property Sides: String; [rw]` |  | The Sides of the node to which anchoring is to be performed
`property ChildCount: Integer; [r]` |  | ChildCount - the number of child nodes
`property Childs: TLazDockConfigNode; default; [r]` |  | Childs - the child nodes in an indexed list
`published`
`property TheType: TLDConfigNodeType; [rw]` |  | TheType of node (see definition of TLDConfigNodeType)
`property Name: String; [rw]` |  | The Name of the node
`property WindowState: TWindowState; [rw]` |  | WindowState - the state of the window in which the node is placed
`end;`

## Inheritance

`TLazDockConfigNode` |  | TLazDockConfigNode - a node to be configured in a docking control
`TPersistent`
`TObject`

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