ModelBusEnabledTextTransformation 類別

 

若要存取文字範本程式碼中的 Visual Studio ModelBus，請在範本之 template 指示詞的 inherits 屬性中指定這個類別，並將 hostspecific 屬性設為 true。  在範本程式碼中，您可以取得 SModelBus 和 SComponentModel 服務。  

命名空間:   Microsoft.VisualStudio.TextTemplating.Modeling
組件:  Microsoft.VisualStudio.TextTemplating.Modeling.12.0 (於 Microsoft.VisualStudio.TextTemplating.Modeling.12.0.dll)

繼承階層

System.Object
  Microsoft.VisualStudio.TextTemplating.TextTransformation
    Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation
      Microsoft.VisualStudio.TextTemplating.Modeling.ModelBusEnabledTextTransformation

語法

public abstract class ModelBusEnabledTextTransformation : ModelingTextTransformation

public ref class ModelBusEnabledTextTransformation abstract : ModelingTextTransformation

[<AbstractClass>]
type ModelBusEnabledTextTransformation = 
    class
        inherit ModelingTextTransformation
    end

Public MustInherit Class ModelBusEnabledTextTransformation
    Inherits ModelingTextTransformation

建構函式

	名稱	描述
	ModelBusEnabledTextTransformation()

屬性

	名稱	描述
	CurrentIndent	取得目前縮排文字，這個文字是每行所產生之文字輸出都有前置文字。(繼承自 TextTransformation。)
	Errors	此 API 支援 產品 基礎結構，而且不適合直接從程式碼使用。 取得文字範本轉換程序的錯誤集合。(繼承自 TextTransformation。)
	GenerationEnvironment	取得或設定字串，文字範本轉換程序會使用這個字串來組合產生的文字輸出。(繼承自 TextTransformation。)
	ModelBus	取得這個基底類別所提供的 Visual Studio ModelBus 服務。
	ServiceProvider	, 包含 Visual Studio ModelBus 的服務提供者。不使用主機的服務提供者。(覆寫 ModelingTextTransformation.ServiceProvider。)
	Session	(繼承自 ModelingTextTransformation。)
	SkipValidation	如果為 true，ValidateStore() 不會執行驗證並且會傳回 false。預設值為 false。(繼承自 ModelingTextTransformation。)
	Store	取得模型存放區。(繼承自 ModelingTextTransformation。)

方法

	名稱	描述
	AddDomainModel(Type)	加入要供存放區載入的網域模型型別。在呼叫 Initialize() 之前，請先針對每個網域模型呼叫此項目。(繼承自 ModelingTextTransformation。)
	ClearIndent()	將 CurrentIndent 重設為空字串。(繼承自 TextTransformation。)
	Dispose()	釋放 TextTransformation 所使用的所有資源。(繼承自 TextTransformation。)
	Dispose(Boolean)	(繼承自 ModelingTextTransformation。)
	Equals(Object)	(繼承自 Object。)
	Error(String)	建立新錯誤，以儲存在文字範本轉換程序期間發生的錯誤資訊。(繼承自 TextTransformation。)
	Finalize()	允許 Object 在記憶體回收行程予以回收之前，嘗試釋放資源並執行其他清除作業。由記憶體回收行程所呼叫。(繼承自 TextTransformation。)
	GetHashCode()	(繼承自 Object。)
	GetType()	(繼承自 Object。)
	Initialize()	使用 AddModel() 載入指定的模型，讓主應用程式準備好要處理範本。(繼承自 ModelingTextTransformation。)
	MemberwiseClone()	(繼承自 Object。)
	OnSessionChanged(ITextTemplatingSession, ITextTemplatingSession)	每當提供的工作階段與最後一個記住的工作階段不同時呼叫。清除靜態 modelbus 執行個體，以準備讀取模型檔案的新快照。(覆寫 ModelingTextTransformation.OnSessionChanged(ITextTemplatingSession, ITextTemplatingSession)。)
	PopIndent()	從 CurrentIndent 中移除最新加入的文字。(繼承自 TextTransformation。)
	PushIndent(String)	將文字加入至 CurrentIndent，這個文字是每行所產生之文字輸出都有的前置文字。(繼承自 TextTransformation。)
	ReportError(ErrorCategory, String)	將 ModelBus 錯誤轉換為文字範本錯誤。根據分類值呼叫 this.Error 或 this.Warning。
	ToString()	(繼承自 Object。)
	TransformText()	在衍生類別中覆寫時，會產生轉換的文字輸出。(繼承自 TextTransformation。)
	ValidateStore(String, CompilerErrorCollection)	使用指定的驗證分類來驗證存放區。如果有錯誤則會傳回 true。(繼承自 ModelingTextTransformation。)
	Warning(String)	建立新警告，以儲存在文字範本轉換程序期間發生的錯誤資訊。(繼承自 TextTransformation。)
	Write(String)	將所指定字串的複本附加至產生的文字輸出。(繼承自 TextTransformation。)
	Write(String, Object[])	將格式化字串 (其中包含零個或更多格式規格) 附加至產生的文字輸出。每一個格式規格會由對應之物件引數的字串表示所取代。(繼承自 TextTransformation。)
	WriteLine(String)	將所指定字串的複本和預設行結束字元附加至產生的文字輸出。(繼承自 TextTransformation。)
	WriteLine(String, Object[])	將格式化字串 (其中包含零個或更多格式規格) 和預設行結束字元附加至產生的文字輸出。每一個格式規格會由對應之物件引數的字串表示所取代。(繼承自 TextTransformation。)

註解

若要在範本中可使用此文字轉換，您必須在 template 指示詞中將 hostspecific 屬性設定為 true。

範例

<#@ template debug="false" hostspecific="true" language="C#" inherits="Microsoft.VisualStudio.TextTemplating.Modeling.ModelBusEnabledTextTransformation" #>
<#@ assembly name="Microsoft.VisualStudio.TextTemplating.Modeling.11.0.dll" #>
<#@ assembly name="Microsoft.VisualStudio.Modeling.Sdk.Integration.11.0.dll" #>
<#@ import namespace="Microsoft.VisualStudio.Modeling.Integration" #>
<#@ output extension=".txt" #>
<# IModelBus modelbus = this.ServiceProvider.GetService(typeof(SModelBus)) as IModelBus; 
...
#>

執行緒安全

此類型的任何 public static (在 Visual Basic 中 共用 在 Visual Basic 中) 成員皆為安全執行緒。不保證任何執行個體成員為安全執行緒。

另請參閱

Microsoft.VisualStudio.TextTemplating.Modeling 命名空間

回到頁首