BaseCodeGeneratorWithSite Class

  • Article

This class exists to be co-created in a preprocessor build step.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.TextTemplating.VSHost.BaseCodeGenerator
    Microsoft.VisualStudio.TextTemplating.VSHost.BaseCodeGeneratorWithSite
      Microsoft.VisualStudio.TextTemplating.VSHost.BaseTemplatedCodeGenerator

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

Syntax

'Declaration
Public MustInherit Class BaseCodeGeneratorWithSite _
    Inherits BaseCodeGenerator _
    Implements IObjectWithSite

public abstract class BaseCodeGeneratorWithSite : BaseCodeGenerator, 
    IObjectWithSite

public ref class BaseCodeGeneratorWithSite abstract : public BaseCodeGenerator, 
    IObjectWithSite

[<AbstractClass>]
type BaseCodeGeneratorWithSite =  
    class 
        inherit BaseCodeGenerator 
        interface IObjectWithSite 
    end

public abstract class BaseCodeGeneratorWithSite extends BaseCodeGenerator implements IObjectWithSite

The BaseCodeGeneratorWithSite type exposes the following members.

Constructors

  Name Description
Protected method BaseCodeGeneratorWithSite

Top

Properties

  Name Description
Protected property Dte Get the DTE object
Protected property ErrorList Get the Vs ErrorList object
Protected property FileNamespace namespace for the file. (Inherited from BaseCodeGenerator.)
Protected property GlobalServiceProvider Provides a wrapper on the global service provider for Visual Studio
Protected property InputFilePath file-path for the input file. (Inherited from BaseCodeGenerator.)
Protected property 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>

Top

Methods

  Name Description
Protected method CreateExceptionMessage
Public method Dispose() Releases all resources used by this instance. (Inherited from BaseCodeGenerator.)
Protected method Dispose(Boolean) (Overrides BaseCodeGenerator.Dispose(Boolean).)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize (Inherited from BaseCodeGenerator.)
Public method Generate (Inherited from BaseCodeGenerator.)
Protected method GenerateCode (Inherited from BaseCodeGenerator.)
Protected method GeneratorErrorCallback (Inherited from BaseCodeGenerator.)
Public method GetDefaultExtension gets the default extension for this generator (Inherited from BaseCodeGenerator.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetService(Guid)
Protected method GetService(Type)
Public method GetSite
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SetSite
Protected method SetWaitCursor Set the wait cursor until the end of this generation
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IVsSingleFileGenerator.DefaultExtension (Inherited from BaseCodeGenerator.)
Explicit interface implemetationPrivate method IVsSingleFileGenerator.Generate (Inherited from BaseCodeGenerator.)

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.

See Also

Reference

Microsoft.VisualStudio.TextTemplating.VSHost Namespace