ModelingTextTransformation Class
Use this base class for text transformations from domain-specific language models.
Namespace: Microsoft.VisualStudio.TextTemplating.VSHost
Assembly: Microsoft.VisualStudio.TextTemplating.Modeling.12.0 (in Microsoft.VisualStudio.TextTemplating.Modeling.12.0.dll)
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.TextTemplating.TextTransformation
Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation
Microsoft.VisualStudio.TextTemplating.Modeling.ModelBusEnabledTextTransformation
Syntax
public abstract class ModelingTextTransformation : TextTransformation
public ref class ModelingTextTransformation abstract : TextTransformation
[<AbstractClass>]
type ModelingTextTransformation =
class
inherit TextTransformation
end
Public MustInherit Class ModelingTextTransformation
Inherits TextTransformation
Constructors
Name | Description | |
---|---|---|
ModelingTextTransformation() |
Properties
Name | Description | |
---|---|---|
CurrentIndent | Gets the current indent text, which is prefixed to each line of the generated text output.(Inherited from TextTransformation.) |
|
Errors | This API supports the product infrastructure and is not intended to be used directly from your code. 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. |
Methods
Name | Description | |
---|---|---|
AddDomainModel(Type) | 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(String, String, String) | 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(Object) | (Inherited from Object.) |
|
Error(String) | 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() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
Initialize() | Loads the models specified using AddModel() and makes the host ready to process the template.(Overrides TextTransformation.Initialize().) |
|
MemberwiseClone() | (Inherited from Object.) |
|
OnSessionChanged(ITextTemplatingSession, ITextTemplatingSession) | ||
PopIndent() | Removes the most recently added text from CurrentIndent.(Inherited from TextTransformation.) |
|
PushIndent(String) | Adds text to CurrentIndent, which is prefixed to each line of the generated text output.(Inherited from TextTransformation.) |
|
ToString() | (Inherited from Object.) |
|
TransformText() | When overridden in a derived class, generates the text output of the transformation. (Inherited from TextTransformation.) |
|
ValidateStore(String, CompilerErrorCollection) | Validates the store with the given validation categories. Returns true if there are errors. |
|
Warning(String) | 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, 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, 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.) |
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
Microsoft.VisualStudio.TextTemplating.VSHost Namespace
Return to top