TextTransformation 類別
所有產生之轉換類別的抽象基底類別。 這個類別也提供用於文字範本程式碼的公用程式方法和屬性。
繼承階層架構
System.Object
Microsoft.VisualStudio.TextTemplating.TextTransformation
Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation
命名空間: Microsoft.VisualStudio.TextTemplating
組件: Microsoft.VisualStudio.TextTemplating.10.0 (在 Microsoft.VisualStudio.TextTemplating.10.0.dll 中)
語法
'宣告
Public MustInherit Class TextTransformation _
Implements IDisposable
public abstract class TextTransformation : IDisposable
public ref class TextTransformation abstract : IDisposable
[<AbstractClass>]
type TextTransformation =
class
interface IDisposable
end
public abstract class TextTransformation implements IDisposable
TextTransformation 型別會公開下列成員。
建構函式
名稱 | 說明 | |
---|---|---|
TextTransformation | 初始化 TextTransformation 類別的新執行個體。 |
回頁首
屬性
名稱 | 說明 | |
---|---|---|
CurrentIndent | 取得目前縮排文字,這個文字是每行所產生之文字輸出都有前置文字。 | |
Errors | 基礎架構。取得文字範本轉換程序的錯誤集合。 | |
GenerationEnvironment | 取得或設定字串,文字範本轉換程序會使用這個字串來組合產生的文字輸出。 | |
Session | 取得或設定目前的工作階段。工作階段表示在同一個使用者命令內執行的一連串轉換。工作階段物件可以用來將資訊傳輸至文字範本的程式碼。 |
回頁首
方法
名稱 | 說明 | |
---|---|---|
ClearIndent | 將 CurrentIndent 重設為空字串。 | |
Dispose() | 釋放 TextTransformation 所使用的所有資源。 | |
Dispose(Boolean) | 釋放 TextTransformation 所使用的 Unmanaged 資源,並選擇性釋放 Managed 資源。 | |
Equals | 判斷指定的 Object 和目前的 Object 是否相等。 (繼承自 Object)。 | |
Error | 建立新錯誤,以儲存在文字範本轉換程序期間發生的錯誤資訊。 | |
Finalize | 允許 Object 在記憶體回收行程予以回收之前,嘗試釋放資源並執行其他清除作業。由記憶體回收行程所呼叫。 (覆寫 Object.Finalize()。) | |
GetHashCode | 做為特定型別的雜湊函式。 (繼承自 Object)。 | |
GetType | 取得目前執行個體的 Type。 (繼承自 Object)。 | |
Initialize | 基礎架構。初始化 TextTransformation 類別。 | |
MemberwiseClone | 建立目前 Object 的淺層複本 (Shallow Copy)。 (繼承自 Object)。 | |
PopIndent | 從 CurrentIndent 中移除最新加入的文字。 | |
PushIndent | 將文字加入至 CurrentIndent,這個文字是每行所產生之文字輸出都有的前置文字。 | |
ToString | 傳回表示目前物件的字串。 (繼承自 Object)。 | |
TransformText | 在衍生類別中覆寫時,會產生轉換的文字輸出。 | |
Warning | 建立新警告,以儲存在文字範本轉換程序期間發生的錯誤資訊。 | |
Write(String) | 將所指定字串的複本附加至產生的文字輸出。 | |
Write(String, array<Object[]) | 將格式化字串 (其中包含零個或更多格式規格) 附加至產生的文字輸出。每一個格式規格會由對應之物件引數的字串表示所取代。 | |
WriteLine(String) | 將所指定字串的複本和預設行結束字元附加至產生的文字輸出。 | |
WriteLine(String, array<Object[]) | 將格式化字串 (其中包含零個或更多格式規格) 和預設行結束字元附加至產生的文字輸出。每一個格式規格會由對應之物件引數的字串表示所取代。 |
回頁首
備註
文字範本轉換處理序有兩個步驟。 在第一個步驟中,文字範本轉換引擎會建立做為所產生的轉換類別之參考的類別。 在第二個步驟中,引擎會編譯並執行所產生的轉換類別,以產生所產生的文字輸出。 產生的轉換類別是繼承自 TextTransformation。
文字範本中的 inherits 指示詞中指定的任何類別本身必須繼承自 TextTransformation。 TransformText 是這個類別唯一的 abstract 成員。
執行緒安全
這個型別的任何 Public static (在 Visual Basic 中為 Shared) 成員都具備執行緒安全。並非所有的執行個體成員都是安全執行緒。
請參閱
參考
Microsoft.VisualStudio.TextTemplating 命名空間