Freigeben über


ITextTemplatingEngineHost-Schnittstelle

Die Schnittstelle für den Host, der Textvorlagen transformiert.Dies ist für Direktivenprozessoren verfügbar und darauf kann auch von Textvorlagen zugegriffen werden.

Namespace:  Microsoft.VisualStudio.TextTemplating
Assembly:  Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (in Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll)

Syntax

'Declaration
<CLSCompliantAttribute(True)> _
Public Interface ITextTemplatingEngineHost
[CLSCompliantAttribute(true)]
public interface ITextTemplatingEngineHost
[CLSCompliantAttribute(true)]
public interface class ITextTemplatingEngineHost
[<CLSCompliantAttribute(true)>]
type ITextTemplatingEngineHost =  interface end
public interface ITextTemplatingEngineHost

Der ITextTemplatingEngineHost-Typ macht die folgenden Member verfügbar.

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft StandardAssemblyReferences Ruft eine Liste mit Assemblyverweisen ab.
Öffentliche Eigenschaft StandardImports Ruft eine Liste mit Namespaces ab.
Öffentliche Eigenschaft TemplateFile Ruft den Pfad und Dateinamen der Textvorlage ab, die verarbeitet wird.

Zum Seitenanfang

Methoden

  Name Beschreibung
Öffentliche Methode GetHostOption Wird vom Modul aufgerufen, um den Wert einer angegebenen Option anzufordern.Gibt NULL zurück, wenn Sie es nicht wissen.
Öffentliche Methode LoadIncludeText Erfasst den zugehörigen Text einer Anforderung, eine partielle Textvorlagendatei einzufügen.
Öffentliche Methode LogErrors Empfängt eine Auflistung von Fehlern und Warnungen vom Transformationsmodul.
Öffentliche Methode ProvideTemplatingAppDomain Stellt eine Anwendungsdomäne bereit, um die generierte Transformationsklasse auszuführen.
Öffentliche Methode ResolveAssemblyReference Ermöglicht es einem Host, zusätzliche Informationen über den Speicherort einer Assembly bereitzustellen.
Öffentliche Methode ResolveDirectiveProcessor Gibt ausgehend vom Anzeigenamen den Typ eines Direktivenprozessors zurück.
Öffentliche Methode ResolveParameterValue Ermittelt den Wert eines Parameters für einen Direktivenprozessor, wenn der Parameter nicht im Vorlagentext angegeben ist.
Öffentliche Methode ResolvePath Ermöglicht einem Host, einen vollständigen Pfad bereitzustellen, wenn ein Dateiname oder ein relativer Pfad angegeben wird.
Öffentliche Methode SetFileExtension Teilt dem Host die erwartete Dateinamenerweiterung für die generierte Textausgabe mit.
Öffentliche Methode SetOutputEncoding Teilt dem Host die erwartete Codierung für die generierte Textausgabe mit.

Zum Seitenanfang

Hinweise

Ein Host nimmt eine Textvorlagendatei als Eingabe und generiert eine Textdatei als Ausgabe.Ein typischer Host ist das TextTemplatingFileGenerator-Tool, mit dem Vorlagen in einem Visual Studio-Projekt umgewandelt werden.Es ruft einen oder mehreren Direktivenprozessoren auf, um unterschiedliche Vorlagentypen zu verarbeiten.Auf die Member dieser Schnittstelle kann von Direktivenprozessoren und vom Code der Textvorlage zugegriffen werden.Das Textvorlagenmodul steuert diesen Prozess und interagiert mit einem Host und einer oder mehreren Direktivenprozessoren.Weitere Informationen über diese Komponenten finden Sie unter Codegenerierung und T4-Textvorlagen.

Um den Zugriff auf den Host durch den Code einer Textvorlage zu ermöglichen, legen Sie den hostspecific-Parameter der Vorlagendirektive fest.Beispiele:

<#@template language="c#" hostspecific="true" #>
<# // This template is specific to the TextTemplatingFileGenerator host,
   // which transforms templates in a Visual Studio project. #>
These are the projects in this solution:
<#=this.Host.ResolveParameterValue("-", "-", "projects") #>

Wenn Sie Textvorlagen außerhalb von Visual Studio oder mit benutzerdefinierten Tools verwenden möchten, können Sie über die Implementierung dieser Schnittstelle einen benutzerdefinierten Host schreiben.Ein entsprechendes Beispiel finden Sie unter Exemplarische Vorgehensweise: Erstellen eines benutzerdefinierten Textvorlagenhosts.

Siehe auch

Referenz

Microsoft.VisualStudio.TextTemplating-Namespace

Weitere Ressourcen

Exemplarische Vorgehensweise: Erstellen eines benutzerdefinierten Textvorlagenhosts

Codegenerierung und T4-Textvorlagen