IVsAsyncShellOpenDocument.OpenStandardEditorAsync Méthode

Référence

Définition

Espace de noms:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Interop.dll

Paquet:: Microsoft.VisualStudio.Interop v17.9.37000

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Ouvre un fichier à l’aide de l’éditeur standard. Il détermine d’abord si une fabrique d’éditeur par défaut pour le fichier est déjà configurée. Si une valeur par défaut n’est pas encore configurée, elle effectue une boucle dans une liste triée par priorité de fabriques d’éditeurs pour rechercher la première qui prend en charge le document. Une exception est levée si le document ne peut pas être ouvert.

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

Paramètres

openStandardEditorFlags: UInt32

Indicateurs dont les valeurs sont extraites de l’énumération __VSOSEFLAGS ou __VSOSEFLAGS2 .

documentMoniker: String

Forme de chaîne de l’identificateur de moniker unique du document dans le système de projet, par exemple, le chemin d’accès complet au fichier. En cas d'absence de fichier, cet identificateur se présente souvent sous la forme d'une URL.

logicalView: Guid

Identifiant Guid la vue logique. La vue par défaut est VSConstants.LOGVIEWID_Primary et chaque éditeur doit prendre en charge cette vue.

Si l’éditeur implémente IVsMultiViewDocumentView sur l’objet d’affichage de document, la valeur passée à ActivateLogicalView(Guid), qui détermine quelle vue est activée lorsque la fenêtre de l’éditeur s’affiche.

En spécifiant la vue Guidlogique , vous pouvez demander la vue spécifique qui correspond à la raison pour laquelle vous demandez la vue. Par exemple, spécifiez VSConstants.LOGVIEWID_Debugging pour obtenir la vue appropriée pour déboguer, ou VSConstants.LOGVIEWID_TextView pour obtenir la vue appropriée pour l'éditeur de texte (autrement dit, une vue qui implémente IVsCodeWindow).

ownerCaption: String

La légende initiale définie par le propriétaire du document (c’est-à-dire le projet) pour la fenêtre de document. Il s'agit souvent du format : « NomProjet – ItemName ».

hierarchy: IVsUIHierarchy

Référence à qui IVsUIHierarchy appartient le document.

itemId: UInt32

Identificateur d’élément de hiérarchie de l’interface utilisateur de l’éditeur standard. Pour plus d'informations, consultez VSConstants.VSITEMID.

shouldGetDocDataFromRdt: Boolean

Si true, l’environnement utilise l’objet de données doc obtenu à partir de la table de document en cours d’exécution ; sinon, le service ouvre le document à l’aide des données doc passées à docData.

docData: Object

Référence à l’objet de données de document de l’élément à ouvrir ou null. Cette valeur passée dans ce paramètre est ignorée si shouldGetDocDataFromRdt est true.

serviceProvider: IServiceProvider

Référence à IServiceProvider.

Retours

IVsTask

Tâche indiquant que l’opération d’ouverture a démarré. Le résultat de la tâche est une référence à un IVsAsyncOpenDocumentResult, si le document a été ouvert dans l’environnement ; sinon, null.

Remarques

La tâche retournée par cette méthode n’indique pas que la vue et les docdata du document ont été chargées. Consultez DocumentLoadTask pour plus d’informations.

Cette méthode utilise le résultat de CreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr, IntPtr, String, Guid, Int32) pour déterminer si elle doit continuer à boucler vers l’éditeur suivant de la liste pour rechercher une fabrique d’éditeur prise en charge. Plus précisément, il doit retourner l’un des éléments suivants : 1. S_OK pour indiquer qu’il doit cesser de boucler si l’éditeur prend en charge le fichier et a été initialisé avec succès 2. "VS_E_UNSUPPORTEDFORMAT" pour indiquer qu’il doit continuer à boucler si l’éditeur ne prend pas en charge les données de documentation fournies 3. Tout autre code d’erreur indiquant qu’il doit arrêter la boucle.

S’applique à

Partager via