ModelBusEnabledTextTransformation-Klasse
Für den Zugriff auf Visual Studio ModelBus im Code einer Textvorlage geben Sie diese Klasse im inherits-Attribut der template-Direktive der Vorlage an, und legen Sie das hostspecific-Attribut auf true fest. Im Vorlagencode können Sie die Dienste SModelBus und SComponentModel abrufen.
Vererbungshierarchie
System.Object
Microsoft.VisualStudio.TextTemplating.TextTransformation
Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation
Microsoft.VisualStudio.TextTemplating.Modeling.ModelBusEnabledTextTransformation
Namespace: Microsoft.VisualStudio.TextTemplating.Modeling
Assembly: Microsoft.VisualStudio.TextTemplating.Modeling.10.0 (in Microsoft.VisualStudio.TextTemplating.Modeling.10.0.dll)
Syntax
'Declaration
Public MustInherit Class ModelBusEnabledTextTransformation _
Inherits ModelingTextTransformation
public abstract class ModelBusEnabledTextTransformation : ModelingTextTransformation
public ref class ModelBusEnabledTextTransformation abstract : public ModelingTextTransformation
[<AbstractClass>]
type ModelBusEnabledTextTransformation =
class
inherit ModelingTextTransformation
end
public abstract class ModelBusEnabledTextTransformation extends ModelingTextTransformation
Der ModelBusEnabledTextTransformation-Typ macht die folgenden Member verfügbar.
Konstruktoren
| Name | Beschreibung | |
|---|---|---|
.gif "Geschützte Methode") |
ModelBusEnabledTextTransformation |
Zum Seitenanfang
Eigenschaften
| Name | Beschreibung | |
|---|---|---|
.gif "Öffentliche Eigenschaft") |
CurrentIndent | Ruft den aktuellen Einzugstext ab, der jeder Zeile der generierten Textausgabe vorangestellt wird. (Von TextTransformation geerbt.) |
|
Errors | Infrastruktur. Ruft die Fehlerauflistung für den Textvorlagen-Transformationsprozess ab. (Von TextTransformation geerbt.) |
.gif "Geschützte Eigenschaft") |
GenerationEnvironment | Ruft die Zeichenfolge ab, mit der der Textvorlagen-Transformationsprozess die generierte Textausgabe assembliert, oder legt diese Zeichenfolge fest. (Von TextTransformation geerbt.) |
|
ModelBus | Ruft den Visual Studio ModelBus-Dienst ab, der von dieser Basisklasse bereitgestellt wird. |
|
ServiceProvider | Gibt einen Dienstanbieter zurück, der Visual Studio ModelBus enthält.Verwenden Sie nicht den Dienstanbieter vom Host. (Überschreibt ModelingTextTransformation.ServiceProvider.) |
|
Session | (Von ModelingTextTransformation geerbt.) |
|
SkipValidation | Bei dem Wert true führt ValidateStore() keine Validierung aus und gibt false zurück.Übernimmt den Standardwert false. (Von ModelingTextTransformation geerbt.) |
|
Store | Ruft den Modellierungsspeicher ab. (Von ModelingTextTransformation geerbt.) |
Zum Seitenanfang
Methoden
| Name | Beschreibung | |
|---|---|---|
|
AddDomainModel | Fügen Sie einen Domänenmodelltyp hinzu, der vom Speicher geladen werden soll.Rufen Sie diesen vor dem Aufrufen von Initialize() für jedes Domänenmodell auf. (Von ModelingTextTransformation geerbt.) |
.gif "Öffentliche Methode") |
ClearIndent | Setzt den CurrentIndent auf eine leere Zeichenfolge zurück. (Von TextTransformation geerbt.) |
|
Dispose() | Gibt sämtliche von der TextTransformation verwendeten Ressourcen frei. (Von TextTransformation geerbt.) |
|
Dispose(Boolean) | (Von ModelingTextTransformation geerbt.) |
|
Equals | Bestimmt, ob das angegebene Object und das aktuelle Object gleich sind. (Von Object geerbt.) |
|
Error | Erstellt eine neue Fehlermeldung, in der Informationen zu Fehlern während des Textvorlagen-Transformationsprozesses gespeichert werden. (Von TextTransformation geerbt.) |
|
Finalize | Ermöglicht einem Object das Freigeben von Ressourcen sowie das Ausführen weiterer Bereinigungsvorgänge, bevor es vom Garbage Collector wieder zugänglich gemacht wird.Wird vom Garbage Collector aufgerufen. (Von TextTransformation geerbt.) |
|
GetHashCode | Fungiert als Hashfunktion für einen besonderen Typ. (Von Object geerbt.) |
|
GetType | Ruft den Type der aktuellen Instanz ab. (Von Object geerbt.) |
|
Initialize | Lädt die mit AddModel() angegebenen Modelle und bereitet den Host auf die Verarbeitung der Vorlage vor. (Von ModelingTextTransformation geerbt.) |
|
MemberwiseClone | Erstellt eine flache Kopie des aktuellen Object. (Von Object geerbt.) |
|
OnSessionChanged | Wird immer dann aufgerufen, wenn eine Sitzung bereitgestellt wird, die nicht der zuletzt gespeicherten Sitzung entspricht.Löscht die statische ModelBus-Instanz, um das Lesen einer neuen Momentaufnahme von Modelldateien vorzubereiten. (Überschreibt ModelingTextTransformation.OnSessionChanged(ITextTemplatingSession, ITextTemplatingSession).) |
|
PopIndent | Entfernt den zuletzt hinzugefügten Text aus CurrentIndent. (Von TextTransformation geerbt.) |
|
PushIndent | Fügt CurrentIndent Text hinzu, der jeder Zeile der generierten Textausgabe vorangestellt wird. (Von TextTransformation geerbt.) |
|
ReportError | Konvertiert von ModelBus-Fehlern in Textvorlagenfehler.Ruft je nach Kategoriewert this.Error oder this.Warning auf. |
|
ToString | Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Von Object geerbt.) |
|
TransformText | Generiert beim Überschreiben in einer abgeleiteten Klasse die Textausgabe der Transformation. (Von TextTransformation geerbt.) |
|
ValidateStore | Überprüft den Speicher anhand der angegebenen Validierungskategorien.Gibt true zurück, wenn Fehler auftreten. (Von ModelingTextTransformation geerbt.) |
|
Warning | Erstellt eine neue Warnmeldung, in der Informationen zu Fehlern während des Textvorlagen-Transformationsprozesses gespeichert werden. (Von TextTransformation geerbt.) |
|
Write(String) | Fügt eine Kopie der angegebenen Zeichenfolge an die generierte Textausgabe an. (Von TextTransformation geerbt.) |
|
Write(String, array<Object[]) | Fügt eine formatierte Zeichenfolge mit 0 (null) oder mehr Formatangaben an die generierte Textausgabe an.Jede Formatangabe wird durch die Zeichenfolgendarstellung eines entsprechenden Objektarguments ersetzt. (Von TextTransformation geerbt.) |
|
WriteLine(String) | Fügt eine Kopie der angegebenen Zeichenfolge und des Standardzeilenabschlusszeichens an die generierte Textausgabe an. (Von TextTransformation geerbt.) |
|
WriteLine(String, array<Object[]) | Fügt eine formatierte Zeichenfolge mit 0 (null) oder mehr Formatangaben sowie das Standardzeilenabschlusszeichen an die generierte Textausgabe an.Jede Formatangabe wird durch die Zeichenfolgendarstellung eines entsprechenden Objektarguments ersetzt. (Von TextTransformation geerbt.) |
Zum Seitenanfang
Hinweise
Um diese Texttransformation in einer Vorlage zu verwenden, müssen Sie das hostspecific-Attribut in der template-Direktive auf true festlegen.
Beispiele
<#@ template debug="false" hostspecific="true" language="C#" inherits="Microsoft.VisualStudio.TextTemplating.Modeling.ModelBusEnabledTextTransformation" #>
<#@ assembly name="Microsoft.VisualStudio.TextTemplating.Modeling.10.0.dll" #>
<#@ assembly name="Microsoft.VisualStudio.Modeling.Sdk.Integration.10.0.dll" #>
<#@ import namespace="Microsoft.VisualStudio.Modeling.Integration" #>
<#@ output extension=".txt" #>
<# IModelBus modelbus = this.ServiceProvider.GetService(typeof(SModelBus)) as IModelBus;
...
#>
Threadsicherheit
Alle öffentlichen static (Shared in Visual Basic)-Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.