Vcl.Controls.TWinControl.DockReplaceDockClient

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function DockReplaceDockClient(Client: TControl;  NewDockSite: TWinControl; DropControl: TControl; ControlSide: TAlign; ReplacementClient: TControl): Boolean; virtual;

C++

virtual bool __fastcall DockReplaceDockClient(TControl* Client, TWinControl* NewDockSite, TControl* DropControl, TAlign ControlSide, TControl* ReplacementClient);

Properties

Type Visibility Source Unit Parent
function protected
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls TWinControl

Description

Invalidates the first dock site in the list of child controls.

Currently, DockReplaceDockClient always returns False and has no effect as a member of the TWinControl class.

Implement DockReplaceDockClient in descendant classes in order to manually replace Client with ReplacementClient. Also, manually dock Client to NewDockSite on the control specified by DropControl and using the alignment options given in ControlSide.