API:Vcl.Controls.TDragControlObject.GetDragImages

From RAD Studio API Documentation

Delphi

function GetDragImages: TDragImageList; override;

C++

virtual TDragImageList* __fastcall GetDragImages(void);

Properties

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

Description

Returns an image list containing the image to be displayed while dragging. {{#multireplace:Vcl.Controls.TDragControlObject.GetDragImages|H21=!|H25=%|H28=(|H29=)|H2A=*|H2B=+|H2F=/|H3C=<|H3D==|H3E=>|H5B=[|H5D=]|H5E=^|H7C=|}} inherits from {{#multireplace:Vcl.Controls.TDragObject.GetDragImages|H21=!|H25=%|H28=(|H29=)|H2A=*|H2B=+|H2F=/|H3C=<|H3D==|H3E=>|H5B=[|H5D=]|H5E=^|H7C=|}}. All content below this line refers to {{#multireplace:Vcl.Controls.TDragObject.GetDragImages|H21=!|H25=%|H28=(|H29=)|H2A=*|H2B=+|H2F=/|H3C=<|H3D==|H3E=>|H5B=[|H5D=]|H5E=^|H7C=|}}.

Returns an image list containing the image to be displayed while dragging.

GetDragImages is called at the beginning of a drag and drop operation. As implemented in TDragObject, GetDragImages returns nil (Delphi) or NULL (C++), meaning that only the cursor is used to indicate the drag operation.

In descendant classes, the image list normally contains only one image, and the drag object automatically creates and maintains the image list.

See Also