Vcl.ComCtrls.THeaderControl.OnSectionDrag

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property OnSectionDrag;

C++

__property OnSectionDrag;

Properties

Type Visibility Source Unit Parent
event published
Vcl.ComCtrls.pas
Vcl.ComCtrls.hpp
Vcl.ComCtrls THeaderControl

Description

Occurs when the user drags a header section to a new position.

Vcl.ComCtrls.THeaderControl.OnSectionDrag inherits from Vcl.ComCtrls.TCustomHeaderControl.OnSectionDrag. All content below this line refers to Vcl.ComCtrls.TCustomHeaderControl.OnSectionDrag.

Occurs when the user drags a header section to a new position.

Write an OnSectionDrag event handler to respond when a user tries to reorder the sections in the header control. The OnSectionDrag event handler can conditionally prevent the user from dragging a header to a new position.

If the AllowDrag parameter is True on exit from the event handler, the header control reorders the sections and generates an OnSectionEndDrag event when the reordering is complete.

OnSectionDrag only occurs if the DragReorder property is True.

See Also