ModelBusEnabledTextTransformation クラス
テキスト テンプレートのコードで Visual Studio ModelBus にアクセスするには、テンプレートの template ディレクティブの inherits 属性でこのクラスを指定し、hostspecific 属性を true に設定します。 テンプレート コードで、SModelBus サービスおよび SComponentModel サービスを取得できます。
継承階層
System.Object
Microsoft.VisualStudio.TextTemplating.TextTransformation
Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation
Microsoft.VisualStudio.TextTemplating.Modeling.ModelBusEnabledTextTransformation
名前空間: Microsoft.VisualStudio.TextTemplating.Modeling
アセンブリ: Microsoft.VisualStudio.TextTemplating.Modeling.10.0 (Microsoft.VisualStudio.TextTemplating.Modeling.10.0.dll 内)
構文
'宣言
Public MustInherit Class ModelBusEnabledTextTransformation _
Inherits ModelingTextTransformation
public abstract class ModelBusEnabledTextTransformation : ModelingTextTransformation
public ref class ModelBusEnabledTextTransformation abstract : public ModelingTextTransformation
[<AbstractClass>]
type ModelBusEnabledTextTransformation =
class
inherit ModelingTextTransformation
end
public abstract class ModelBusEnabledTextTransformation extends ModelingTextTransformation
ModelBusEnabledTextTransformation 型で公開されるメンバーは以下のとおりです。
コンストラクター
名前 | 説明 | |
---|---|---|
ModelBusEnabledTextTransformation |
このページのトップへ
プロパティ
名前 | 説明 | |
---|---|---|
CurrentIndent | 生成されたテキスト出力の各行の先頭に付加された現在のインデント テキストを取得します。 (TextTransformation から継承されます。) | |
Errors | インフラストラクチャ。 テキスト テンプレート変換プロセスのエラー コレクションを取得します。 (TextTransformation から継承されます。) | |
GenerationEnvironment | 生成されたテキスト出力をアセンブルするためにテキスト テンプレートの変換プロセスによって使用されている文字列を取得または設定します。 (TextTransformation から継承されます。) | |
ModelBus | この基本クラスが提供する Visual Studio ModelBus サービスを取得します。 | |
ServiceProvider | Visual Studio ModelBus が含まれるサービス プロバイダーを返します。ホストからのサービス プロバイダーを使用しません。 (ModelingTextTransformation.ServiceProvider をオーバーライドします。) | |
Session | (ModelingTextTransformation から継承されます。) | |
SkipValidation | true の場合、ValidateStore() は検証を実行せずに false を返します。既定値は false です。 (ModelingTextTransformation から継承されます。) | |
Store | モデリング ストアを取得します。 (ModelingTextTransformation から継承されます。) |
このページのトップへ
メソッド
名前 | 説明 | |
---|---|---|
AddDomainModel | ストアに読み込まれるドメイン モデルの型を追加します。Initialize() を呼び出す前に各ドメイン モデルについてこのメソッドを呼び出します。 (ModelingTextTransformation から継承されます。) | |
ClearIndent | CurrentIndent を空の文字列にリセットします。 (TextTransformation から継承されます。) | |
Dispose() | TextTransformation によって使用されているすべてのリソースを解放します。 (TextTransformation から継承されます。) | |
Dispose(Boolean) | (ModelingTextTransformation から継承されます。) | |
Equals | 指定した Object が、現在の Object と等しいかどうかを判断します。 (Object から継承されます。) | |
Error | テキスト テンプレートの変換プロセス中に発生したエラーに関する情報を格納する新しいエラーを作成します。 (TextTransformation から継承されます。) | |
Finalize | ガベージ コレクターにより収集される前に、Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。ガベージ コレクターによって呼び出されます。 (TextTransformation から継承されます。) | |
GetHashCode | 特定の型のハッシュ関数として機能します。 (Object から継承されます。) | |
GetType | 現在のインスタンスの Type を取得します。 (Object から継承されます。) | |
Initialize | AddModel() で指定されたモデルを読み込んで、テンプレートを処理できるようにホストを準備します。 (ModelingTextTransformation から継承されます。) | |
MemberwiseClone | 現在の Object の簡易コピーを作成します。 (Object から継承されます。) | |
OnSessionChanged | 最後に記憶したセッションと同じでないセッションが提供されるたびに呼び出されます。静的モジュール インスタンスを消去して、読み取るモデル ファイルの新しいスナップショットを準備します。 (ModelingTextTransformation.OnSessionChanged(ITextTemplatingSession, ITextTemplatingSession) をオーバーライドします。) | |
PopIndent | 最後に追加されたテキストを CurrentIndent から削除します。 (TextTransformation から継承されます。) | |
PushIndent | 生成されたテキスト出力の各行の先頭に付加されたテキストを CurrentIndent に追加します。 (TextTransformation から継承されます。) | |
ReportError | ModelBus エラーからテキスト テンプレート エラーに変換します。カテゴリ値に応じて、this.Error または this.Warning を呼び出します。 | |
ToString | 現在のオブジェクトを表す文字列を返します。 (Object から継承されます。) | |
TransformText | 派生クラスでオーバーライドされた場合に、変換のテキスト出力を生成します。 (TextTransformation から継承されます。) | |
ValidateStore | 指定された検証カテゴリを使用してストアを検証します。エラーがあった場合は true を返します。 (ModelingTextTransformation から継承されます。) | |
Warning | テキスト テンプレートの変換プロセス中に発生したエラーに関する情報を格納する新しい警告を生成します。 (TextTransformation から継承されます。) | |
Write(String) | 指定した文字列のコピーを、生成されたテキスト出力の末尾に追加します。 (TextTransformation から継承されます。) | |
Write(String, array<Object[]) | 0 個以上の書式指定を含む書式付き文字列を、生成されたテキスト出力の末尾に追加します。各書式指定は、対応するオブジェクト引数の文字列形式に置換されます。 (TextTransformation から継承されます。) | |
WriteLine(String) | 指定した文字列のコピーと既定の行終端記号を、生成されたテキスト出力の末尾に追加します。 (TextTransformation から継承されます。) | |
WriteLine(String, array<Object[]) | 0 個以上の書式指定を含む書式指定文字列と既定の行終端記号を、生成されたテキスト出力の末尾に追加します。各書式指定は、対応するオブジェクト引数の文字列形式に置換されます。 (TextTransformation から継承されます。) |
このページのトップへ
解説
このテキスト変換をでテンプレートを使用するには、template ディレクティブで hostspecific 属性を true に設定する必要があります。
例
<#@ template debug="false" hostspecific="true" language="C#" inherits="Microsoft.VisualStudio.TextTemplating.Modeling.ModelBusEnabledTextTransformation" #>
<#@ assembly name="Microsoft.VisualStudio.TextTemplating.Modeling.10.0.dll" #>
<#@ assembly name="Microsoft.VisualStudio.Modeling.Sdk.Integration.10.0.dll" #>
<#@ import namespace="Microsoft.VisualStudio.Modeling.Integration" #>
<#@ output extension=".txt" #>
<# IModelBus modelbus = this.ServiceProvider.GetService(typeof(SModelBus)) as IModelBus;
...
#>
スレッド セーフ
この型のすべてのパブリック static (Visual Basic では Shared) メンバーは、スレッド セーフです。 インスタンス メンバーの場合は、スレッド セーフであるとは限りません。