Interfaccia ITextTemplatingEngineHost

Articolo
08/11/2011

Interfaccia dell'host che trasforma i modelli di testo. Ciò è disponibile per i processori di direttiva e può anche essere accessibile da modelli di testo.

Spazio dei nomi: Microsoft.VisualStudio.TextTemplating
Assembly: Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (in Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll)

Sintassi

'Dichiarazione
<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

Il tipo ITextTemplatingEngineHost espone i seguenti membri.

Proprietà

	Nome	Descrizione
	StandardAssemblyReferences	Ottiene un elenco di riferimenti ad assembly.
	StandardImports	Ottiene un elenco di spazi di nomi.
	TemplateFile	Ottiene il percorso e il nome del file del modello di testo che viene elaborato.

In alto

Metodi

	Nome	Descrizione
	GetHostOption	È stato chiamato dal motore per chiedere il valore di un'opzione specificata.Restituisce null se non si è certi.
	LoadIncludeText	Acquisisce il testo che corrisponde a una richiesta di inclusione di un file modello di testo parziale.
	LogErrors	Riceve un insieme di errori e avvisi dal motore di trasformazione.
	ProvideTemplatingAppDomain	Fornisce un dominio applicazione per eseguire la classe Transformation generata.
	ResolveAssemblyReference	Consente a un host di fornire informazioni aggiuntive sul percorso di un assembly.
	ResolveDirectiveProcessor	Restituisce il tipo di un processore di direttiva, dato il relativo nome descrittivo.
	ResolveParameterValue	Risolve il valore di un parametro di un processore di direttiva se il parametro non è specificato nel testo del modello.
	ResolvePath	Consente a un host di fornire un percorso completo, dato un nome file o un percorso relativo.
	SetFileExtension	Indica all'host l'estensione di file prevista per l'output di testo generato.
	SetOutputEncoding	Indica all'host la codifica prevista per l'output di testo generato.

In alto

Note

Un host prende un file modello di testo come input e produce un file di testo come output. Un host tipico è lo strumento di TextTemplatingFileGenerator che trasforma i modelli in un progetto Visual Studio. Chiama uno o più processori di direttive per la gestione di tipi diversi di modelli. I membri di questa interfaccia sono accessibili ai processori di direttiva e al codice del modello di testo. Il motore del modello di testo controlla questo processo e interagisce con un host e uno o più processori di direttiva. Per ulteriori informazioni su questi componenti, vedere Generazione di codice e modelli di testo (T4).

Per rendere l'host accessibile al codice di un modello di testo, impostare il parametro hostspecific della direttiva del modello. Di seguito è riportato un esempio.

<#@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") #>

Se si desidera utilizzare modelli di testo all'esterno di Visual Studio o con strumenti personalizzati, è possibile scrivere un host personalizzato implementando questa interfaccia. Per un esempio, vedere Walkthrough: Creating a Custom Text Template Host.

Suggerimento
Se si scrive un pacchetto o un'estensione che verrà eseguita in Visual Studio, anziché scrivere il proprio host, è consigliabile utilizzare il servizio del modello di testo. Per ulteriori informazioni, vedere Invoking Text Transformation in a Visual Studio Extension.