IDropHandler.IsDropEnabled(DragDropInfo) Method

Reference

Definition

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

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

Package:: Microsoft.VisualStudio.Text.UI.Wpf v17.9.187

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.

Determines whether the handler can accept data for a drag and drop operation.

public:
 bool IsDropEnabled(Microsoft::VisualStudio::Text::Editor::DragDrop::DragDropInfo ^ dragDropInfo);

bool IsDropEnabled(Microsoft::VisualStudio::Text::Editor::DragDrop::DragDropInfo const & dragDropInfo);

public bool IsDropEnabled (Microsoft.VisualStudio.Text.Editor.DragDrop.DragDropInfo dragDropInfo);

abstract member IsDropEnabled : Microsoft.VisualStudio.Text.Editor.DragDrop.DragDropInfo -> bool

Public Function IsDropEnabled (dragDropInfo As DragDropInfo) As Boolean

Parameters

dragDropInfo: DragDropInfo

Information about the drag and drop operation.

Returns

Boolean

true if the handler can accept data now, otherwise false.

Remarks

This method is used by the editor to check whether the drop handler can accept data after it has been designated to handle a drag and drop operation. For example, the drop handler may be able to handle data only if the view is not read-only. The implementation of this method would check the read-only status of the view.

If one drop handler returns false, another drop handler might be used to handle the drop operation, even if the ordering of IDropHandler objects dictates otherwise.

Applies to