チュートリアル: カスタムエディターに機能を追加する

[アーティクル]
06/19/2023

カスタムエディターを作成した後に、機能を追加することができます。

VSPackage のエディターを作成するには

Visual Studio パッケージプロジェクトテンプレートを使用してカスタムエディターを作成します。

詳細については、「チュートリアル: カスタムエディターを作成する」を参照してください。
エディターで 1 つのビューと複数のビューのどちらをサポートするかを決定します。

[新しいウィンドウ] コマンドをサポートするエディター、またはフォームビューとコードビューがあるエディターには、ドキュメントデータオブジェクトとドキュメントビューオブジェクトを別々に用意する必要があります。 1 つのビューのみをサポートするエディターの場合、ドキュメントデータオブジェクトとドキュメントビューオブジェクトを同じオブジェクトに実装できます。

複数のビューの例については、「複数のドキュメントビューのサポート」を参照してください。
IVsEditorFactory インターフェイスを設定して、エディターファクトリを実装します。

詳細については、「エディターファクトリ」を参照してください。
エディターで、ドキュメントビューオブジェクトウィンドウを管理するためにインプレースアクティブ化と簡易埋め込みのどちらを使用するかを決定します。

簡易埋め込みエディターウィンドウは標準のドキュメントビューをホストし、インプレースアクティブ化エディターウィンドウは ActiveX コントロールまたはその他のアクティブオブジェクトをドキュメントビューとしてホストします。詳細については、「簡易埋め込み」と「インプレースアクティブ化」を参照してください。
コマンドを処理する IOleCommandTarget インターフェイスを実装します。
ドキュメントの保持機能と外部ファイルの変更への応答機能を用意します。
1. ファイルを保持するには、エディターのドキュメントデータオブジェクトに IVsPersistDocData2 と IPersistFileFormat を実装します。
2. 外部ファイルの変更に応答するには、エディターのドキュメントデータオブジェクトに IVsFileChangeEx と IVsDocDataFileChangeControl を実装します。
  
  Note
  
  SVsFileChangeEx に対して QueryService を呼び出し、IVsFileChangeEx へのポインターを取得します。
ソースコード管理を使用してドキュメント編集イベントを調整します。次のステップを実行します。
1. SVsQueryEditQuerySave に対して QueryService を呼び出し、IVsQueryEditQuerySave2 へのポインターを取得します。
2. 最初の編集イベントが発生したら、QueryEditFiles メソッドを呼び出します。
  
  このメソッドは、ファイルがまだチェックアウトされていない場合にファイルをチェックアウトするようにユーザーに促すものです。エラーを回避するために、必ず "ファイルがチェックアウトされていない" 条件を処理してください。
3. 同様に、ファイルを保存する前に、QuerySaveFile メソッドを呼び出します。
  
  このメソッドは、ファイルが保存されていない場合、または最後の保存以降に変更された場合に、ファイルを保存するようにユーザーに促すものです。
エディターで選択したテキストのプロパティを表示するには、[プロパティ] ウィンドウを有効にします。次のステップを実行します。
1. テキストの選択が変更されるたびに OnSelectChange を呼び出し、ISelectionContainer の実装を渡します。
2. STrackSelection サービスに対して QueryService を呼び出し、ITrackSelection へのポインターを取得します。
ユーザーがエディターとツールボックスの間、または外部エディター (Microsoft Word など) とツールボックスの間で項目をドラッグアンドドロップできるようにします。次のステップを実行します。
1. エディターに IDropTarget を実装し、エディターがドロップターゲットであることを IDE に警告します。
2. エディターでツールボックスの項目を有効または無効にできるように、ビューに IVsToolboxUser インターフェイスを実装します。
3. ResetDefaults を実装し、SVsToolbox サービスに対して QueryService を呼び出し、IVsToolbox2 と IVsToolbox3 のインターフェイスへのポインターを取得します。
  
  以上の手順で、VSPackage から新しい項目をツールボックスに追加できるようになります。
エディターに他のオプション機能が必要かどうかを決定します。
- エディターで検索と置換のコマンドをサポートする場合は、IVsFindTarget を実装します。
- エディターでドキュメントアウトラインツールウィンドウを使用する場合は、IVsDocOutlineProvider を実装します。
- エディターでステータスバーを使用する場合は、IVsStatusbarUser を実装し、SVsStatusbar に対して QueryService を呼び出し、IVsStatusBar へのポインターを取得します。
  
  たとえば、エディターには、行と列の情報、選択モード (ストリームとボックス)、挿入モード (挿入と上書き) を表示できます。
