IVsAsyncShellOpenDocument.OpenSpecificEditorAsync Méthode
Définition
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 de manière asynchrone un document à l’aide de l’éditeur spécifié.
public Microsoft.VisualStudio.Shell.Interop.IVsTask OpenSpecificEditorAsync (uint openSpecificEditorFlags, string documentMoniker, Guid editorType, string? physicalView, Guid logicalView, string? ownerCaption, Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy? hierarchy, uint itemId, bool shouldGetDocDataFromRdt, object? docData, Microsoft.VisualStudio.OLE.Interop.IServiceProvider serviceProvider);
abstract member OpenSpecificEditorAsync : uint32 * string * Guid * string * Guid * string * Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy * uint32 * bool * obj * Microsoft.VisualStudio.OLE.Interop.IServiceProvider -> Microsoft.VisualStudio.Shell.Interop.IVsTask
Public Function OpenSpecificEditorAsync (openSpecificEditorFlags As UInteger, documentMoniker As String, editorType As Guid, physicalView 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
- openSpecificEditorFlags
- UInt32
Indicateurs dont les valeurs sont extraites de l’énumération __VSOSPEFLAGS .
- 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.
- physicalView
- String
Nom de la vue physique ou null
.
Si null
, l'environnement appelle MapLogicalView(Guid, String)
sur la fabrique d'éditeur pour déterminer la vue physique qui correspond à la vue logique.
Dans ce cas, la valeur null
ne spécifie pas la vue principale, mais indique plutôt que vous ne pouvez pas déterminer la vue correspondant à la vue logique.
- 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
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.