エディター内の Managed Extensibility Framework
エディターは、Managed Extensibility Framework (MEF) コンポーネントを使用して作成されます。 エディターを拡張するために独自の MEF コンポーネントを構築することができ、コードでエディター コンポーネントを使用することもできます。
MEF は、MEF プログラミング モデルに準拠するアプリケーションまたはコンポーネントの機能を追加および変更できる .NET ライブラリです。 Visual Studio エディターでは、MEF コンポーネント パーツの提供および使用の両方が可能です。
MEF は .NET Framework バージョン 4 の System.ComponentModel.Composition.dll アセンブリに含まれています。
MEF の詳細については、「Managed Extensibility Framework (MEF)」を参照してださい。
コンポーネント パーツと合成コンテナー
コンポーネント パーツは、次のいずれかまたは両方の操作を実行できるクラスまたはクラスのメンバーです。
別のコンポーネントを使用する
別のコンポーネントによって使用される
たとえば、倉庫の在庫コンポーネントによって提供される製品の購入可能性データに依存する注文入力コンポーネントを持つショッピング アプリケーションを考えてみます。 MEF 用語では、在庫部分で製品の購入可能性データを "エクスポート" でき、注文入力部分でデータを "インポート" できます。 注文入力部分と在庫部分は、相互に認識する必要がなく、(ホスト アプリケーションによって提供される) "合成コンテナー" によって一連のエクスポートを維持し、エクスポートとインポートを解決します。
通常、合成コンテナー CompositionContainer はホストによって所有されます。 合成コンテナーは、エクスポートされたコンポーネント パーツの "カタログ" を保持します。
コンポーネント パーツのエクスポートとインポート
パブリック クラスまたはクラスのパブリック メンバー (プロパティまたはメソッド) として実装されている限り、任意の機能をエクスポートできます。 コンポーネント パーツを ComposablePart から派生させる必要はありません。 代わりに、エクスポートするクラスまたはクラス メンバーに ExportAttribute 属性を追加する必要があります。 この属性では、別のコンポーネント パーツが機能をインポートする際に使用する "コントラクト" を指定します。
エクスポート コントラクト
ExportAttribute では、エクスポートされるエンティティ (クラス、インターフェイス、または構造体) を定義します。 通常、エクスポート属性は、エクスポートの型を指定するパラメーターを受け取ります。
[Export(typeof(ContentTypeDefinition))]
class TestContentTypeDefinition : ContentTypeDefinition { }
既定では、ExportAttribute 属性ではエクスポートするクラスの型であるコントラクトを定義します。
[Export]
[Name("Structure")]
[Order(After = "Selection", Before = "Text")]
class TestAdornmentLayerDefinition : AdornmentLayerDefinition { }
この例では、既定の [Export] 属性は [Export(typeof(TestAdornmentLayerDefinition))] と同じです。
次の例に示すように、プロパティまたはメソッドをエクスポートすることもできます。
[Export]
[Name("Scarlet")]
[Order(After = "Selection", Before = "Text")]
public AdornmentLayerDefinition scarletLayerDefinition;
MEF エクスポートをインポートする
MEF エクスポートを使用する場合は、エクスポートに使用したコントラクト (通常は型) を把握し、その値を持つ ImportAttribute 属性を追加する必要があります。 既定では、インポート属性は、変更するクラスの型である 1 つのパラメーターを受け取ります。 次のコード行では、IClassificationTypeRegistryService 型をインポートします。
[Import]
internal IClassificationTypeRegistryService ClassificationRegistry;
インポート/エクスポートに関する問題のトラブルシューティング: MEF コンポジション エラー ログにアクセスする
現在の VS インストールに存在しないものをインポートしようとした場合、またはインポートまたはエクスポートを誤って作成した場合は、問題が発生する可能性があります。 これらの問題を見つけて対処する主な方法は、%localappdata%\Microsoft\VisualStudio[yourVSVersion]\ComponentModelCache\Microsoft.VisualStudio.Default.err に格納されている Managed Extensibility Framework (MEF) コンポジション エラー ログを参照することです。
MEF コンポーネント パーツからエディター機能を取得する
既存のコードが MEF コンポーネント パーツである場合、MEF メタデータを使用してエディター コンポーネント パーツを使用できます。
MEF コンポーネント パーツからエディター機能を取得するには
グローバル アセンブリ キャッシュ (GAC) にある System.Composition.ComponentModel.dll およびエディター アセンブリへの参照を追加します。
関連する using ディレクティブを追加します。
using System.ComponentModel.Composition; using Microsoft.VisualStudio.Text;次のように、サービス インターフェイスに
[Import]属性を追加します。[Import] ITextBufferFactoryService textBufferService;サービスを取得したら、そのコンポーネントのいずれかを使用できます。
アセンブリをコンパイルしたら、Visual Studio のインストールの *..\Common7\IDE\Components* フォルダーにこれを配置します。