IVsToolboxDataProvider Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

Requests information from data providers regarding the data objects that they support.

public interface class IVsToolboxDataProvider

public interface class IVsToolboxDataProvider

__interface IVsToolboxDataProvider

[System.Runtime.InteropServices.Guid("F925DA6B-3F43-4437-9E1E-4D4C1BBDAB3F")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsToolboxDataProvider

[System.Runtime.InteropServices.Guid("F925DA6B-3F43-4437-9E1E-4D4C1BBDAB3F")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsToolboxDataProvider

[<System.Runtime.InteropServices.Guid("F925DA6B-3F43-4437-9E1E-4D4C1BBDAB3F")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsToolboxDataProvider = interface

[<System.Runtime.InteropServices.Guid("F925DA6B-3F43-4437-9E1E-4D4C1BBDAB3F")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsToolboxDataProvider = interface

Public Interface IVsToolboxDataProvider

Attributes: GuidAttribute InterfaceTypeAttribute

Remarks

VAPackages implementing IVsToolboxDataProvider should also implement the IVsToolboxDataProvider interface, which provides support for persisting toolbox items.

The methods of IVsToolboxDataProvider are called whenever the Toolbox has new items (data objects) added to it. For example, the environment calls each registered data provider with IsSupported to determine whether any of the data providers support the new data object. If a data provider supports the data object (that is, returns S_OK), then the data object is added to the Toolbox.

To register a data provider with the Toolbox, call RegisterDataProvider and pass a pointer to your implementation of IVsToolboxDataProvider. The default Toolbox data provider is for ActiveX objects.

Notes to Implementers

Implemented by objects that provide items (data objects) to the Toolbox.

Notes to Callers

Called by the environment when new data objects are added to the Toolbox. The environment calls the methods of IVsToolboxDataProvider to obtain information about the data objects being added.

Methods

FileDropped(String, IVsHierarchy, Int32)	Sends notification that a file is being dropped on the Toolbox.
GetItemInfo(IDataObject, TBXITEMINFO[])	Returns the item information for the specified data object.
IsDataSupported(FORMATETC[], STGMEDIUM[])	Determines the appropriate clipboard data format for a data object .
IsSupported(IDataObject)	Determines whether or not a data object is supported by a data provider and can be added to the Toolbox.

Applies to

Share via