IVsAsyncShellOpenDocument.OpenStandardEditorAsync Metodo
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Apre un file usando l'editor standard. Determina innanzitutto se è già configurata una factory dell'editor predefinita per il file. Se un valore predefinito non è già configurato, verrà eseguito il ciclo tramite un elenco di editor factory con priorità per trovare il primo che supporta il documento. Viene generata un'eccezione se il documento non può essere aperto.
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
Parametri
- openStandardEditorFlags
- UInt32
Flag i cui valori vengono presi dall'enumerazione __VSOSEFLAGS o __VSOSEFLAGS2 .
- documentMoniker
- String
Formato stringa dell'identificatore moniker univoco del documento nel sistema di progetto, ad esempio il percorso completo del file. In casi non di file, questo identificatore è spesso nel formato di URL.
- logicalView
- Guid
Oggetto Guid che identifica la vista logica. La visualizzazione predefinita è VSConstants.LOGVIEWID_Primary
e ogni editor deve supportare tale visualizzazione.
Se l'editor implementa IVsMultiViewDocumentView nell'oggetto visualizzazione documento, il valore passato a ActivateLogicalView(Guid), che determina quale visualizzazione viene attivata quando viene visualizzata la finestra dell'editor.
Specificando la visualizzazione Guidlogica, è possibile richiedere la visualizzazione specifica corrispondente al motivo per cui si richiede la visualizzazione.
Ad esempio, specificare VSConstants.LOGVIEWID_Debugging
per ottenere la visualizzazione appropriata per il debug o VSConstants.LOGVIEWID_TextView
per ottenere la visualizzazione appropriata per l'editor di testo (ovvero una visualizzazione che implementa IVsCodeWindow).
- ownerCaption
- String
La didascalia iniziale definita dal proprietario del documento , ovvero il progetto, per la finestra del documento. È spesso del form: "ProjectName – ItemName".
- hierarchy
- IVsUIHierarchy
Riferimento all'oggetto IVsUIHierarchy proprietario del documento.
- itemId
- UInt32
Identificatore dell'elemento della gerarchia dell'interfaccia utente dell'editor standard. Per ulteriori informazioni, vedere VSConstants.VSITEMID
.
- shouldGetDocDataFromRdt
- Boolean
Se , l'ambiente userà l'oggetto dati del documento ottenuto dalla tabella documento in esecuzione. In true
caso contrario, il servizio aprirà il documento usando i dati del documento passati a docData
.
- docData
- Object
Riferimento all'oggetto dati del documento dell'elemento da aprire o null
. Questo valore passato a questo parametro viene ignorato se shouldGetDocDataFromRdt
è true
.
- serviceProvider
- IServiceProvider
Riferimento a IServiceProvider.
Restituisce
Attività che rappresenta l'avvio dell'operazione aperta.
Il risultato dell'attività è un riferimento a , IVsAsyncOpenDocumentResultse il documento è stato aperto all'interno dell'ambiente; in caso contrario, null
.
Commenti
L'attività restituita da questo metodo non indica che la visualizzazione del documento e i documenti sono stati caricati. Per informazioni dettagliate, vedere DocumentLoadTask.
Questo metodo usa il risultato di CreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr, IntPtr, String, Guid, Int32) per determinare se deve continuare a eseguire il ciclo all'editor successivo nell'elenco per trovare una factory di editor supportata. In particolare, deve restituire uno dei seguenti elementi: 1. S_OK
per indicare che deve interrompere il ciclo se l'editor supporta il file ed è stato inizializzato correttamente 2. "VS_E_UNSUPPORTEDFORMAT"
per indicare che deve continuare a eseguire il ciclo se l'editor non supporta i dati del documento forniti 3. Qualsiasi altro codice di errore per indicare che deve interrompere il ciclo.