IVsAsyncShellOpenDocument.OpenStandardEditorAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
標準エディターを使用してファイルを開きます。 最初に、ファイルの既定のエディター ファクトリが既に構成されているかどうかを判断します。 既定値がまだ構成されていない場合は、優先度順に並べ替えられたエディター ファクトリの一覧をループ処理して、ドキュメントをサポートする最初のファクトリを見つけます。 ドキュメントを開くことができない場合は、例外がスローされます。
public Microsoft.VisualStudio.Shell.Interop.IVsTask OpenStandardEditorAsync (uint openStandardEditorFlags, string documentMoniker, Guid logicalView, string? ownerCaption, Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy? hierarchy, uint itemId, bool shouldGetDocDataFromRdt, object? docData, Microsoft.VisualStudio.OLE.Interop.IServiceProvider serviceProvider);abstract member OpenStandardEditorAsync : uint32 * string * Guid * string * Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy * uint32 * bool * obj * Microsoft.VisualStudio.OLE.Interop.IServiceProvider -> Microsoft.VisualStudio.Shell.Interop.IVsTaskPublic Function OpenStandardEditorAsync (openStandardEditorFlags As UInteger, documentMoniker 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パラメーター
- openStandardEditorFlags
- UInt32
または __VSOSEFLAGS2 列挙体から取得された値を__VSOSEFLAGS持つフラグ。
- documentMoniker
- String
プロジェクト システム内のドキュメントの一意のモニカー識別子の文字列形式 (ファイルへの完全パスなど)。 ファイル以外の場合、多くの場合、この識別子は URL の形式になります。
- 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 をご覧ください。
このメソッドは、 の CreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr, IntPtr, String, Guid, Int32) 結果を使用して、サポートされているエディター ファクトリを検索するために、リスト内の次のエディターにループを続ける必要があるかどうかを判断します。 具体的には、次のいずれかを返す必要があります: 1。 S_OK エディターがファイルをサポートし、正常に初期化された場合にループを停止する必要があることを示す 2。 "VS_E_UNSUPPORTEDFORMAT" 指定されたドキュメント データ 3 がエディターでサポートされていない場合は、ループを続行する必要があることを示します。 ループを停止する必要があることを示すその他のエラー コード。