Comment : utiliser une macro pour ajouter du texte dans un éditeur de code Visual Basic ou C#

Vous pouvez utiliser le modèle objet d'extensibilité pour ajouter du code dans un éditeur de code Visual Basic ou Visual C#. Cette fonctionnalité peut notamment servir à ajouter de nouvelles procédures et des blocs de commentaire standard. Cette tâche suppose une connaissance des procédures d'accès à l'environnement de développement Macros et de création d'un projet macro. Pour plus d'informations, consultez Boîte de dialogue Ajouter le projet macro. Pour implémenter l'exemple de macro suivant, vous devez avoir ouvert un projet Visual Basic.

Les étapes suivantes ajoutent un texte à un éditeur de code Visual Basic. Pour ajouter du code à un éditeur de code Visual C#, utilisez la valeur d'énumération prjKindCSharpProject de l'étape 5.

Notes

Les boîtes de dialogue et les commandes de menu qui s'affichent peuvent être différentes de celles qui sont décrites dans l'aide, en fonction de vos paramètres actifs ou de l'édition utilisée. Ces procédures ont été développées avec les paramètres de développement généraux actifs. Pour modifier vos paramètres, choisissez Importation et exportation de paramètres dans le menu Outils. Pour plus d'informations, consultez Utilisation des paramètres.

Pour ajouter du texte en haut de l'éditeur de code Visual Basic actif

1. Créez un module de macro appelé EditorMacros.

2. Créez une nouvelle macro, AddSomeText, en ajoutant le code suivant au module de macro :

   Public Sub AddSomeText()
      ' Will add code here to add text.
   End Sub
   

3. Déclarez et initialisez une variable pour faire référence à l'éditeur de code ouvert.

   Dim doc As Document = DTE.ActiveDocument
   

   Pour plus d'informations, consultez l'objet Document et la propriété ActiveDocument.

4. L'objet Document contient un objet TextDocument, auquel vous pouvez accéder avec la méthode Object, comme indiqué ci-dessous.

   Dim textDoc As TextDocument = _
      CType(doc.Object("TextDocument"), TextDocument)
   

5. Pour vous assurer que vous ajoutez du code à l'éditeur de code Visual Basic, vous pouvez tester la propriété Kind du projet qui contient la fenêtre.

   If doc.ProjectItem.ContainingProject.Kind = _
   VSLangProj.PrjKind.prjKindVBProject Then
      ' Add code here to insert text.
   End If
   

6. À l'aide de l'objet TextDocument, vous pouvez créer un point d'édition au début de l'éditeur. Utilisez ensuite la méthode Insert de la propriété Selection pour ajouter du texte dans l'éditeur. Pour plus d'informations, consultez la méthode CreateEditPoint et la propriété Selection.

   textDoc.StartPoint.CreateEditPoint()
   textDoc.Selection.Insert("' A comment")
   

   La macro complète est affichée ci-dessous :

   Public Sub AddSomeText()
      Dim doc As Document = DTE.ActiveDocument
      Dim textDoc As TextDocument = _
         CType(doc.Object("TextDocument"), TextDocument)
      If doc.ProjectItem.ContainingProject.Kind = _
         VSLangProj.PrjKind.prjKindVBProject Then
         textDoc.StartPoint.CreateEditPoint()
         textDoc.Selection.Insert("' A comment")
      End If
   End Sub
   

7. Enregistrez la macro, fermez l'éditeur de macros, puis exécutez la macro dans l'Explorateur de macros.

Voir aussi

Référence

ActiveDocument

Document

TextDocument