ProvideCodeGeneratorExtensionAttribute Class

Article
10/03/2013

Attribute class to provide registration of a code generator against a specific file extension

This API is not CLS-compliant.

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.VisualStudio.Shell.RegistrationAttribute
      Microsoft.VisualStudio.TextTemplating.VSHost.ProvideCodeGeneratorExtensionAttribute

Namespace: Microsoft.VisualStudio.TextTemplating.VSHost
Assembly: Microsoft.VisualStudio.TextTemplating.VSHost.12.0 (in Microsoft.VisualStudio.TextTemplating.VSHost.12.0.dll)

Syntax

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

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

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

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

public final class ProvideCodeGeneratorExtensionAttribute extends RegistrationAttribute

The ProvideCodeGeneratorExtensionAttribute type exposes the following members.

Constructors

	Name	Description
	ProvideCodeGeneratorExtensionAttribute

Top

Properties

	Name	Description
	Extension	The extension to bind the named generator to
	Name	The name of the generator to add an extension for
	ProjectSystem	The project system that this code generator is registered with
	ProjectSystemPackage	The package implementing the project system that this code generator is registered with
	TypeId	(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.)
	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.)
	Register	(Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unregister	(Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)

Top

Fields

	Name	Description
	AspNetProjectSystemGuid	Actual project GUID (as opposed to package Guid) for ASP.Net
	CSharpProjectSystemGuid	Actual project GUID (as opposed to package Guid) for CSharp
	VisualBasicProjectSystemGuid	Actual project GUID (as opposed to package Guid) for Visual Basic

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

Should be applied to the package class, not the generator, in addition to the ProvideCodeGenerator attribute. This attribute sets up two things:

Default application of the specified generator to files with the extension provided
Correct working with the ASP.Net project system which requires file extensions to be registered

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.

Partager via