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)

public interface IVsToolboxDataProvider2

The IVsToolboxDataProvider2 type exposes the following members.

Public methodGetDisplayNameRetrieves the localized name of the data provider.
Public methodGetItemIDUsed 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.
Public methodGetItemTipInfoSupplies ToolTip data for a Toolbox item.
Public methodGetPackageGUIDRetrieves the GUID of the VSPackage to which this data provider belongs.
Public methodGetProfileDataObtains 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.
Public methodGetUniqueIDRetrieves the unique ID for the given Toolbox tab.
Public methodReconstituteItemRecreates 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.


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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2015 Microsoft