IVsAsyncShellOpenDocument.OpenStandardEditorAsync Methode

Referenz

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Interop.dll

Paket:: Microsoft.VisualStudio.Interop v17.9.37000

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Öffnet eine Datei mit dem Standard-Editor. Zunächst wird ermittelt, ob bereits eine Standard-Editor-Factory für die Datei konfiguriert ist. Wenn ein Standardwert noch nicht konfiguriert ist, durchläuft er eine prioritär sortierte Liste von Editorfabriken, um die erste zu finden, die das Dokument unterstützt. Eine Ausnahme wird ausgelöst, wenn das Dokument nicht geöffnet werden kann.

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

Parameter

openStandardEditorFlags: UInt32

Flags, deren Werte aus der __VSOSEFLAGS Enumeration oder __VSOSEFLAGS2 übernommen werden.

documentMoniker: String

Zeichenfolgenform des eindeutigen Monikerbezeichners des Dokuments im Projektsystem, z. B. der vollständige Pfad zur Datei. Handelt es sich nicht um Dateien, ist dieser Bezeichner oft in Form einer URL angegeben.

logicalView: Guid

Eine Guid , die die logische Ansicht identifiziert. Die Standardansicht ist VSConstants.LOGVIEWID_Primary , und jeder Editor muss diese Ansicht unterstützen.

Wenn der Editor für das Dokumentansichtsobjekt IVsMultiViewDocumentView implementiert, dann der an übergebene Wert, der bestimmt ActivateLogicalView(Guid), welche Ansicht aktiviert wird, wenn das Editorfenster angezeigt wird.

Durch Angeben der logischen Ansicht Guidkönnen Sie die spezifische Ansicht anfordern, die dem Grund entspricht, aus dem Sie die Ansicht anfordern. Geben Sie beispielsweise VSConstants.LOGVIEWID_Debugging an, um die entsprechende Ansicht für das Debuggen zu erhalten, oder geben Sie VSConstants.LOGVIEWID_TextView, um die entsprechende Ansicht für den Text-Editor zu erhalten (das heißt, eine Ansicht, die IVsCodeWindow implementiert).

ownerCaption: String

Anfängliche Untertitel vom Dokumentbesitzer (d. h. dem Projekt) für das Dokumentfenster definiert. Diese hat häufig das folgende Format: "Projektname – Elementname".

hierarchy: IVsUIHierarchy

Ein Verweis auf den, der IVsUIHierarchy das Dokument besitzt.

itemId: UInt32

Der Elementbezeichner der Benutzeroberflächenhierarchie des Standard-Editors. Weitere Informationen finden Sie unter VSConstants.VSITEMID.

shouldGetDocDataFromRdt: Boolean

Wenn true, verwendet die Umgebung das doc-Datenobjekt, das aus der Tabelle "Laufendes Dokument" abgerufen wurde. Andernfalls öffnet der Dienst das Dokument mithilfe der an docDataübergebenen Dokumentdaten.

docData: Object

Ein Verweis auf das Dokumentdatenobjekt des zu öffnenden Elements oder null. Dieser an diesen Parameter übergebene Wert wird ignoriert, wenn shouldGetDocDataFromRdttrueist.

serviceProvider: IServiceProvider

Ein Verweis auf IServiceProvider.

Gibt zurück

IVsTask

Eine Aufgabe, die darstellt, dass der geöffnete Vorgang gestartet wurde. Das Ergebnis der Aufgabe ist ein Verweis auf , IVsAsyncOpenDocumentResultwenn das Dokument in der Umgebung geöffnet wurde, nullandernfalls .

Hinweise

Die von dieser Methode zurückgegebene Aufgabe gibt nicht an, dass die Ansicht und die Docdata des Dokuments geladen wurden. Weitere Informationen finden Sie unter DocumentLoadTask.

Diese Methode verwendet das Ergebnis von CreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr, IntPtr, String, Guid, Int32) , um zu bestimmen, ob die Schleife zum nächsten Editor in der Liste fortgesetzt werden soll, um eine unterstützte Editorfactory zu finden. Insbesondere sollte eine der folgenden zurückgegeben werden: 1. S_OK , um anzugeben, dass die Schleife beendet werden soll, wenn der Editor die Datei unterstützt und erfolgreich initialisiert wurde 2. "VS_E_UNSUPPORTEDFORMAT" , um anzugeben, dass die Schleife fortgesetzt werden soll, wenn der Editor die bereitgestellten Dokumentdaten nicht unterstützt 3. Jeder andere Fehlercode, der angibt, dass die Schleife beendet werden soll.

Gilt für: