ModelBusEnabledTextTransformation Class

 

To access Visual Studio ModelBus in the code of a text template, specify this class in the inherits attribute of the template directive of the template, and set the hostspecific attribute to true. In the template code, you can get the SModelBus and SComponentModel services.

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


public abstract class ModelBusEnabledTextTransformation : ModelingTextTransformation

NameDescription
System_CAPS_pubpropertyCurrentIndent

Gets the current indent text, which is prefixed to each line of the generated text output.(Inherited from TextTransformation.)

System_CAPS_pubpropertyErrors

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.)

System_CAPS_protpropertyGenerationEnvironment

Gets or sets the string that the text template transformation process is using to assemble the generated text output. (Inherited from TextTransformation.)

System_CAPS_protpropertyModelBus

Get the Visual Studio ModelBus service that this base class provides.

System_CAPS_protpropertyServiceProvider

Return a service provider containing the Visual Studio ModelBus. Do not use the service provider from the Host.(Overrides ModelingTextTransformation.ServiceProvider.)

System_CAPS_pubpropertySession

(Inherited from ModelingTextTransformation.)

System_CAPS_protpropertySkipValidation

If true, ValidateStore() does not run validation and returns false. Defaults to false. (Inherited from ModelingTextTransformation.)

System_CAPS_protpropertyStore

Gets the modeling Store.(Inherited from ModelingTextTransformation.)

NameDescription
System_CAPS_protmethodAddDomainModel(Type)

Add a domain model type to be loaded by the Store. Call this for each domain model before calling Initialize().(Inherited from ModelingTextTransformation.)

System_CAPS_pubmethodClearIndent()

Resets the CurrentIndent to an empty string.(Inherited from TextTransformation.)

System_CAPS_pubmethodDispose()

Releases all resources used by the TextTransformation.(Inherited from TextTransformation.)

System_CAPS_protmethodDispose(Boolean)

(Inherited from ModelingTextTransformation.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodError(String)

Creates a new error to store information about errors that occur during the text template transformation process.(Inherited from TextTransformation.)

System_CAPS_protmethodFinalize()

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.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Loads the models specified using AddModel() and makes the host ready to process the template.(Inherited from ModelingTextTransformation.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnSessionChanged(ITextTemplatingSession, ITextTemplatingSession)

Called whenever a session is provided that isn't the same as the last remembered session. Clears the static modelbus instance to prepare for a new snapshot of model files to be read.(Overrides ModelingTextTransformation.OnSessionChanged(ITextTemplatingSession, ITextTemplatingSession).)

System_CAPS_pubmethodPopIndent()

Removes the most recently added text from CurrentIndent.(Inherited from TextTransformation.)

System_CAPS_pubmethodPushIndent(String)

Adds text to CurrentIndent, which is prefixed to each line of the generated text output.(Inherited from TextTransformation.)

System_CAPS_protmethodReportError(ErrorCategory, String)

Converts from ModelBus errors to Text Template errors. Calls this.Error or this.Warning depending on the category value.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodTransformText()

When overridden in a derived class, generates the text output of the transformation. (Inherited from TextTransformation.)

System_CAPS_protmethodValidateStore(String, CompilerErrorCollection)

Validates the store with the given validation categories. Returns true if there are errors.(Inherited from ModelingTextTransformation.)

System_CAPS_pubmethodWarning(String)

Creates a new warning to store information about errors that occur during the text template transformation process.(Inherited from TextTransformation.)

System_CAPS_pubmethodWrite(String)

Appends a copy of the specified string to the generated text output.(Inherited from TextTransformation.)

System_CAPS_pubmethodWrite(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.)

System_CAPS_pubmethodWriteLine(String)

Appends a copy of the specified string and the default line terminator to the generated text output.(Inherited from TextTransformation.)

System_CAPS_pubmethodWriteLine(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.)

To use this text transformation in a template, you must set the hostspecific attribute to true in the template directive.

<#@ template debug="false" hostspecific="true" language="C#" inherits="Microsoft.VisualStudio.TextTemplating.Modeling.ModelBusEnabledTextTransformation" #>
<#@ assembly name="Microsoft.VisualStudio.TextTemplating.Modeling.11.0.dll" #>
<#@ assembly name="Microsoft.VisualStudio.Modeling.Sdk.Integration.11.0.dll" #>
<#@ import namespace="Microsoft.VisualStudio.Modeling.Integration" #>
<#@ output extension=".txt" #>
<# IModelBus modelbus = this.ServiceProvider.GetService(typeof(SModelBus)) as IModelBus; 
...
#>

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: