IVsAsyncShellOpenDocument.OpenStandardEditorAsync Metoda

Reference

Definice

Obor názvů:: Microsoft.VisualStudio.Shell.Interop

Sestavení:: Microsoft.VisualStudio.Interop.dll

Balíček:: Microsoft.VisualStudio.Interop v17.9.37000

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Otevře soubor pomocí standardního editoru. Nejprve určí, jestli už je nakonfigurovaný výchozí objekt editoru pro soubor. Pokud výchozí nastavení ještě není nakonfigurované, bude cyklicky procházet seznamem továren editoru seřazeným podle priority, aby se našla první, která dokument podporuje. Pokud dokument nelze otevřít, vyvolá se výjimka.

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.IVsTask

Public 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

Parametry

openStandardEditorFlags: UInt32

Příznaky, jejichž hodnoty jsou převzaty z výčtu __VSOSEFLAGS nebo __VSOSEFLAGS2 .

documentMoniker: String

Řetězcová forma jedinečného identifikátoru monikeru dokumentu v systému projektu, například úplná cesta k souboru. V nezadávkovaných případech má tento identifikátor často podobu adresy URL.

logicalView: Guid

Identifikující Guid logické zobrazení. Výchozí zobrazení je VSConstants.LOGVIEWID_Primary a každý editor musí toto zobrazení podporovat.

Pokud editor implementuje IVsMultiViewDocumentView objekt zobrazení dokumentu, hodnota předaná do ActivateLogicalView(Guid), která určuje, které zobrazení je aktivováno při zobrazení okna editoru.

Zadáním logického zobrazení Guidmůžete požádat o konkrétní zobrazení, které odpovídá důvodu, proč o zobrazení žádáte. Můžete například zadat VSConstants.LOGVIEWID_Debugging , aby se získalo zobrazení vhodné pro ladění, nebo VSConstants.LOGVIEWID_TextView zobrazení vhodné pro textový editor (to znamená zobrazení, které implementuje IVsCodeWindow).

ownerCaption: String

Počáteční popis definované vlastníkem dokumentu (tj. projektem) pro okno dokumentu. Často se jedná o tento formát: ProjectName – ItemName.

hierarchy: IVsUIHierarchy

Odkaz na IVsUIHierarchy soubor, který je vlastníkem dokumentu.

itemId: UInt32

Identifikátor položky hierarchie uživatelského rozhraní standardního editoru. Další informace naleznete zde VSConstants.VSITEMID.

shouldGetDocDataFromRdt: Boolean

Pokud true, použije prostředí datový objekt dokumentu získaný ze spuštěné tabulky dokumentů. V opačném případě služba dokument otevře pomocí dat dokumentace předaných službě docData.

docData: Object

Odkaz na datový objekt dokumentu položky, která se má otevřít, nebo null. Tato hodnota předaná tomuto parametru se ignoruje, pokud shouldGetDocDataFromRdt je truehodnota .

serviceProvider: IServiceProvider

Odkaz na IServiceProvider.

Návraty

IVsTask

Úloha představující, že byla spuštěna operace otevření. Výsledkem úlohy je odkaz na IVsAsyncOpenDocumentResult, pokud byl dokument otevřen v prostředí. V opačném případě null.

Poznámky

Úloha vrácená touto metodou neindikuje, že byly načteny zobrazení dokumentu a docdata. Další podrobnosti najdete DocumentLoadTask v tématu .

Tato metoda používá výsledek k CreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr, IntPtr, String, Guid, Int32) určení, zda má pokračovat ve smyčce do dalšího editoru v seznamu najít podporovaný objekt pro editor. Konkrétně by měl vrátit jednu z následujících hodnot: 1. S_OK k označení, že by se měla zastavit smyčka, pokud editor podporuje soubor a byl úspěšně inicializován 2. "VS_E_UNSUPPORTEDFORMAT" k označení, že by měl pokračovat ve smyčce, pokud editor nepodporuje poskytnutá data dokumentace 3. Jakýkoli jiný kód chyby, který indikuje, že by se měla ukončit smyčka.

Platí pro

Sdílet prostřednictvím