Udostępnij za pośrednictwem


Interfejs ITextTemplatingEngineHost

Interfejs dla hosta, który przekształca tekst szablonów.Jest dostępna dla przetwórców w dyrektywie i można również uzyskiwać szablony tekstu.

Przestrzeń nazw:  Microsoft.VisualStudio.TextTemplating
Zestaw:  Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (w Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll)

Składnia

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

Typ ITextTemplatingEngineHost uwidacznia następujące elementy członkowskie.

Właściwości

  Nazwa Opis
Właściwość publiczna StandardAssemblyReferences Pobiera listę odwołania do zestawów.
Właściwość publiczna StandardImports Pobiera listę nazw.
Właściwość publiczna TemplateFile Pobiera ścieżkę i nazwę szablonu tekst, który jest przetwarzana.

Początek

Metody

  Nazwa Opis
Metoda publiczna GetHostOption Wywołana przez silnik poprosić o wartości określonej opcji.Zwraca wartość null, jeśli nie jest znana.
Metoda publiczna LoadIncludeText Nabywa tekstu, który odpowiada na żądanie, aby dołączyć plik szablonu fragment tekstu.
Metoda publiczna LogErrors Odbiera kolekcji błędów i ostrzeżeń z silnika transformacji.
Metoda publiczna ProvideTemplatingAppDomain Zapewnia domeny aplikacji do uruchomienia klasy generowane transformacji.
Metoda publiczna ResolveAssemblyReference Umożliwia hosta podać dodatkowe informacje o lokalizacji asemblowania.
Metoda publiczna ResolveDirectiveProcessor Zwraca typ procesora w dyrektywie, biorąc pod uwagę jego przyjaznej nazwy.
Metoda publiczna ResolveParameterValue Eliminuje wartość parametru dla procesora w dyrektywie, jeśli nie określono parametru w tekście szablonu.
Metoda publiczna ResolvePath Umożliwia hosta zapewnić pełną ścieżkę, podana nazwa pliku lub ścieżkę względną.
Metoda publiczna SetFileExtension Informuje hosta rozszerzenie nazwy pliku, oczekiwanej dla generowanych tekstowych danych wyjściowych.
Metoda publiczna SetOutputEncoding Informuje hosta, że kodowania, który oczekuje danych wyjściowych generowanych tekstu.

Początek

Uwagi

Host pobiera plik szablonu tekst jako dane wejściowe i wytwarza w pliku tekstowym jako dane wyjściowe.Typowy host jest TextTemplatingFileGenerator narzędzie przekształca szablonów w Visual Studio projektu.Wywołuje jeden lub więcej procesorów w dyrektywie z innymi typami szablonu.Członkowie tego interfejsu są dostępne, dyrektywa przetwórców oraz kod szablonu tekstu.Aparat tekst szablonu kontroluje ten proces i współdziała z hosta i jeden lub większą liczbę procesorów w dyrektywie.Aby dowiedzieć się więcej na temat tych składników, zobacz Kod generacji i szablony tekst T4.

Aby udostępnić hosta do kodu szablonu tekstu, należy ustawić hostspecific parametr dyrektywy szablonu.Na przykład:

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

Jeśli chcesz użyć szablonów tekstu poza Visual Studio lub z narzędzia niestandardowe, można napisać niestandardowy hosta, realizacji tego interfejsu.Na przykład, zobacz Instruktaż: Tworzenie hosta szablon niestandardowy tekst.

Zobacz też

Informacje

Przestrzeń nazw Microsoft.VisualStudio.TextTemplating

Inne zasoby

Instruktaż: Tworzenie hosta szablon niestandardowy tekst

Kod generacji i szablony tekst T4