- エディターで Undo コマンドをサポートする場合は、OLE の元に戻すマネージャーモデルを使用することをお勧めします。また、エディターで Undo コマンドを直接処理する方法もあります。

VSPackage、メニュー、エディター、その他の機能の GUID を含むレジストリ情報を作成します。

エディターを適切に登録する方法を示すために、.rgs ファイルスクリプトに配置するコードの一般的な例を次に示します。

NoRemove Editors
{
      ForceRemove {...guidEditor...} = s 'RTF Editor'
      {
         val Package = s '{...guidVsPackage...}'
         ForceRemove Extensions
         {
            val rtf = d 50
         }
      }
}
NoRemove Menus
{
      val {...guidVsPackage...} = s ',203,11'
}

状況依存のヘルプのサポートを実装します。

この手順を実行すると、エディター内の項目に F1 ヘルプと動的ヘルプウィンドウをサポートできるようになります。詳細については、「方法: エディターにコンテキストを提供する」を参照してください。
IDispatch インターフェイスを実装することで、エディターからオートメーションオブジェクトモデルを公開します。

詳細については、「Automation モデルの概要」を参照してください。

信頼性の高いプログラミング

エディターインスタンスは、IDE から CreateEditorInstance メソッドが呼び出されたときに作成されます。エディターが複数のビューをサポートしている場合、CreateEditorInstance により、ドキュメントデータとドキュメントビューのオブジェクトが両方作成されます。ドキュメントデータオブジェクトが既に開かれている場合は、null ではない punkDocDataExisting 値が IVsEditorFactory::CreateEditorInstance に渡されます。エディターファクトリの実装の場合、既存のドキュメントデータオブジェクトに適切なインターフェイスのクエリを実行して、互換性があるかどうかを判断する必要があります。詳細については、「複数のドキュメントビューのサポート」を参照してください。
簡易埋め込みアプローチを使用する場合は、IVsWindowPane インターフェイスを実装します。
インプレースアクティブ化を使用する場合は、次のインターフェイスを実装します。

IOleObject

IOleInPlaceActiveObject

IOleInPlaceComponent

Note

IOleInPlaceComponent インターフェイスは、OLE 2 メニューのマージを回避するために使用されます。

IOleCommandTarget の実装により、切り取り、コピー、貼り付けなどのコマンドを処理します。 IOleCommandTarget を実装する場合は、独自のコマンドメニュー構造を定義するために独自の .vsct ファイルがエディターに必要か、それとも Visual Studio に定義されている標準のコマンドを実装できるかを決定します。通常、エディターに IDE のメニューを使用して拡張し、独自のツールバーを定義します。ただし、エディターに IDE の標準のコマンドセットを使用するだけでなく、独自の特定のコマンドを定義する必要があることがよくあります。エディターにより、使用する標準のコマンドを宣言してから、新しいコマンド、コンテキストメニュー、トップレベルメニュー、およびツールバーを .vsct ファイルで定義する必要があります。インプレースアクティブ化エディターを作成する場合は、OLE 2 メニューのマージを使用するのではなく、IOleInPlaceComponent を実装し、エディターのメニューとツールバーを .vsct ファイルで定義します。
UI でメニューコマンドが煩雑になるのを防ぐには、新しいコマンドを作成する前に、IDE の既存のコマンドを使用するようにします。共有コマンドは、SharedCmdDef.vsct と ShellCmdDef.vsct で定義されています。これらのファイルは、既定で Visual Studio SDK インストールの VisualStudioIntegration\Common\Inc サブディレクトリにインストールされています。
ISelectionContainer を使用して、1 つの選択と複数の選択の両方を表すことができます。選択された各オブジェクトは、IDispatch オブジェクトとして実装されます。
IDE には、CreateInstance からアクセス可能なサービスとして、または CreateInstance を介してインスタンス化できるオブジェクトとして IOleUndoManager が実装されています。このエディターには、Undo アクションごとに IOleUndoUnit インターフェイスが実装されています。
カスタムエディターからオートメーションオブジェクトを公開できる場所は 2 つあります。
- Document.Object
- Window.Object

オートメーションモデルの概要

チュートリアル: カスタム エディターに機能を追加する

VSPackage のエディターを作成するには

信頼性の高いプログラミング

関連するコンテンツ

その他のリソース

チュートリアル: カスタムエディターに機能を追加する