IVsAsyncShellOpenDocument.OpenStandardEditorAsync Metoda

Odwołanie

Definicja

Przestrzeń nazw:: Microsoft.VisualStudio.Shell.Interop

Zestaw:: Microsoft.VisualStudio.Interop.dll

Pakiet:: Microsoft.VisualStudio.Interop v17.9.37000

Ważne

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Otwiera plik przy użyciu edytora standardowego. Najpierw określi, czy domyślna fabryka edytora dla pliku jest już skonfigurowana. Jeśli wartość domyślna nie została jeszcze skonfigurowana, będzie ona pętli przez posortowaną priorytetowo listę fabryk edytorów, aby znaleźć pierwszą, która obsługuje dokument. Wyjątek jest zgłaszany, jeśli nie można otworzyć dokumentu.

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

Flagi, których wartości są pobierane z __VSOSEFLAGS wyliczenia lub __VSOSEFLAGS2 .

documentMoniker: String

Forma ciągu unikatowego identyfikatora moniker dokumentu w systemie projektu, na przykład pełna ścieżka do pliku. W przypadkach innych niż pliki ten identyfikator jest często w postaci adresu URL.

logicalView: Guid

Identyfikowanie Guid widoku logicznego. Widok domyślny to VSConstants.LOGVIEWID_Primary i każdy edytor musi obsługiwać ten widok.

Jeśli edytor implementuje IVsMultiViewDocumentView obiekt widoku dokumentu, wartość przekazana do ActivateLogicalView(Guid)elementu określa, który widok jest aktywowany po wyświetleniu okna edytora.

Określając widok Guidlogiczny, możesz zażądać określonego widoku zgodnego z przyczyną, dla której żądasz widoku. Na przykład określ VSConstants.LOGVIEWID_Debugging , aby uzyskać widok odpowiedni do debugowania lub VSConstants.LOGVIEWID_TextView uzyskać widok odpowiedni dla edytora tekstów (czyli widok implementujący IVsCodeWindow).

ownerCaption: String

Początkowe podpis zdefiniowane przez właściciela dokumentu (czyli projektu) dla okna dokumentu. Jest to często postać: "ProjectName — ItemName".

hierarchy: IVsUIHierarchy

Odwołanie do IVsUIHierarchy dokumentu będącego właścicielem dokumentu.

itemId: UInt32

Identyfikator elementu hierarchii interfejsu użytkownika edytora standardowego. Aby uzyskać więcej informacji, zobacz VSConstants.VSITEMID.

shouldGetDocDataFromRdt: Boolean

Jeśli trueprogram , środowisko będzie używać obiektu danych dokumentu uzyskanego z uruchomionej tabeli dokumentów. W przeciwnym razie usługa otworzy dokument przy użyciu danych dokumentu przekazanych do docData.

docData: Object

Odwołanie do obiektu danych dokumentu elementu do otwarcia lub null. Ta wartość przekazana do tego parametru jest ignorowana, jeśli shouldGetDocDataFromRdt jest to true.

serviceProvider: IServiceProvider

Odwołanie do .IServiceProvider

Zwraca

IVsTask

Zadanie reprezentujące, że rozpoczęto operację otwierania. Wynikiem zadania jest odwołanie do elementu IVsAsyncOpenDocumentResult, jeśli dokument został otwarty w środowisku; w przeciwnym razie null.

Uwagi

Zadanie zwrócone przez tę metodę nie wskazuje, że widok dokumentu i dane docdata zostały załadowane. Aby uzyskać więcej informacji, zobacz DocumentLoadTask .

Ta metoda używa wyniku CreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr, IntPtr, String, Guid, Int32) , aby określić, czy powinna kontynuować pętlę do następnego edytora na liście, aby znaleźć obsługiwaną fabrykę edytorów. W szczególności powinna zwrócić jedną z następujących wartości: 1. S_OK aby wskazać, że powinien zatrzymać pętlę, jeśli edytor obsługuje plik i został pomyślnie zainicjowany 2. "VS_E_UNSUPPORTEDFORMAT" aby wskazać, że powinna kontynuować pętlę, jeśli edytor nie obsługuje podanych danych dokumentu 3. Każdy inny kod błędu wskazujący, że powinien zatrzymać pętlę.

Dotyczy

Udostępnij za pośrednictwem