IDropHandler.HandleDragStarted(DragDropInfo) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Editor.DragDrop

Assembly:: Microsoft.VisualStudio.Text.UI.Wpf.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Indicates the start of a drag and drop operation.

public:
 Microsoft::VisualStudio::Text::Editor::DragDrop::DragDropPointerEffects HandleDragStarted(Microsoft::VisualStudio::Text::Editor::DragDrop::DragDropInfo ^ dragDropInfo);

Microsoft::VisualStudio::Text::Editor::DragDrop::DragDropPointerEffects HandleDragStarted(Microsoft::VisualStudio::Text::Editor::DragDrop::DragDropInfo const & dragDropInfo);

public Microsoft.VisualStudio.Text.Editor.DragDrop.DragDropPointerEffects HandleDragStarted (Microsoft.VisualStudio.Text.Editor.DragDrop.DragDropInfo dragDropInfo);

abstract member HandleDragStarted : Microsoft.VisualStudio.Text.Editor.DragDrop.DragDropInfo -> Microsoft.VisualStudio.Text.Editor.DragDrop.DragDropPointerEffects

Public Function HandleDragStarted (dragDropInfo As DragDropInfo) As DragDropPointerEffects

Parameters

dragDropInfo: DragDropInfo

Information about the drag and drop operation in progress.

Returns

DragDropPointerEffects

A DragDropPointerEffects object for the current operation. For example, this can be used to indicate a copy operation when the CTRL key is down.

Remarks

This method is called once a drop operation is in progress and the IDropHandler is the handler for the data format of the drop operation. It will not be called for dropping data formats not supported by this IDropHandler. A call to HandleDragStarted(DragDropInfo) is always followed by a call to either HandleDragCanceled() or HandleDataDropped(DragDropInfo).

Applies to