Share via


TextTransformation クラス

すべての生成された変換クラスの抽象基本クラスです。このクラスには、テキスト テンプレート コードで使用するユーティリティ メソッドおよびプロパティも用意されています。

継承階層

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

名前空間:  Microsoft.VisualStudio.TextTemplating
アセンブリ:  Microsoft.VisualStudio.TextTemplating.11.0 (Microsoft.VisualStudio.TextTemplating.11.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 によって使用されているアンマネージ リソースを解放し、オプションでマネージ リソースも解放します。
パブリック メソッド Equals 指定のオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (Object から継承されます。)
パブリック メソッド Error テキスト テンプレートの変換プロセス中に発生したエラーに関する情報を格納する新しいエラーを作成します。
プロテクト メソッド Finalize ガベージ コレクターにより収集される前に、Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。ガベージ コレクターによって呼び出されます。 (Object.Finalize() をオーバーライドします。)
パブリック メソッド GetHashCode 特定の型のハッシュ関数として機能します。 (Object から継承されます。)
パブリック メソッド GetType 現在のインスタンスの Type を取得します。 (Object から継承されます。)
パブリック メソッド Initialize インフラストラクチャ。 TextTransformation クラスを初期化します。
プロテクト メソッド MemberwiseClone 現在の Object の簡易コピーを作成します。 (Object から継承されます。)
パブリック メソッド PopIndent 最後に追加されたテキストを CurrentIndent から削除します。
パブリック メソッド PushIndent 生成されたテキスト出力の各行の先頭に付加されたテキストを CurrentIndent に追加します。
パブリック メソッド ToString 現在のオブジェクトを表す文字列を返します。 (Object から継承されます。)
パブリック メソッド TransformText 派生クラスでオーバーライドされた場合に、変換のテキスト出力を生成します。
パブリック メソッド Warning テキスト テンプレートの変換プロセス中に発生したエラーに関する情報を格納する新しい警告を生成します。
パブリック メソッド Write(String) 指定した文字列のコピーを、生成されたテキスト出力の末尾に追加します。
パブリック メソッド Write(String, array<Object[]) 0 個以上の書式指定を含む書式付き文字列を、生成されたテキスト出力の末尾に追加します。各書式指定は、対応するオブジェクト引数の文字列形式に置換されます。
パブリック メソッド WriteLine(String) 指定した文字列のコピーと既定の行終端記号を、生成されたテキスト出力の末尾に追加します。
パブリック メソッド WriteLine(String, array<Object[]) 0 個以上の書式指定を含む書式指定文字列と既定の行終端記号を、生成されたテキスト出力の末尾に追加します。各書式指定は、対応するオブジェクト引数の文字列形式に置換されます。

このページのトップへ

解説

テキスト テンプレートの変換プロセスには 2 つの手順があります。最初の手順では、テキスト テンプレートの変換エンジンは、生成された変換クラスと呼ばれるクラスを作成します。2 番目の手順で、エンジンによって生成済み変換クラスがコンパイルおよび実行され、生成済みテキスト出力が生成されます。生成される変換クラスは、TextTransformation から継承します。

テキスト テンプレート内で inherits ディレクティブ で指定されたクラスは、それ自体が TextTransformation から継承している必要があります。TransformText は、このクラスの唯一の abstract メンバーです。

スレッド セーフ

この型のすべてのパブリック static (Visual Basic では Shared) メンバーは、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。

参照

関連項目

Microsoft.VisualStudio.TextTemplating 名前空間

その他の技術情報

コード生成と T4 テキスト テンプレート