Procédure pas à pas : Extraits de code implémentationWalkthrough: Implement code snippets

Vous pouvez créer des extraits de code et incluez-les dans une extension de l’éditeur, afin que les utilisateurs de l’extension de les ajouter à leur propre code.You can create code snippets and include them in an editor extension so that users of the extension can add them to their own code.

Un extrait de code est un fragment de code ou autre texte qui peut être incorporé dans un fichier.A code snippet is a fragment of code or other text that can be incorporated in a file. Pour afficher tous les extraits de code qui ont été inscrits pour les langages de programmation particuliers, sur le outils menu, cliquez sur Gestionnaire des extraits de Code.To view all snippets that have been registered for particular programming languages, on the Tools menu, click Code Snippet Manager. Pour insérer un extrait de code dans un fichier, avec le bouton droit où vous souhaitez que l’extrait de code, cliquez sur Insérer un extrait, ou entourer, recherchez l’extrait de code, puis double-cliquez dessus.To insert a snippet in a file, right-click where you want the snippet, click Insert Snippet, or Surround With, locate the snippet you want, and then double-click it. Appuyez sur onglet ou MAJ+onglet pour modifier les parties pertinentes de l’extrait de code, puis appuyez sur entrée ou ÉCHAP pour l’accepter.Press Tab or Shift+Tab to modify the relevant parts of the snippet and then press Enter or Esc to accept it. Pour plus d’informations, consultez extraits de Code.For more information, see Code snippets.

Un extrait de code est contenu dans un fichier XML qui a l’extension de nom de fichier .snippet *.A code snippet is contained in an XML file that has the .snippet* file name extension. Un extrait de code peut contenir des champs qui sont mis en surbrillance après avoir inséré l’extrait de code afin que l’utilisateur peut rechercher et les modifier.A snippet can contain fields that are highlighted after the snippet is inserted so that the user can find and change them. Un fichier d’extrait de code fournit également des informations pour le Gestionnaire des extraits de Code pour qu’il puisse afficher le nom de l’extrait de code dans la catégorie appropriée.A snippet file also provides information for the Code Snippet Manager so that it can display the snippet name in the correct category. Pour plus d’informations sur le schéma d’extrait de code, consultez référence de schéma des extraits de Code.For information about the snippet schema, see Code snippets schema reference.

Cette procédure pas à pas explique comment accomplir ces tâches :This walkthrough teaches how to accomplish these tasks:

  1. Créez et inscrivez les extraits de code pour une langue spécifique.Create and register code snippets for a specific language.

  2. Ajouter le insérer un extrait commande à un menu contextuel.Add the Insert Snippet command to a shortcut menu.

  3. Implémenter l’expansion d’extrait de code.Implement snippet expansion.

    Cette procédure pas à pas est basée sur procédure pas à pas : affichage de saisie semi-automatique des instructions.This walkthrough is based on Walkthrough: Display statement completion.

PrérequisPrerequisites

À partir de Visual Studio 2015, vous n’installez pas le Kit de développement logiciel Visual Studio à partir du centre de téléchargement.Starting in Visual Studio 2015, you don't install the Visual Studio SDK from the download center. Il est inclus comme fonctionnalité facultative dans le programme d’installation de Visual Studio.It's included as an optional feature in Visual Studio setup. Vous pouvez également installer le kit SDK VS par la suite.You can also install the VS SDK later on. Pour plus d’informations, consultez installer le SDK Visual Studio.For more information, see Install the Visual Studio SDK.

Créer et inscrire des extraits de codeCreate and register code snippets

En règle générale, les extraits de code sont associés à un service de langage enregistrés.Typically, code snippets are associated with a registered language service. Toutefois, vous n’avez pas à implémenter un LanguageService pour inscrire des extraits de code.However, you do not have to implement a LanguageService to register code snippets. Au lieu de cela, spécifiez simplement un GUID dans le fichier d’index extrait et ensuite utiliser le même GUID dans le ProvideLanguageCodeExpansionAttribute que vous ajoutez à votre projet.Instead, just specify a GUID in the snippet index file and then use the same GUID in the ProvideLanguageCodeExpansionAttribute that you add to your project.

