ITextTemplatingEngineHost 介面

發行項
10/31/2012

轉換文字範本之主應用程式的介面。這可以供指示詞處理器使用，也可以由文字範本存取。

命名空間： Microsoft.VisualStudio.TextTemplating
組件： Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (在 Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll 中)

語法

'宣告
<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

ITextTemplatingEngineHost 型別會公開下列成員。

屬性

	名稱	說明
	StandardAssemblyReferences	取得組件參考清單。
	StandardImports	取得命名空間清單。
	TemplateFile	取得要處理之文字範本的路徑和檔名。

回頁首

方法

	名稱	說明
	GetHostOption	由引擎呼叫這個方法，以要求指定的選項值。如果您不知道則傳回 Null。
	LoadIncludeText	取得對應至要求以包含部分文字範本檔案的文字。
	LogErrors	從轉換引擎收到錯誤和警告的集合。
	ProvideTemplatingAppDomain	提供應用程式定義域，以執行產生的轉換類別。
	ResolveAssemblyReference	允許主應用程式提供其他關於組件位置的資訊。
	ResolveDirectiveProcessor	根據指定之指示詞處理器的易記名稱，傳回該指示詞處理器的型別。
	ResolveParameterValue	如果範本文字中未指定參數，則解析指示詞處理器的參數值。
	ResolvePath	允許主機提供完整路徑，指定檔案名稱或相對路徑。
	SetFileExtension	通知主應用程式，產生之文字輸出預期會有的副檔名。
	SetOutputEncoding	通知主應用程式，產生之文字輸出預期會有的編碼方式。

回頁首

備註

主機將文字範本檔視為輸入，並且產生輸出文字檔。典型的主機是 TextTemplatingFileGenerator 工具，可以轉換 Visual Studio專案中的範本。這會叫用一或多個處理器，以處理不同類型的範本。此介面的成員可供指示詞處理器及文字範本程式碼存取。文字範本引擎會控制這個處理序，並與主應用程式和一或多個指示詞處理器互動。若要了解這些元件的詳細資訊，請參閱程式碼產生和 T4 文字範本。

若要讓文字範本的程式碼可以存取主機，請設定範本指示詞的 hostspecific 參數。例如：

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

如果想要使用 Visual Studio 外部的文字範本或自訂工具，您可以撰寫自訂主機，並實作這個介面。如需範例，請參閱逐步解說：建立自訂文字範本主機。