ProvideIncludeFolderAttribute Class

Article
02/04/2013

Registers a folder to search for text template include files. Apply this attribute to a package class if you want the include folder to be registered when the package is installed.

This API is not CLS-compliant.

Inheritance Hierarchy

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

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

Syntax

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

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

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

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

public final class ProvideIncludeFolderAttribute extends RegistrationAttribute

The ProvideIncludeFolderAttribute type exposes the following members.

Constructors

	Name	Description
	ProvideIncludeFolderAttribute	Registers a folder to search for text template include files. Apply this attribute to a package class if you want the include folder to be registered when the package is installed.

Top

Properties

	Name	Description
	Extension	The extension (such as .tt) of template files that might include files from this folder.
	Folder	The path of the inclusion folder being registered. This path is relative to the component path of the assembly being registered.
	Index	The zero-based index of the folder
	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.)
	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	(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	Defines how the include folder is registered when the user installs the package. Typically creates a script to add registry entries. (Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unregister	Defines how the include folder is unregistered. Typically deletes registry keys. (Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)

Top

Fields

	Name	Description
	IncludeFoldersKeyName	Name of the specific registry key for Directive processors
	TextTemplatingKeyName	Name of the root registry key for Text templating

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

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