Les étapes suivantes montrent comment créer des extraits de code et les associer à un GUID spécifique.The following steps demonstrate how to create code snippets and associate them with a specific GUID.

  1. Créez la structure de répertoire suivante :Create the following directory structure:

    %INSTALLDIR%\TestSnippets\Snippets\1033\%InstallDir%\TestSnippets\Snippets\1033\

    % INSTALLDIR% est le dossier d’installation de Visual Studio.where %InstallDir% is the Visual Studio installation folder. (Bien que ce chemin d’accès est généralement utilisé pour installer des extraits de code, vous pouvez spécifier n’importe quel chemin d’accès.)(Although this path is typically used to install code snippets, you can specify any path.)

  2. Dans le dossier \1033, créez un .xml de fichier et nommez-le TestSnippets.xml.In the \1033\ folder, create an .xml file and name it TestSnippets.xml. (Bien que ce nom est généralement utilisé pour un fichier d’index extrait de code, vous pouvez spécifier n’importe quel nom tant qu’il a un .xml extension de nom de fichier.) Ajoutez le texte suivant, puis supprimer l’espace réservé GUID et d’ajouter vos propres.(Although this name is typically used for a snippet index file, you can specify any name as long as it has an .xml file name extension.) Add the following text, and then delete the placeholder GUID and add your own.

    <?xml version="1.0" encoding="utf-8" ?>  
    <SnippetCollection>  
        <Language Lang="TestSnippets" Guid="{00000000-0000-0000-0000-000000000000}">  
            <SnippetDir>  
                <OnOff>On</OnOff>  
                <Installed>true</Installed>  
                <Locale>1033</Locale>  
                <DirPath>%InstallRoot%\TestSnippets\Snippets\%LCID%\</DirPath>  
                <LocalizedName>Snippets</LocalizedName>  
            </SnippetDir>  
        </Language>  
    </SnippetCollection>  
    
  3. Créez un fichier dans le dossier d’extrait de code, nommez-le tester.snippet, puis ajoutez le texte suivant :Create a file in the snippet folder, name it test.snippet, and then add the following text:

    <?xml version="1.0" encoding="utf-8" ?>  
    <CodeSnippets  xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">  
        <CodeSnippet Format="1.0.0">  
            <Header>  
                <Title>Test replacement fields</Title>  
                <Shortcut>test</Shortcut>  
                <Description>Code snippet for testing replacement fields</Description>  
                <Author>MSIT</Author>  
                <SnippetTypes>  
                    <SnippetType>Expansion</SnippetType>  
                </SnippetTypes>  
            </Header>  
            <Snippet>  
                <Declarations>  
                    <Literal>  
                      <ID>param1</ID>  
                        <ToolTip>First field</ToolTip>  
                        <Default>first</Default>  
                    </Literal>  
                    <Literal>  
                        <ID>param2</ID>  
                        <ToolTip>Second field</ToolTip>  
                        <Default>second</Default>  
                    </Literal>  
                </Declarations>  
                <References>  
                   <Reference>  
                       <Assembly>System.Windows.Forms.dll</Assembly>  
                   </Reference>  
                </References>  
                <Code Language="TestSnippets">  
                    <![CDATA[MessageBox.Show("$param1$");  
         MessageBox.Show("$param2$");]]>  
                </Code>    
            </Snippet>  
        </CodeSnippet>  
    </CodeSnippets>  
    

    Les étapes suivantes montrent comment inscrire les extraits de code.The following steps show how to register the code snippets.

