IVsAsyncShellOpenDocument.OpenSpecificEditorAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
指定したエディターを使用してドキュメントを非同期で開きます。
public Microsoft.VisualStudio.Shell.Interop.IVsTask OpenSpecificEditorAsync (uint openSpecificEditorFlags, string documentMoniker, Guid editorType, string? physicalView, Guid logicalView, string? ownerCaption, Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy? hierarchy, uint itemId, bool shouldGetDocDataFromRdt, object? docData, Microsoft.VisualStudio.OLE.Interop.IServiceProvider serviceProvider);
abstract member OpenSpecificEditorAsync : uint32 * string * Guid * string * Guid * string * Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy * uint32 * bool * obj * Microsoft.VisualStudio.OLE.Interop.IServiceProvider -> Microsoft.VisualStudio.Shell.Interop.IVsTask
Public Function OpenSpecificEditorAsync (openSpecificEditorFlags As UInteger, documentMoniker As String, editorType As Guid, physicalView As String, logicalView As Guid, ownerCaption As String, hierarchy As IVsUIHierarchy, itemId As UInteger, shouldGetDocDataFromRdt As Boolean, docData As Object, serviceProvider As IServiceProvider) As IVsTask
パラメーター
- openSpecificEditorFlags
- UInt32
列挙体から __VSOSPEFLAGS 値が取得されるフラグ。
- documentMoniker
- String
プロジェクト システム内のドキュメントの一意のモニカー識別子の文字列形式 (ファイルへの完全パスなど)。 ファイル以外の場合、多くの場合、この識別子は URL の形式になります。
- physicalView
- String
物理ビューまたは null
の名前。
の場合 null
、環境はエディター ファクトリで を呼び出 MapLogicalView(Guid, String)
して、論理ビューに対応する物理ビューを決定します。
この場合、 null
はプライマリ ビューを指定するのではなく、論理ビューに対応するビューがわからないことを示します。
- logicalView
- Guid
Guid論理ビューを識別する 。 既定のビューは であり VSConstants.LOGVIEWID_Primary
、すべてのエディターでそのビューをサポートする必要があります。
エディターがドキュメント ビュー オブジェクトにを実装 IVsMultiViewDocumentView する場合は、 に ActivateLogicalView(Guid)渡される値によって、エディター ウィンドウが表示されるときにアクティブ化されるビューが決まります。
論理ビュー Guidを指定すると、ビューを要求する理由と一致する特定のビューを要求できます。
たとえば、 を指定 VSConstants.LOGVIEWID_Debugging
すると、デバッグに適したビューを取得したり VSConstants.LOGVIEWID_TextView
、テキスト エディターに適したビュー (つまり を実装 IVsCodeWindowするビュー) を取得したりできます。
- ownerCaption
- String
初期キャプションドキュメント ウィンドウのドキュメント所有者 (つまりプロジェクト) によって定義されます。 これは多くの場合、"ProjectName – ItemName" という形式です。
- hierarchy
- IVsUIHierarchy
ドキュメントを所有する への IVsUIHierarchy 参照。
- itemId
- UInt32
標準エディターの UI 階層項目識別子。 詳細については、「VSConstants.VSITEMID
」を参照してください。
- shouldGetDocDataFromRdt
- Boolean
の場合、環境は実行中のドキュメント テーブルから取得したドキュメント データ オブジェクトを使用します。それ以外の場合 true
、サービスは に渡されたドキュメント データを使用してドキュメントを docData
開きます。
- docData
- Object
または null
を開くアイテムのドキュメント データ オブジェクトへの参照。 が の場合shouldGetDocDataFromRdt
true
、このパラメーターに渡されるこの値は無視されます。
- serviceProvider
- IServiceProvider
IServiceProvider への参照。
戻り値
開いている操作が開始されたことを表すタスク。
タスクの結果は、 への IVsAsyncOpenDocumentResult参照になります。ドキュメントが環境内で開かれた場合は 。それ以外の場合 null
は 。
注釈
このメソッドによって返されるタスクは、ドキュメントのビューと docdata が読み込まれたことを示すものではありません。 詳細については、 DocumentLoadTask をご覧ください。