Vcl.Ribbon.TCustomRibbonGroup.DockDrop

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure DockDrop(Source: TDragDockObject; X: Integer; Y: Integer); override;

C++

DYNAMIC void __fastcall DockDrop(Vcl::Controls::TDragDockObject* Source, int X, int Y);

Properties

Type Visibility Source Unit Parent
procedure
function
public
Vcl.Ribbon.pas
Vcl.Ribbon.hpp
Vcl.Ribbon TCustomRibbonGroup

Description

Generates an OnDockDrop event.

Vcl.Ribbon.TCustomRibbonGroup.DockDrop inherits from Vcl.Controls.TWinControl.DockDrop. All content below this line refers to Vcl.Controls.TWinControl.DockDrop.

Generates an OnDockDrop event.

DockDrop is called automatically when a control is docked to the windowed control. It instructs the control that is being dropped to prepare for the dock operation and then generates an OnDockDrop event.

Although you can override DockDrop to perform actions in addition to the generated OnDockDrop event, typically descendant classes override the DoAddDockClient method instead. This is because DoAddDockClient is called by the client after it has performed its own preparations, but before the OnDockDrop event.

DockDrop is called only if DockSite is True.

See Also