ModelingTextTransformation Class

Article
10/03/2013

Use this base class for text transformations from domain-specific language models.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.TextTemplating.TextTransformation
    Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation
      Microsoft.VisualStudio.TextTemplating.Modeling.ModelBusEnabledTextTransformation

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

Syntax

'Declaration
Public MustInherit Class ModelingTextTransformation _
    Inherits TextTransformation

public abstract class ModelingTextTransformation : TextTransformation

public ref class ModelingTextTransformation abstract : public TextTransformation

[<AbstractClass>]
type ModelingTextTransformation =  
    class 
        inherit TextTransformation 
    end

public abstract class ModelingTextTransformation extends TextTransformation

The ModelingTextTransformation type exposes the following members.

Constructors

	Name	Description
	ModelingTextTransformation

Top

Properties

	Name	Description
	CurrentIndent	Gets the current indent text, which is prefixed to each line of the generated text output. (Inherited from TextTransformation.)
	Errors	Infrastructure. Gets the error collection for the text template transformation process. (Inherited from TextTransformation.)
	GenerationEnvironment	Gets or sets the string that the text template transformation process is using to assemble the generated text output. (Inherited from TextTransformation.)
	ServiceProvider
	Session
	SessionId
	SkipValidation	If true, ValidateStore() does not run validation and returns false. Defaults to false.
	Store	Gets the modeling Store.

Top

Methods

	Name	Description
	AddDomainModel	Add a domain model type to be loaded by the Store. Call this for each domain model before calling Initialize().
	ClearIndent	Resets the CurrentIndent to an empty string. (Inherited from TextTransformation.)
	ConvertModelRelativePathToTemplateRelativePath	Security Critical. Convert a path expressed relative to a model file to one expressed relative to a template.
	Dispose()	Releases all resources used by the TextTransformation. (Inherited from TextTransformation.)
	Dispose(Boolean)	(Overrides TextTransformation.Dispose(Boolean).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Error	Creates a new error to store information about errors that occur during the text template transformation process. (Inherited from TextTransformation.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before it is reclaimed by the garbage collector. Called by the garbage collector. (Inherited from TextTransformation.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize	Loads the models specified using AddModel() and makes the host ready to process the template. (Overrides TextTransformation.Initialize().)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnSessionChanged
	PopIndent	Removes the most recently added text from CurrentIndent. (Inherited from TextTransformation.)
	PushIndent	Adds text to CurrentIndent, which is prefixed to each line of the generated text output. (Inherited from TextTransformation.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TransformText	When overridden in a derived class, generates the text output of the transformation. (Inherited from TextTransformation.)
	ValidateStore	Validates the store with the given validation categories. Returns true if there are errors.
	Warning	Creates a new warning to store information about errors that occur during the text template transformation process. (Inherited from TextTransformation.)
	Write(String)	Appends a copy of the specified string to the generated text output. (Inherited from TextTransformation.)
	Write(String, array<Object[])	Appends a formatted string, which contains zero or more format specifications, to the generated text output. Each format specification is replaced by the string representation of a corresponding object argument. (Inherited from TextTransformation.)
	WriteLine(String)	Appends a copy of the specified string and the default line terminator to the generated text output. (Inherited from TextTransformation.)
	WriteLine(String, array<Object[])	Appends a formatted string, which contains zero or more format specifications, and the default line terminator, to the generated text output. Each format specification is replaced by the string representation of a corresponding object argument. (Inherited from TextTransformation.)

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