Pour inscrire des extraits de code pour un GUID spécifiqueTo register code snippets for a specific GUID

  1. Ouvrez le CompletionTest projet.Open the CompletionTest project. Pour plus d’informations sur la création de ce projet, consultez procédure pas à pas : affichage de saisie semi-automatique des instructions.For information about how to create this project, see Walkthrough: Display statement completion.

  2. Dans le projet, ajoutez des références aux assemblys suivants :In the project, add references to the following assemblies:

    • Microsoft.VisualStudio.TextManager.InteropMicrosoft.VisualStudio.TextManager.Interop

    • Microsoft.VisualStudio.TextManager.Interop.8.0Microsoft.VisualStudio.TextManager.Interop.8.0

    • Microsoft.MSXMLmicrosoft.msxml

  3. Dans le projet, ouvrez le source.extension.vsixmanifest fichier.In the project, open the source.extension.vsixmanifest file.

  4. Assurez-vous que le actifs onglet contient un VsPackage contenu type et qui projet est définie sur le nom du projet.Make sure that the Assets tab contains a VsPackage content type and that Project is set to the name of the project.

  5. Sélectionnez le projet CompletionTest et dans la fenêtre Propriétés, définissez générer le fichier Pkgdef à true.Select the CompletionTest project and in the Properties window set Generate Pkgdef File to true. Enregistrez le projet.Save the project.

  6. Ajouter un mappage statique SnippetUtilities classe au projet.Add a static SnippetUtilities class to the project.

    static class SnippetUtilities
    
    Module SnippetUtilities
    
  7. Dans la classe SnippetUtilities, définir un GUID et attribuez-lui la valeur que vous avez utilisé dans le SnippetsIndex.xml fichier.In the SnippetUtilities class, define a GUID and give it the value that you used in the SnippetsIndex.xml file.

    internal const string LanguageServiceGuidStr = "00000000-0000-0000-0000-00000000";
    
    Friend Const LanguageServiceGuidStr As String = "00000000-0000-0000-0000-00000000"
    
  8. Ajouter le ProvideLanguageCodeExpansionAttribute à la TestCompletionHandler classe.Add the ProvideLanguageCodeExpansionAttribute to the TestCompletionHandler class. Cet attribut peut être ajouté à n’importe quelle classe (non statique) public ou interne dans le projet.This attribute can be added to any public or internal (non-static) class in the project. (Vous devrez peut-être ajouter un using instruction pour l’espace de noms Microsoft.VisualStudio.Shell.)(You may have to add a using statement for the Microsoft.VisualStudio.Shell namespace.)

    [ProvideLanguageCodeExpansion(
    SnippetUtilities.LanguageServiceGuidStr,
    "TestSnippets", //the language name
    0,              //the resource id of the language
    "TestSnippets", //the language ID used in the .snippet files
    @"%InstallRoot%\TestSnippets\Snippets\%LCID%\TestSnippets.xml",
        //the path of the index file
    SearchPaths = @"%InstallRoot%\TestSnippets\Snippets\%LCID%\",
    ForceCreateDirs = @"%InstallRoot%\TestSnippets\Snippets\%LCID%\")]
    internal class TestCompletionCommandHandler : IOleCommandTarget
    
    <ProvideLanguageCodeExpansion(
    SnippetUtilities.LanguageServiceGuidStr,
    "TestSnippets",
    0,
    "TestSnippets",
    "%InstallRoot%\TestSnippets\Snippets\%LCID%\SnippetsIndex.xml",
    SearchPaths:="%InstallRoot%\TestSnippets\Snippets\%LCID%\",
    ForceCreateDirs:="%InstallRoot%\TestSnippets\Snippets\%LCID%\")>
    Friend Class TestCompletionCommandHandler
        Implements IOleCommandTarget
    
  9. Générez et exécutez le projet.Build and run the project. Dans l’instance expérimentale de Visual Studio qui démarre lorsque le projet est exécuté, l’extrait de code que vous venez d’inscrire doit être affiché dans le Gestionnaire des extraits de Code sous le TestSnippets langage.In the experimental instance of Visual Studio that starts when the project is run, the snippet you just registered should be displayed in the Code Snippets Manager under the TestSnippets language.

Ajoutez la commande Insérer un extrait au menu contextuelAdd the Insert Snippet command to the shortcut menu

Le insérer un extrait commande n’est pas incluse dans le menu contextuel pour un fichier texte.The Insert Snippet command is not included on the shortcut menu for a text file. Par conséquent, vous devez activer la commande.Therefore, you must enable the command.

Pour ajouter la commande Insérer un extrait au menu contextuelTo add the Insert Snippet command to the shortcut menu

  1. Ouvrez le TestCompletionCommandHandler fichier de classe.Open the TestCompletionCommandHandler class file.

    Étant donné que cette classe implémente IOleCommandTarget, vous pouvez activer le insérer un extrait commande dans le QueryStatus (méthode).Because this class implements IOleCommandTarget, you can activate the Insert Snippet command in the QueryStatus method. Avant d’activer la commande, vérifiez que cette méthode n'est pas appelée à l’intérieur d’une fonction d’automatisation, car lorsque la insérer un extrait commande est activée, il affiche l’interface utilisateur du sélecteur extrait de code (IU).Before you enable the command, check that this method is not being called inside an automation function because when the Insert Snippet command is clicked, it displays the snippet picker user interface (UI).

    public int QueryStatus(ref Guid pguidCmdGroup, uint cCmds, OLECMD[] prgCmds, IntPtr pCmdText)
    {
        if (!VsShellUtilities.IsInAutomationFunction(m_provider.ServiceProvider))
        {
            if (pguidCmdGroup == VSConstants.VSStd2K && cCmds > 0)
            {
                // make the Insert Snippet command appear on the context menu 
                if ((uint)prgCmds[0].cmdID == (uint)VSConstants.VSStd2KCmdID.INSERTSNIPPET)
                {
                    prgCmds[0].cmdf = (int)Constants.MSOCMDF_ENABLED | (int)Constants.MSOCMDF_SUPPORTED;
                    return VSConstants.S_OK;
                }
            }
        }
    
        return m_nextCommandHandler.QueryStatus(ref pguidCmdGroup, cCmds, prgCmds, pCmdText);
    }
    
    Public Function QueryStatus(ByRef pguidCmdGroup As Guid, ByVal cCmds As UInteger, ByVal prgCmds As OLECMD(), ByVal pCmdText As IntPtr) As Integer Implements IOleCommandTarget.QueryStatus
        If Not VsShellUtilities.IsInAutomationFunction(m_provider.ServiceProvider) Then
            If pguidCmdGroup = VSConstants.VSStd2K AndAlso cCmds > 0 Then
                ' make the Insert Snippet command appear on the context menu 
                If CUInt(prgCmds(0).cmdID) = CUInt(VSConstants.VSStd2KCmdID.INSERTSNIPPET) Then
                    prgCmds(0).cmdf = CInt(Constants.MSOCMDF_ENABLED) Or CInt(Constants.MSOCMDF_SUPPORTED)
                    Return VSConstants.S_OK
                End If
            End If
        End If
    
        Return m_nextCommandHandler.QueryStatus(pguidCmdGroup, cCmds, prgCmds, pCmdText)
    End Function
    
  2. Générez et exécutez le projet.Build and run the project. Dans l’instance expérimentale, ouvrez un fichier qui a le .zzz extension de nom de fichier et ensuite avec le bouton droit n’importe où dans celui-ci.In the experimental instance, open a file that has the .zzz file name extension and then right-click anywhere in it. Le insérer un extrait commande doit apparaître dans le menu contextuel.The Insert Snippet command should appear on the shortcut menu.

Implémenter l’expansion d’extrait de code dans l’interface utilisateur de sélecteur d’extrait de codeImplement snippet expansion in the Snippet Picker UI

Cette section montre comment implémenter l’expansion d’extrait de code afin que le sélecteur d’extraits de l’interface utilisateur est affiché lorsque insérer un extrait un clic sur le menu contextuel.This section shows how to implement code snippet expansion so that the snippet picker UI is displayed when Insert Snippet is clicked on the shortcut menu. Un extrait de code est également développé lorsqu’un utilisateur tape le raccourci d’extrait de code, puis appuie sur onglet.A code snippet is also expanded when a user types the code-snippet shortcut and then presses Tab.

Pour afficher le sélecteur d’extraits de l’interface utilisateur et pour activer la navigation et l’acceptation de l’extrait de code après insertion, utilisez la Exec (méthode).To display the snippet picker UI and to enable navigation and post-insertion snippet acceptance, use the Exec method. L’insertion proprement dite est gérée par le OnItemChosen (méthode).The insertion itself is handled by the OnItemChosen method.

L’implémentation de l’expansion d’extrait de code utilise hérité Microsoft.VisualStudio.TextManager.Interop interfaces.The implementation of code snippet expansion uses legacy Microsoft.VisualStudio.TextManager.Interop interfaces. Lorsque vous traduisez des classes de l’éditeur actuel pour le code hérité, n’oubliez pas que les interfaces héritées utilisent une combinaison de numéros de ligne et de colonne pour spécifier les emplacements dans une mémoire tampon de texte, mais les classes actuels utilisent un seul index.When you translate from the current editor classes to the legacy code, remember that the legacy interfaces use a combination of line numbers and column numbers to specify locations in a text buffer, but the current classes use one index. Par conséquent, si une mémoire tampon a trois lignes chacun d’eux comporte 10 caractères (plus un saut de ligne est comptabilisé comme un caractère), le quatrième caractère sur la troisième ligne est à la position 27 dans l’implémentation actuelle, mais il est à la ligne 2, vous pouvez positionner 3 dans l’ancienne implémentation.Therefore, if a buffer has three lines each of which has 10 characters (plus a newline, which counts as one character), the fourth character on the third line is at position 27 in the current implementation, but it is at line 2, position 3 in the old implementation.

Pour implémenter l’expansion d’extrait de codeTo implement snippet expansion

  1. Dans le fichier qui contient le TestCompletionCommandHandler de classe, ajoutez le code suivant using instructions.To the file that contains the TestCompletionCommandHandler class, add the following using statements.

    using Microsoft.VisualStudio.Text.Operations;
    using MSXML;
    using System.ComponentModel.Composition;
    
    Imports Microsoft.VisualStudio.Text.Operations
    Imports MSXML
    
  2. Rendre le TestCompletionCommandHandler implémentent la IVsExpansionClient interface.Make the TestCompletionCommandHandler class implement the IVsExpansionClient interface.

    internal class TestCompletionCommandHandler : IOleCommandTarget, IVsExpansionClient
    
    <ProvideLanguageCodeExpansion(
    SnippetUtilities.LanguageServiceGuidStr,
    "TestSnippets",
    0,
    "TestSnippets",
    "%InstallRoot%\TestSnippets\Snippets\%LCID%\SnippetsIndex.xml",
    SearchPaths:="%InstallRoot%\TestSnippets\Snippets\%LCID%\",
    ForceCreateDirs:="%InstallRoot%\TestSnippets\Snippets\%LCID%\")>
    Friend Class TestCompletionCommandHandler
        Implements IOleCommandTarget
        Implements IVsExpansionClient
    
  3. Dans le TestCompletionCommandHandlerProvider classe, importez le ITextStructureNavigatorSelectorService.In the TestCompletionCommandHandlerProvider class, import the ITextStructureNavigatorSelectorService.

    [Import]
    internal ITextStructureNavigatorSelectorService NavigatorService { get; set; }
    
    <Import()>
    Friend Property NavigatorService As ITextStructureNavigatorSelectorService
    
  4. Ajouter des champs privés pour les interfaces d’extension de code et le IVsTextView.Add some private fields for the code expansion interfaces and the IVsTextView.

    IVsTextView m_vsTextView;
    IVsExpansionManager m_exManager;
    IVsExpansionSession m_exSession;
    
    Dim m_vsTextView As IVsTextView
    Dim m_exManager As IVsExpansionManager
    Dim m_exSession As IVsExpansionSession
    
  5. Dans le constructeur de la TestCompletionCommandHandler de classe, définissez les champs suivants.In the constructor of the TestCompletionCommandHandler class, set the following fields.

    internal TestCompletionCommandHandler(IVsTextView textViewAdapter, ITextView textView, TestCompletionHandlerProvider provider)
    {
        this.m_textView = textView;
        m_vsTextView = textViewAdapter;
        m_provider = provider;
        //get the text manager from the service provider
        IVsTextManager2 textManager = (IVsTextManager2)m_provider.ServiceProvider.GetService(typeof(SVsTextManager));
        textManager.GetExpansionManager(out m_exManager);
        m_exSession = null;
    
        //add the command to the command chain
        textViewAdapter.AddCommandFilter(this, out m_nextCommandHandler);
    }
    
    Friend Sub New(ByVal textViewAdapter As IVsTextView, ByVal textView As ITextView, ByVal provider As TestCompletionHandlerProvider)
        Me.m_textView = textView
        Me.m_provider = provider
        Me.m_vsTextView = textViewAdapter
    
        Dim textManager As IVsTextManager2 = DirectCast(m_provider.ServiceProvider.GetService(GetType(SVsTextManager)), IVsTextManager2)
        textManager.GetExpansionManager(m_exManager)
        m_exSession = Nothing
    
        'add the command to the command chain
        textViewAdapter.AddCommandFilter(Me, m_nextCommandHandler)
    End Sub
    
  6. Pour afficher le sélecteur d’extrait de code lorsque l’utilisateur clique sur le insérer un extrait de commande, ajoutez le code suivant à la Exec (méthode).To display the snippet picker when the user clicks the Insert Snippet command, add the following code to the Exec method. (Pour rendre cette explication plus lisible, le Exec()code qui est utilisé pour la saisie semi-automatique des instructions n’est pas affichée ; au lieu de cela, les blocs de code sont ajoutés à la méthode existante.) Ajoutez le bloc de code suivant après le code qui vérifie un caractère.(To make this explanation more readable, the Exec()code that's used for statement completion is not shown; instead, blocks of code are added to the existing method.) Add the following block of code after the code that checks for a character.

    //code previously written for Exec
    if (pguidCmdGroup == VSConstants.VSStd2K && nCmdID == (uint)VSConstants.VSStd2KCmdID.TYPECHAR)
    {
        typedChar = (char)(ushort)Marshal.GetObjectForNativeVariant(pvaIn);
    }
    //the snippet picker code starts here
    if (nCmdID == (uint)VSConstants.VSStd2KCmdID.INSERTSNIPPET)
    {
        IVsTextManager2 textManager = (IVsTextManager2)m_provider.ServiceProvider.GetService(typeof(SVsTextManager));
    
        textManager.GetExpansionManager(out m_exManager);
    
        m_exManager.InvokeInsertionUI(
            m_vsTextView,
            this,      //the expansion client
            new Guid(SnippetUtilities.LanguageServiceGuidStr),
            null,       //use all snippet types
            0,          //number of types (0 for all)
            0,          //ignored if iCountTypes == 0
            null,       //use all snippet kinds
            0,          //use all snippet kinds
            0,          //ignored if iCountTypes == 0
            "TestSnippets", //the text to show in the prompt
            string.Empty);  //only the ENTER key causes insert 
    
        return VSConstants.S_OK;
    }
    
    'code previously written for Exec
    If pguidCmdGroup = VSConstants.VSStd2K AndAlso nCmdID = CUInt(VSConstants.VSStd2KCmdID.TYPECHAR) Then
        typedChar = ChrW(CUShort(Marshal.GetObjectForNativeVariant(pvaIn)))
    End If
    'the snippet picker code starts here
    If nCmdID = CUInt(VSConstants.VSStd2KCmdID.INSERTSNIPPET) Then
        Dim textManager As IVsTextManager2 = DirectCast(m_provider.ServiceProvider.GetService(GetType(SVsTextManager)), IVsTextManager2)
    
        textManager.GetExpansionManager(m_exManager)
        m_exManager.InvokeInsertionUI(
            m_vsTextView,
            Me,
            New Guid(SnippetUtilities.LanguageServiceGuidStr),
            Nothing,
            0,
            0,
            Nothing,
            0,
            0,
            "TestSnippets",
            String.Empty)
        Return VSConstants.S_OK
    End If
    
  7. Si un extrait de code comporte des champs qui peuvent être parcourues, la session d’expansion est maintenue ouverte jusqu'à ce que l’expansion est acceptée explicitement ; Si l’extrait de code ne comporte aucun champ, la session est fermée et qu’elle est retournée en tant que null par le InvokeInsertionUI (méthode).If a snippet has fields that can be navigated, the expansion session is kept open until the expansion is explicitly accepted; if the snippet has no fields, the session is closed and is returned as null by the InvokeInsertionUI method. Dans le Exec (méthode), après le sélecteur d’extraits de code d’interface utilisateur que vous avez ajouté à l’étape précédente, ajoutez le code suivant pour gérer la navigation de l’extrait de code (lorsque l’utilisateur appuie sur onglet ou MAJ + Onglet après l’insertion d’extraits).In the Exec method, after the snippet picker UI code that you added in the previous step, add the following code to handle snippet navigation (when the user presses Tab or Shift+Tab after snippet insertion).

    //the expansion insertion is handled in OnItemChosen
    //if the expansion session is still active, handle tab/backtab/return/cancel
    if (m_exSession != null)
    {
        if (nCmdID == (uint)VSConstants.VSStd2KCmdID.BACKTAB)
        {
            m_exSession.GoToPreviousExpansionField();
            return VSConstants.S_OK;
        }
        else if (nCmdID == (uint)VSConstants.VSStd2KCmdID.TAB)
        {
    
            m_exSession.GoToNextExpansionField(0); //false to support cycling through all the fields
            return VSConstants.S_OK;
        }
        else if (nCmdID == (uint)VSConstants.VSStd2KCmdID.RETURN || nCmdID == (uint)VSConstants.VSStd2KCmdID.CANCEL)
        {
            if (m_exSession.EndCurrentExpansion(0) == VSConstants.S_OK)
            {
                m_exSession = null;
                return VSConstants.S_OK;
            }
        }
    }
    
    'the expansion insertion is handled in OnItemChosen
    'if the expansion session is still active, handle tab/backtab/return/cancel
    If m_exSession IsNot Nothing Then
        If nCmdID = CUInt(VSConstants.VSStd2KCmdID.BACKTAB) Then
            m_exSession.GoToPreviousExpansionField()
            Return VSConstants.S_OK
        ElseIf nCmdID = CUInt(VSConstants.VSStd2KCmdID.TAB) Then
            m_exSession.GoToNextExpansionField(0)
            'false to support cycling through all the fields
            Return VSConstants.S_OK
        ElseIf nCmdID = CUInt(VSConstants.VSStd2KCmdID.[RETURN]) OrElse nCmdID = CUInt(VSConstants.VSStd2KCmdID.CANCEL) Then
            If m_exSession.EndCurrentExpansion(0) = VSConstants.S_OK Then
                m_exSession = Nothing
                Return VSConstants.S_OK
            End If
        End If
    End If
    
  8. Pour insérer l’extrait de code lorsque l’utilisateur tape le raccourci correspondant, puis appuie sur onglet, ajoutez le code pour le Exec (méthode).To insert the code snippet when the user types the corresponding shortcut and then presses Tab, add code to the Exec method. La méthode privée qui insère l’extrait de code s’affichera dans une étape ultérieure.The private method that inserts the snippet will be shown in a later step. Ajoutez le code suivant après le code de navigation que vous avez ajouté à l’étape précédente.Add the following code after the navigation code that you added in the previous step.

    //neither an expansion session nor a completion session is open, but we got a tab, so check whether the last word typed is a snippet shortcut 
    if (m_session == null && m_exSession == null && nCmdID == (uint)VSConstants.VSStd2KCmdID.TAB)
    {
        //get the word that was just added 
        CaretPosition pos = m_textView.Caret.Position;
        TextExtent word = m_provider.NavigatorService.GetTextStructureNavigator(m_textView.TextBuffer).GetExtentOfWord(pos.BufferPosition - 1); //use the position 1 space back
        string textString = word.Span.GetText(); //the word that was just added
        //if it is a code snippet, insert it, otherwise carry on
        if (InsertAnyExpansion(textString, null, null))
            return VSConstants.S_OK;
    }
    
    'neither an expansion session nor a completion session is open, but we got a tab, so check whether the last word typed is a snippet shortcut 
    If m_session Is Nothing AndAlso m_exSession Is Nothing AndAlso nCmdID = CUInt(VSConstants.VSStd2KCmdID.TAB) Then
        'get the word that was just added 
        Dim pos As CaretPosition = m_textView.Caret.Position
        Dim word As TextExtent = m_provider.NavigatorService.GetTextStructureNavigator(m_textView.TextBuffer).GetExtentOfWord(pos.BufferPosition - 1)
        Dim textString As String = word.Span.GetText()
        'if it is a code snippet, insert it, otherwise carry on
        If InsertAnyExpansion(textString, Nothing, Nothing) Then
            Return VSConstants.S_OK
        End If
    End If
    
  9. Implémenter les méthodes de la IVsExpansionClient interface.Implement the methods of the IVsExpansionClient interface. Dans cette implémentation, les seules méthodes dignes d’intérêt sont EndExpansion et OnItemChosen.In this implementation, the only methods of interest are EndExpansion and OnItemChosen. Les autres méthodes doivent simplement retourner S_OK.The other methods should just return S_OK.

    public int EndExpansion()
    {
        m_exSession = null;
        return VSConstants.S_OK;
    }
    
    public int FormatSpan(IVsTextLines pBuffer, TextSpan[] ts)
    {
        return VSConstants.S_OK;
    }
    
    public int GetExpansionFunction(IXMLDOMNode xmlFunctionNode, string bstrFieldName, out IVsExpansionFunction pFunc)
    {
        pFunc = null;
        return VSConstants.S_OK;
    }
    
    public int IsValidKind(IVsTextLines pBuffer, TextSpan[] ts, string bstrKind, out int pfIsValidKind)
    {
        pfIsValidKind = 1;
        return VSConstants.S_OK;
    }
    
    public int IsValidType(IVsTextLines pBuffer, TextSpan[] ts, string[] rgTypes, int iCountTypes, out int pfIsValidType)
    {
        pfIsValidType = 1;
        return VSConstants.S_OK;
    }
    
    public int OnAfterInsertion(IVsExpansionSession pSession)
    {
        return VSConstants.S_OK;
    }
    
    public int OnBeforeInsertion(IVsExpansionSession pSession)
    {
        return VSConstants.S_OK;
    }
    
    public int PositionCaretForEditing(IVsTextLines pBuffer, TextSpan[] ts)
    {
        return VSConstants.S_OK;
    }
    
    Public Function EndExpansion() As Integer Implements IVsExpansionClient.EndExpansion
        m_exSession = Nothing
        Return VSConstants.S_OK
    End Function
    
    Public Function FormatSpan(ByVal pBuffer As IVsTextLines, ByVal ts As TextSpan()) As Integer Implements IVsExpansionClient.FormatSpan
        Return VSConstants.S_OK
    End Function
    
    Public Function GetExpansionFunction(ByVal xmlFunctionNode As IXMLDOMNode, ByVal bstrFieldName As String, ByRef pFunc As IVsExpansionFunction) As Integer Implements IVsExpansionClient.GetExpansionFunction
        pFunc = Nothing
        Return VSConstants.S_OK
    End Function
    
    Public Function IsValidKind(ByVal pBuffer As IVsTextLines, ByVal ts As TextSpan(), ByVal bstrKind As String, ByRef pfIsValidKind As Integer) As Integer Implements IVsExpansionClient.IsValidKind
        pfIsValidKind = 1
        Return VSConstants.S_OK
    End Function
    
    Public Function IsValidType(ByVal pBuffer As IVsTextLines, ByVal ts() As TextSpan, ByVal rgTypes() As String, ByVal iCountTypes As Integer, ByRef pfIsValidType As Integer) As Integer Implements IVsExpansionClient.IsValidType
        pfIsValidType = 1
        Return VSConstants.S_OK
    End Function
    
    Public Function OnAfterInsertion(ByVal pSession As IVsExpansionSession) As Integer Implements IVsExpansionClient.OnAfterInsertion
        Return VSConstants.S_OK
    End Function
    
    Public Function OnBeforeInsertion(ByVal pSession As IVsExpansionSession) As Integer Implements IVsExpansionClient.OnBeforeInsertion
        Return VSConstants.S_OK
    End Function
    
    Public Function PositionCaretForEditing(ByVal pBuffer As IVsTextLines, ByVal ts As TextSpan()) As Integer Implements IVsExpansionClient.PositionCaretForEditing
        Return VSConstants.S_OK
    End Function
    
  10. Implémentez la méthode OnItemChosen.Implement the OnItemChosen method. La méthode d’assistance qui insère en fait les expansions est couverte dans une étape ultérieure.The helper method that actually inserts the expansions is covered in a later step. Le TextSpan fournit des informations de ligne et colonne, que vous pouvez obtenir à partir de la IVsTextView.The TextSpan provides line and column information, which you can get from the IVsTextView.

    public int OnItemChosen(string pszTitle, string pszPath)
    {
        InsertAnyExpansion(null, pszTitle, pszPath);
        return VSConstants.S_OK;
    }
    
    Public Function OnItemChosen(ByVal pszTitle As String, ByVal pszPath As String) As Integer Implements IVsExpansionClient.OnItemChosen
        InsertAnyExpansion(Nothing, pszTitle, pszPath)
        Return VSConstants.S_OK
    End Function
    
  11. La méthode privée suivante insère un extrait de code, basé sur le raccourci ou sur le titre et le chemin d’accès.The following private method inserts a code snippet, based either on the shortcut or on the title and path. Il appelle ensuite la InsertNamedExpansion méthode avec l’extrait de code.It then calls the InsertNamedExpansion method with the snippet.

    private bool InsertAnyExpansion(string shortcut, string title, string path)
    {
        //first get the location of the caret, and set up a TextSpan
        int endColumn, startLine;
        //get the column number from  the IVsTextView, not the ITextView
        m_vsTextView.GetCaretPos(out startLine, out endColumn);
    
        TextSpan addSpan = new TextSpan();
        addSpan.iStartIndex = endColumn;
        addSpan.iEndIndex = endColumn;
        addSpan.iStartLine = startLine;
        addSpan.iEndLine = startLine;
    
        if (shortcut != null) //get the expansion from the shortcut
        {
            //reset the TextSpan to the width of the shortcut, 
            //because we're going to replace the shortcut with the expansion
            addSpan.iStartIndex = addSpan.iEndIndex - shortcut.Length;
    
            m_exManager.GetExpansionByShortcut(
                this,
                new Guid(SnippetUtilities.LanguageServiceGuidStr),
                shortcut,
                m_vsTextView,
                new TextSpan[] { addSpan },
                0,
                out path,
                out title);
    
        }
        if (title != null && path != null)
        {
            IVsTextLines textLines;
            m_vsTextView.GetBuffer(out textLines);
            IVsExpansion bufferExpansion = (IVsExpansion)textLines;
    
            if (bufferExpansion != null)
            {
                int hr = bufferExpansion.InsertNamedExpansion(
                    title,
                    path,
                    addSpan,
                    this,
                    new Guid(SnippetUtilities.LanguageServiceGuidStr),
                    0,
                   out m_exSession);
                if (VSConstants.S_OK == hr)
                {
                    return true;
                }
            }
        }
        return false;
    }
    
    Private Function InsertAnyExpansion(ByVal shortcut As String, ByVal title As String, ByVal path As String) As Boolean
        Dim endColumn As Integer, startLine As Integer
        'get the column number from  the IVsTextView, not the ITextView
        m_vsTextView.GetCaretPos(startLine, endColumn)
    
        Dim addSpan As New TextSpan()
        addSpan.iStartIndex = endColumn
        addSpan.iEndIndex = endColumn
        addSpan.iStartLine = startLine
        addSpan.iEndLine = startLine
    
        'get the expansion from the shortcut
        If shortcut IsNot Nothing Then
            'reset the TextSpan to the width of the shortcut, because we're going to replace the shortcut with the expansion
            addSpan.iStartIndex = addSpan.iEndIndex - shortcut.Length
    
            m_exManager.GetExpansionByShortcut(
                Me,
                New Guid(SnippetUtilities.LanguageServiceGuidStr),
                shortcut,
                m_vsTextView,
                New TextSpan() {addSpan},
                0,
                path,
                title)
        End If
        If title IsNot Nothing AndAlso path IsNot Nothing Then
            Dim textLines As IVsTextLines = Nothing
            m_vsTextView.GetBuffer(textLines)
            Dim bufferExpansion As IVsExpansion = DirectCast(textLines, IVsExpansion)
    
            If bufferExpansion IsNot Nothing Then
                Dim hr As Integer = bufferExpansion.InsertNamedExpansion(
                    title,
                    path,
                    addSpan,
                    Me,
                    New Guid(SnippetUtilities.LanguageServiceGuidStr),
                    0,
                    m_exSession)
                If VSConstants.S_OK = hr Then
                    Return True
                End If
            End If
        End If
        Return False
    End Function
    

Générer et tester l’expansion d’extrait de codeBuild and test code snippet expansion

Vous pouvez tester si l’expansion d’extrait de code fonctionne dans votre projet.You can test whether snippet expansion works in your project.

  1. Générez la solution.Build the solution. Lorsque vous exécutez ce projet dans le débogueur, une deuxième instance de Visual Studio est démarrée.When you run this project in the debugger, a second instance of Visual Studio is started.

  2. Ouvrez un fichier texte et tapez du texte.Open a text file and type some text.

  3. Avec le bouton droit quelque part dans le texte, puis cliquez sur insérer un extrait.Right-click somewhere in the text and then click Insert Snippet.

  4. Le sélecteur d’extraits de l’interface utilisateur doit apparaître avec une fenêtre contextuelle qui dit tester des champs de remplacement.The snippet picker UI should appear with a pop-up that says Test replacement fields. Double-cliquez sur la fenêtre contextuelle.Double-click the pop-up.

    L’extrait de code suivant doit être inséré.The following snippet should be inserted.

    MessageBox.Show("first");  
    MessageBox.Show("second");  
    

    N’appuyez pas sur entrée ou ÉCHAP.Don't press Enter or Esc.

  5. Appuyez sur onglet et MAJ+onglet pour basculer entre « first » et « seconde ».Press Tab and Shift+Tab to toggle between "first" and "second".

  6. Accepter l’insertion en appuyant sur soit entrée ou ÉCHAP.Accept the insertion by pressing either Enter or Esc.

  7. Dans une autre partie du texte, tapez « test » et appuyez sur onglet. Étant donné que « test » est le raccourci d’extrait de code, l’extrait de code doit être inséré à nouveau.In a different part of the text, type "test" and then press Tab. Because "test" is the code-snippet shortcut, the snippet should be inserted again.

Étapes suivantesNext steps