DragDropHelper.DoDragDropWithImage Method

DragDropHelper DoDragDropWithImage Method

TIBCO Spotfire 6.0 API Reference

Performs drag and drop while displaying a provided image that is moved with the cursor.

Namespace: Spotfire.Dxp.Forms.Components
Assembly: Spotfire.Dxp.Forms (in Spotfire.Dxp.Forms.dll) Version: 13.19.7018.3940 (13.19.7018.3940)

Syntax

C++

Copy to Clipboard Print

public static DragDropEffects DoDragDropWithImage(
	Control sourceControl,
	IDataObject dataObject,
	DragDropEffects allowedEffects,
	Image image,
	Point hotSpot,
	float opacity
)

public static DragDropEffects DoDragDropWithImage(
	Control sourceControl,
	IDataObject dataObject,
	DragDropEffects allowedEffects,
	Image image,
	Point hotSpot,
	float opacity
)

Parameters

sourceControl: Type: System.Windows.Forms Control
The control that initiates the drag operation.

dataObject: Type: System.Windows.Forms IDataObject
The data to drag.

allowedEffects: Type: System.Windows.Forms DragDropEffects
One of the DragDropEffectsvalues.

image: Type: System.Drawing Image
Image to show while dragging.

hotSpot: Type: System.Drawing Point
The coordinate of the hot spot in image coordinates. This is the point where the cursor will be. This point does not need to be within the image. For instance, if both X and Y are negative, the image will be displayed below and to the right of the cursor.

opacity: Type: System Single
Overall opacity to use for the image. Valid values are in the range [0, 1.0], where 1.0 means totally opaque.

Return Value

Type: DragDropEffects
A DragDropEffects value that represents the final result.