ProvideToolboxItemsAttribute Class

Artigo
04/29/2015

Apply this attribute to classes implementing VSPackages to declare if they offer a set of items to the Visual Studio Toolbox.

Inheritance Hierarchy

Object
  Attribute
    Microsoft.VisualStudio.Shell.RegistrationAttribute
      Microsoft.VisualStudio.Shell.ProvideToolboxItemsAttribute

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

Syntax

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

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

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

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

public class ProvideToolboxItemsAttribute extends RegistrationAttribute

The ProvideToolboxItemsAttribute type exposes the following members.

Constructors

	Name	Description
	ProvideToolboxItemsAttribute(Int32)	Creates a new instance of ProvideToolboxItemsAttribute which indicates if a class implementing a VSPackage is providing Toolbox items.
	ProvideToolboxItemsAttribute(Int32, Boolean)	Initializes a new instance of ProvideToolboxItemsAttribute for the specified version.

Top

Properties

	Name	Description
	NeedsCallBackAfterReset	Gets or sets whether the ToolboxInitialized event should be raised after each toolbox reset.
	TypeId	Gets the current instance of this attribute. (Inherited from RegistrationAttribute.)
	Version	Property returning the version of Toolbox items a VSPackage provides.

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 a VSPackage as a Toolbox item provider for specified formats when called by an external registration tool such as regpkg.exe. For more information, see Registering VSPackages. (Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unregister	Reverses the changes that the Register method had applied to the registry. (Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)

Top

Explicit Interface Implementations

	Name	Description
	System#Runtime#InteropServices#_Attribute#GetIDsOfNames	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
	System#Runtime#InteropServices#_Attribute#GetTypeInfo	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
	System#Runtime#InteropServices#_Attribute#GetTypeInfoCount	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
	System#Runtime#InteropServices#_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	ProvideToolboxFormatAttribute
Invalid attributes	None

Apply this attribute to a Package-derived class or a class that implements IVsPackage that is required to enable support for users to drag data objects of this format, provided by the class, onto the Toolbox. This implementing class must handle the drop notifications itself.

This attribute is only used for registration purposes, and does not affect how code behaves at runtime.

Depending on the arguments specified in its constructor, this attribute can indicate that a VSPackage does not provide any Toolbox items. If the attribute ProvideToolboxFormatAttribute is added to a class to indicate that it provides Toolbox items, one or more instances of ProvideToolboxFormatAttribute must also be added.

This attribute uses ProvideToolboxFormatAttribute to register a VSPackage as providing Toolbox items of a given format.

If this attribute specifies that Toolbox items are provided, the VSPackage must handle the ToolboxInitialized and ToolboxUpgraded events.

Any VSPackage using this attribute must provide a handler for the ToolboxInitialized and ToolboxUpgraded events.

Examples

In the example below, the attributes applied to the class MyPackage indicates that it supports version 1 of Toolbox items of with two clipboard formats "CF_XMLCODE" and "InPlaceMenuEditorMenu".

    [DefaultRegistryRoot("Software\\Microsoft\\VisualStudio\\8.0")]
    [ProvideToolboxItems(true, 1)]
    [ProvideToolboxFormat("CF_XMLCODE")]
    [ProvideToolboxFormat("InPlaceMenuEditorMenu")]
    [Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]
    internal sealed class MyPackage : 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.

Compartilhar via