ITextTemplatingEngineHost, interface

Interface de l'hôte qui transforme les modèles de texte. Elle est disponible pour les processeurs de directive et est également accessible par les modèles de texte.

Espace de noms :  Microsoft.VisualStudio.TextTemplating
Assembly :  Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (dans Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll)

Syntaxe

'Déclaration
<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

Le type ITextTemplatingEngineHost expose les membres suivants.

Propriétés

	Nom	Description
	StandardAssemblyReferences	Obtient une liste de références d'assembly.
	StandardImports	Obtient une liste d'espaces de noms.
	TemplateFile	Obtient le chemin d'accès et le nom de fichier du modèle de texte en cours de traitement.

Début

Méthodes

	Nom	Description
	GetHostOption	Appelé lorsque le moteur pour demander la valeur d'une option spécifiée.Retourne la valeur Null si vous ne savez pas.
	LoadIncludeText	Acquiert le texte correspondant à une requête d'inclusion d'un fichier de modèle de texte partiel.
	LogErrors	Reçoit une collection d'erreurs et d'avertissements du moteur de transformation.
	ProvideTemplatingAppDomain	Fournit un domaine d'application pour exécuter la classe de transformation générée.
	ResolveAssemblyReference	Autorise un hôte à fournir des informations supplémentaires concernant l'emplacement d'un assembly.
	ResolveDirectiveProcessor	Retourne le type d'un processeur de directive, étant donné son nom convivial.
	ResolveParameterValue	Résout la valeur d'un paramètre de processeur de directive si ce paramètre n'est pas spécifié dans le texte du modèle.
	ResolvePath	Permet à l'hôte de fournir un chemin d'accès complet, en fonction d'un nom de fichier ou d'un chemin d'accès relatif.
	SetFileExtension	Indique à l'hôte l'extension de nom de fichier attendue pour la sortie de texte générée.
	SetOutputEncoding	Indique à l'hôte l'encodage attendu pour la sortie de texte générée.

Début

Notes

Un hôte accepte un fichier modèle de texte comme entrée et génère un fichier texte comme sortie. Un hôte type est l'outil TextTemplatingFileGenerator qui transforme des modèles dans un projet Visual Studio. Il appelle un ou plusieurs processeurs de directive pour traiter les différents types de modèle. Les membres de cette interface sont accessibles aux processeurs de directive et au code du modèle de texte. Le moteur de modèle de texte contrôle ce processus et interagit avec un hôte et un ou plusieurs processeurs de directive. Pour en savoir plus sur ces composants, consultez Génération de code et modèles de texte T4.

Pour rendre l'hôte accessible au code d'un modèle de texte, définissez le paramètre hostspecific de la directive de modèle. Par exemple :

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

Si vous souhaitez utiliser des modèles de texte en dehors de Visual Studio ou avec des outils personnalisés, vous pouvez créer un hôte personnalisé, implémentant cette interface. Pour obtenir un exemple, consultez Procédure pas à pas : création d'un hôte de modèle de texte personnalisé.

Conseil

Si vous écrivez un package ou une extension qui s'exécutera dans Visual Studio, envisagez d'utiliser le service de création de modèles de texte, plutôt que d'écrire dans votre propre hôte. Pour plus d'informations, consultez Appel d'une transformation de texte dans une extension VS.

Voir aussi

Référence

Microsoft.VisualStudio.TextTemplating, espace de noms

Autres ressources

Procédure pas à pas : création d'un hôte de modèle de texte personnalisé

Génération de code et modèles de texte T4

Historique des modifications

Date	Historique	Motif
Juin 2010	A clarifié certaines descriptions de méthode.	Améliorations apportées aux informations.