ProvideToolboxItemConfigurationAttribute Class

Article
02/04/2013

Registers a VSPackage as supplying a particular implementation of IConfigureToolboxItem. Used in conjunction with ProvideAssemblyFilterAttribute.

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.VisualStudio.Shell.RegistrationAttribute
      Microsoft.VisualStudio.Shell.ProvideToolboxItemConfigurationAttribute

Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, Inherited := True, AllowMultiple := True)> _
Public NotInheritable Class ProvideToolboxItemConfigurationAttribute _
    Inherits RegistrationAttribute

[AttributeUsageAttribute(AttributeTargets.Class, Inherited = true, AllowMultiple = true)]
public sealed class ProvideToolboxItemConfigurationAttribute : RegistrationAttribute

[AttributeUsageAttribute(AttributeTargets::Class, Inherited = true, AllowMultiple = true)]
public ref class ProvideToolboxItemConfigurationAttribute sealed : public RegistrationAttribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, Inherited = true, AllowMultiple = true)>]
type ProvideToolboxItemConfigurationAttribute =  
    class
        inherit RegistrationAttribute
    end

public final class ProvideToolboxItemConfigurationAttribute extends RegistrationAttribute

The ProvideToolboxItemConfigurationAttribute type exposes the following members.

Constructors

	Name	Description
	ProvideToolboxItemConfigurationAttribute	Initializes a new instance of ProvideToolboxItemConfigurationAttribute.

Top

Properties

	Name	Description
	ObjectType	Gets the type of the toolbox item configuration.
	TypeId	Gets the current instance of this attribute. (Inherited from RegistrationAttribute.)

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetPackageRegKeyPath	Gets the registry path (relative to the registry root of the application) of the VSPackage. (Inherited from RegistrationAttribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Register	Registers the toolbox item configuration. (Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unregister	Removes the registry key. (Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)

Top

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
	_Attribute.GetTypeInfo	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
	_Attribute.GetTypeInfoCount	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
	_Attribute.Invoke	Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

Remarks

Attribute Context

Applies to	Classes providing VSPackages by implementing IVsPackage, Package.
Repeatable	No
Required attributes	ProvideAssemblyFilterAttribute (applied to the class implementing IConfigureToolboxItem.
Invalid attributes	None

A specific instance of ProvideToolboxItemConfigurationAttribute is defined for each instance of IConfigureToolboxItem.

When this attribute is applied to a class that implements IVsPackage or Package, it informs Visual Studio that this VSPackage supplies an implementation of IConfigureToolboxItem.

A VSPackage can have more than one instance of ProvideToolboxItemConfigurationAttribute applied to it.

Examples

In the example below, the Package ItemConfiguration implementation is registered as providing the class ToolboxConfig to support an implementation of IConfigureToolboxItem.

using MSVSIP = Microsoft.VisualStudio.Shell;
 [assembly:ComVisible(true)]

namespace Vsip.ItemConfiguration
{
    /////////////////////////////////////////////////////////////////////////////
    // Walkthrough1
    [MSVSIP.ProvideToolboxItemsAttribute(110)]
    [MSVSIP.DefaultRegistryRoot("Software\\Microsoft\\VisualStudio\\8.0")]
    [MSVSIP.InstalledProductRegistration(100, 102, "1.0", IconResId = 400)]
    [MSVSIP.RegisterLoadKey("Standard", "1.0", "Package Name", "Company", 1)]
    [MSVSIP.ProvideMenuResource(1000, 1)]
    [ProvideToolboxItemConfigurationAttribute(typeof(ToolboxConfig))]
    [GuidAttribute("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]
    public class ItemConfiguration : MSVSIP.Package

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via