BaseTemplatedCodeGenerator Class

Article
10/03/2013

Text Templating Code Generator

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.TextTemplating.VSHost.BaseCodeGenerator
    Microsoft.VisualStudio.TextTemplating.VSHost.BaseCodeGeneratorWithSite
      Microsoft.VisualStudio.TextTemplating.VSHost.BaseTemplatedCodeGenerator
        Microsoft.VisualStudio.TextTemplating.VSHost.TemplatedCodeGenerator
        Microsoft.VisualStudio.TextTemplating.VSHost.TemplatedPreprocessor

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

Syntax

'Declaration
Public MustInherit Class BaseTemplatedCodeGenerator _
    Inherits BaseCodeGeneratorWithSite

public abstract class BaseTemplatedCodeGenerator : BaseCodeGeneratorWithSite

public ref class BaseTemplatedCodeGenerator abstract : public BaseCodeGeneratorWithSite

[<AbstractClass>]
type BaseTemplatedCodeGenerator =  
    class 
        inherit BaseCodeGeneratorWithSite 
    end

public abstract class BaseTemplatedCodeGenerator extends BaseCodeGeneratorWithSite

The BaseTemplatedCodeGenerator type exposes the following members.

Constructors

	Name	Description
	BaseTemplatedCodeGenerator

Top

Properties

	Name	Description
	Dte	Get the DTE object (Inherited from BaseCodeGeneratorWithSite.)
	ErrorList	Get the Vs ErrorList object (Inherited from BaseCodeGeneratorWithSite.)
	FileNamespace	namespace for the file. (Inherited from BaseCodeGenerator.)
	GlobalServiceProvider	Provides a wrapper on the global service provider for Visual Studio (Inherited from BaseCodeGeneratorWithSite.)
	InputFilePath	file-path for the input file. (Inherited from BaseCodeGenerator.)
	SiteServiceProvider	Get a wrapper on the containing project system's Service provider <remarks> This is a limited service provider that can only reliably provide VxDTE::SID_SVSProjectItem SID_SVSWebReferenceDynamicProperties IID_IVsHierarchy SID_SVsApplicationSettings To get the global provider, call GetSite on IVSHierarchy or use the GlobalServiceProvider property </remarks> (Inherited from BaseCodeGeneratorWithSite.)
	TextTemplating	Get the TextTemplating service from Visual Studio

Top

Methods

	Name	Description
	CreateExceptionMessage	(Inherited from BaseCodeGeneratorWithSite.)
	Dispose()	Releases all resources used by this instance. (Inherited from BaseCodeGenerator.)
	Dispose(Boolean)	(Inherited from BaseCodeGeneratorWithSite.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	(Inherited from BaseCodeGenerator.)
	Generate	(Inherited from BaseCodeGenerator.)
	GenerateCode	Generate the final code from the input template and its parameters (Overrides BaseCodeGenerator.GenerateCode(String, String).)
	GeneratorErrorCallback	(Inherited from BaseCodeGenerator.)
	GetDefaultExtension	Get the extension of the file that should be created (Overrides BaseCodeGenerator.GetDefaultExtension().)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetService(Guid)	(Inherited from BaseCodeGeneratorWithSite.)
	GetService(Type)	(Inherited from BaseCodeGeneratorWithSite.)
	GetSite	(Inherited from BaseCodeGeneratorWithSite.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ProcessTemplate	Do the actual template processing that forms the core of this generator
	SetSite	(Inherited from BaseCodeGeneratorWithSite.)
	SetWaitCursor	Set the wait cursor until the end of this generation (Inherited from BaseCodeGeneratorWithSite.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	callback

Top

Explicit Interface Implementations

	Name	Description
	IVsSingleFileGenerator.DefaultExtension	(Inherited from BaseCodeGenerator.)
	IVsSingleFileGenerator.Generate	(Inherited from BaseCodeGenerator.)

Top

Remarks

Parses an file template to produce its output. Only a single generator is needed for any style of template as the custom code is handled with directive providers.

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