EditorFactory.CreateEditorInstance Méthode

Référence

Définition

Espace de noms:: Microsoft.VisualStudio.Package

Assembly:: Microsoft.VisualStudio.Package.LanguageService.14.0.dll

Assembly:: Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Paquet:: Microsoft.VisualStudio.Package.LanguageService.15.0 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.

Cette méthode vérifie si le fichier spécifié est pris en charge par votre éditeur et, le cas échéant, crée l’éditeur de texte principal et y associe votre service de langue. Pour déterminer si le fichier est pris en charge par votre éditeur, effectuez les case activée suivantes :

Si tout cela est vrai, l’étape suivante consiste à obtenir une mémoire tampon IVsTextLines et à la configurer comme suit :

Enfin, elle appelle CreateEditorView pour créer le docView.

public:
 virtual int CreateEditorInstance(System::UInt32 createDocFlags, System::String ^ moniker, System::String ^ physicalView, Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ pHier, System::UInt32 itemid, IntPtr existingDocData, [Runtime::InteropServices::Out] IntPtr % docView, [Runtime::InteropServices::Out] IntPtr % docData, [Runtime::InteropServices::Out] System::String ^ % editorCaption, [Runtime::InteropServices::Out] Guid % cmdUI, [Runtime::InteropServices::Out] int % cancelled);

public virtual int CreateEditorInstance (uint createDocFlags, string moniker, string physicalView, Microsoft.VisualStudio.Shell.Interop.IVsHierarchy pHier, uint itemid, IntPtr existingDocData, out IntPtr docView, out IntPtr docData, out string editorCaption, out Guid cmdUI, out int cancelled);

abstract member CreateEditorInstance : uint32 * string * string * Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * uint32 * nativeint * nativeint * nativeint * string * Guid * int -> int
override this.CreateEditorInstance : uint32 * string * string * Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * uint32 * nativeint * nativeint * nativeint * string * Guid * int -> int

Public Overridable Function CreateEditorInstance (createDocFlags As UInteger, moniker As String, physicalView As String, pHier As IVsHierarchy, itemid As UInteger, existingDocData As IntPtr, ByRef docView As IntPtr, ByRef docData As IntPtr, ByRef editorCaption As String, ByRef cmdUI As Guid, ByRef cancelled As Integer) As Integer

Paramètres

createDocFlags: UInt32

Indicateurs définissant les conditions pour créer l'éditeur principal.

moniker: String

Format de chaîne de l'identificateur de moniker du document dans le système de projet. Dans le cas où les documents sont des fichiers, il s'agit toujours du chemin d'accès au fichier. Ce paramètre peut également être utilisé pour spécifier les documents qui ne sont pas des fichiers. Par exemple, dans un projet de base de données, ce paramètre peut contenir une chaîne qui fait référence à des enregistrements dans une table.

physicalView: String

Nom de la vue physique.

pHier: IVsHierarchy

Objet IVsHierarchy.

itemid: UInt32

Identificateur d'élément de la principale instance de l'éditeur.

existingDocData: IntPtr
nativeint

Doit être l'objet docData inscrit dans la table de documents en cours d'exécution (RDT). Ce paramètre est utilisé pour déterminer si une mémoire tampon de document (objet Document Data) a déjà été créée. Lorsqu'une fabrique d'éditeur doit créer une vue secondaire, la valeur de ce paramètre est non NULL, indiquant qu'il n'existe aucune mémoire tampon de document.

docView: IntPtr
nativeint

Objet de vue du document. Retourne NULL si un éditeur externe existe, sinon retourne la vue du document.

docData: IntPtr
nativeint

Objet de données du document. Retourne la mémoire tampon du document.

editorCaption: String

Légende initiale définie par l'éditeur de document pour la fenêtre de document. Il s'agit généralement d'une chaîne placée entre crochets (par exemple, « [Formulaire] »). Cette valeur est passée en tant que paramètre d'entrée à la méthode CreateDocumentWindow(UInt32, String, IVsUIHierarchy, UInt32, IntPtr, IntPtr, Guid, String, Guid, IServiceProvider, String, String, Int32[], IVsWindowFrame). Si le fichier est en lecture seule, la légende est définie pendant le chargement du fichier.

cmdUI: Guid

Retourne le GUID d'interface utilisateur de commande. Le GUID est actif lorsque cet éditeur est activé. Un élément d'interface utilisateur qui est visible dans l'éditeur doit utiliser ce GUID. Le GUID est utilisé dans le fichier .ctc dans la DLL satellite où il indique quels menus et quelles barres d'outils doivent être affichées lorsque le document est actif.

cancelled: Int32

Énumération de type __VSEDITORCREATEDOCWIN. Ces indicateurs sont passées à la méthode CreateDocumentWindow(UInt32, String, IVsUIHierarchy, UInt32, IntPtr, IntPtr, Guid, String, Guid, IServiceProvider, String, String, Int32[], IVsWindowFrame). Cette valeur est définie sur 0 dans l'implémentation EditorFactory.

Retours

Int32

Si la méthode réussit, retourne S_OK. En cas d'échec, retourne un code d'erreur.

Implémente

CreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr, IntPtr, String, Guid, Int32)

Remarques

Pour obtenir un exemple d’utilisation de cette méthode, consultez Procédure pas à pas : création d’un éditeur principal et inscription d’un type de fichier d’éditeur.

S’applique à

Partager via