IVsToolboxDataProvider2 Interface

 

Provides support for additional Toolbox features. In particular, IVsToolboxDataProvider2 is used to implement Toolbox persistence through the vssettings feature. Users will save and retrieve such information through the Import/Export Settings command, found on the IDE's Tools menu.

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

[InterfaceTypeAttribute(1)]
[GuidAttribute("1CD73232-A3C7-48FA-8B0A-2E35804097BF")]
public interface IVsToolboxDataProvider2

NameDescription
System_CAPS_pubmethodGetDisplayName(String)

Retrieves the localized name of the data provider.

System_CAPS_pubmethodGetItemID(IDataObject, String)

Used by the environment to retrieve and saves the canonical ID for the given Toolbox tab when a user selects the export option from the Import/Export Settings feature available on the IDE’s Tools menu.

System_CAPS_pubmethodGetItemTipInfo(IDataObject, String, IPropertyBag)

Supplies ToolTip data for a Toolbox item.

System_CAPS_pubmethodGetPackageGUID(Guid)

Retrieves the GUID of the VSPackage to which this data provider belongs.

System_CAPS_pubmethodGetProfileData(IDataObject, String)

Obtains any extra information, if needed, about a Toolbox item which can be saved through the settings mechanism using the Import/Export Settings feature available on the IDE’ Tools menu.

System_CAPS_pubmethodGetUniqueID(Guid)

Retrieves the unique ID for the given Toolbox tab.

System_CAPS_pubmethodReconstituteItem(String, String, String, IDataObject, TBXITEMINFO[])

Recreates a Toolbox item from data stored using the settings mechanism when a user chooses to retrieve settings using the Import/Export Settings feature available on the IDE’s Tools menu.

IVsToolboxDataProvider2 provides additional functionality for Toolbox data providers beyond the methods provided in IVsToolboxDataProvider. In particular, the methods of IVsToolboxDataProvider2 allow additional management of ID values, ToolTip text, and support for the IDE's Import/Export Settings feature.

System_CAPS_noteNote

IVsToolboxDataProvider2 does not derive from IVsToolboxDataProvider and does not implement its methods. All data providers should implement both interfaces.

Notes to Implementers:

IVsToolboxDataProvider2 should be implemented by all Toolbox data providers that need to persist a non-standard tab as part of Toolbox state through the settings feature.

Return to top
Show: