ProvideAssemblyFilterAttribute Class

Article
02/04/2013

Describes the assemblies that the IConfigureToolboxItem class supports.

Inheritance Hierarchy

System.Object
System.Attribute
Microsoft.VisualStudio.Shell.ProvideAssemblyFilterAttribute

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 ProvideAssemblyFilterAttribute _
    Inherits Attribute

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

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

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

public final class ProvideAssemblyFilterAttribute extends Attribute

The ProvideAssemblyFilterAttribute type exposes the following members.

Constructors

	Name	Description
	ProvideAssemblyFilterAttribute	Creates a new instance of a ProvideAssemblyFilterAttribute object with the specified assembly name.

Top

Properties

	Name	Description
	AssemblyFilter	Gets the full assembly specification of the filter.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

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.)
	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.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

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

An IConfigureToolboxItem must be contained in a VSPackage.

The ProvideAssemblyFilterAttribute attributes are applied to a IConfigureToolboxItem in order to specify which ToolboxItem objects are configured by the IConfigureToolboxItem object.

A IConfigureToolboxItem class filters these assemblies on the basis of the parent assembly of the ToolboxItem class. This parent assembly is specified in the constructor ProvideAssemblyFilterAttribute, which is used to create a given instance of ProvideAssemblyFilterAttribute applied to that IConfigureToolboxItem object.

When specifying an assembly:

The ProvideAssemblyFilterAttribute specifies the full assembly identification, including a simple name, a version number, a cryptographic key pair, and a supported culture. For more information on assembly identification, see AssemblyName. The * character in a specification is interpreted as a wildcard.
The assembly name is set through the solution properties dialog.

Examples

The example below registers the ToolboxConfig class as providing configuration support for all ToolboxItem classes in all assemblies that have a name beginning with Vsip.

    [ProvideAssemblyFilterAttribute("Vsip.*, Version=*, Culture=*, PublicKeyToken=*")]
    public sealed class ToolboxConfig : IConfigureToolboxItem

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