VBA : Bien utiliser l’enregistreur de macro

L’enregistreur de macro : notre meilleur ami (si nous savons l’apprivoiser…)

La vocation première de l’enregistreur de macro EXCEL est la création d’automates exécutant une succession d’actions. On pourra par la suite reproduire ces actions autant de fois que désirées.

C’est, de plus, un outil essentiel d’apprentissage de la programmation VBA : grâce à lui, nous pouvons, explorer les objets complexes exposés par EXCEL.

Cependant, il est nécessaire d’en bien comprendre les possibilités ainsi que les limites pour l’utiliser de façon optimale.

Assurons-nous de la présence de l’onglet “Développeur”

Pour accéder à l’enregistreur de macro, il est nécessaire que l’onglet « Développeur » soit présent dans le ruban EXCEL:

L'onglet développeur

Si tel n’est pas le cas, activons cette fonctionnalité dans : Fichier/Options/Personnaliser le ruban et sélectionnons la case « Développeur » :

Déclenchons l’enregistreur de macro

Pour déclencher l’enregistrement d’une macro, cliquons sur le bouton « Enregistrer une macro » dans l’onglet « Développeur » ou (Alt+v ;R1):

Enregistrer une macro

Par défaut, EXCEL propose le nom « Macro1 » (1 pour notre première macro du classeur, 2 pour la seconde macro, etc.) :

nommage d'une macro

Afin de les repérer plus facilement par la suite, il est vivement conseillé de donner un nom le plus explicite possible aux macros.

Pour le nommage des macros, EXCEL impose les règles suivantes :

  • Son nom doit commencer par une lettre (majuscule ou minuscule) ou un trait de soulignement (_).
  • Son nom ne doit comporter ni espace ni caractères spéciaux (& * / …).
  • Son nom doit être unique dans le classeur.
  • Son nom ne doit pas entrer en conflit avec un mot clé réservé (comme « Print »…).

De manière facultative, nous pouvons affecter une ‘Touche de raccourci’ à la macro. Mais, il existe d’autres moyens pour déclencher à volonté l’exécution d’une macro, par exemple :

  • Au moyen d’un clic sur un bouton (ou une image) présent sur une feuille du classeur.
  • En ajoutant une entrée référant la macro dans le ruban EXCEL.

La macro sera enregistrée dans un module VBA qui suivant le choix peut se trouver :

Nous pouvons compléter la zone « Description » : le texte que nous y insérerons se retrouvera en commentaire dans la macro générée.

 

Dès le moment où nous cliquons sur le bouton « OK » de cette boite de dialogue, toutes les actions réalisées seront enregistrées dans la macro :

  • Sélection de cellules ou plages de cellules,
  • Ecriture de caractères,
  • Insertion de formule,
  • Insertion d’objet,
  • Déclenchement d’une fonction EXCEL,
  • Etc.

 

Stoppons l’enregistreur de macro

Pour stopper l’enregistrement d’une macro, cliquons sur le bouton « Arrêter l’enregistrement » dans l’onglet « Développeur » ou (Alt+v ;R1):

Arret de l'enregistreur

 

Exerçons-nous 

A titre d’exercice, déclenchons l’enregistrement d’une nouvelle macro, nommons la ‘MaPremiereMacro’ et donnons lui la description ‘Ceci est ma première macro’. Cliquons sur OK et effectuons les actions suivantes :

Dans la cellule A1, entrons la formule permettant d’obtenir la date et l’heure actuelle : « =MAINTENANT() »
Copions la cellule dans le presse-papier (Ctrl+C)
Déplaçons la sélection sur la cellule D1
Collons le contenu du presse-papier (Ctrl+V)
Redimensionnons la cellule D1 pour visualiser la date et heure courante par un double-clic sur le quadrillage de la colonne D :

Exercice Enregistreur

Stoppons l’enregistrement de la macro

 

Pour réviser le code VBA d’une macro enregistrée, cliquons sur le bouton « Visual Basic » dans l’onglet « Développeur » ou (Alt+F11):

Ouvrir l'éditeur Visual Basic

L’éditeur de code VBA (VBE) s’ouvre dans une nouvelle fenêtre.

En sélectionnant « Modules/Module1 » nous visualisons le code VBA généré par notre exercice :

Code VBA Genere

Pour une formation à la programmation VBA, nous nous reporterons utilement au cours : https://www.excel-pratique.com/fr/vba.

Le code VBA de la macro générée devrait se présenter sensiblement comme ci-dessous :

Sub MaPremiereMacro()
'
' MaPremiereMacro Macro
' Ceci est ma première macro
'

'
1    ActiveCell.FormulaR1C1 = "=NOW()"
2    Range("A1").Select
3    Selection.Copy
4    Range("D1").Select
5    ActiveSheet.Paste
6    Columns("D:D").EntireColumn.AutoFit
End Sub
  • La description de la macro a été reproduite dans l’entête
  • Ligne 1 : Le code se réfère à « ActiveCell» pour entrer la formule.
  • Ligne 1 : La formule « MAINTENANT() » a été traduite en sa forme anglaise.
    (Un outil de traduction français/anglais des formules EXCEL est disponible ici : https://www.excel-pratique.com/fr/index_des_fonctions/traduction_formule).
  • Ligne 3 : La copie de la cellule est réalisée au moyen de la propriété « Selection ».
  • Ligne 6 : Le redimensionnement de la colonne « D » est réalisé au moyen de la fonction « Autofit ».

Améliorons le code VBA de la macro générée

Dans le code VBA généré, nous observons que :

  • Ligne 1 : dans notre exercice, nous n’avions pas explicitement sélectionné la cellule A1.
    L’enregistreur, utilisant le référencement implicite, a enregistré la propriété ‘ActiveCell’. Si nous voulons que la macro sélectionne spécifiquement la cellule “A1”, nous modifierons le code de la ligne en affectant une variable objet ‘oRange’ de la façon suivante :
    • Set oRange = ActiveSheet.Range(“A1”)
    • oRange.FormulaR1C1 = “=NOW()”
  • Ligne 2 et 3 : l’enregistreur met en œuvre la méthode « Select » puis la propriété « Selection » pour copier la cellule. Cette façon n’est pas optimale ni sur le plan de la fiabilité ni sur celui des performances. Nous préférerons faire appel aux méthodes équivalentes des objets « Range ». Ainsi nous remplacerons la ligne 3 avec :
    • oRange.copy

Même sur une séquence relativement simple, nous pouvons apporter des améliorations au code généré par l’enregistreur de macro. Par exemple, l’expérience montre que, lors de l’enregistrement de macro, nous réalisons des actions inutiles, nous tâtonnons et il nous arrive de ne pas stopper à temps l’enregistreur. Tout ceci a pour effet de générer du code VBA inutile (voire néfaste). Nous avons donc tout intérêt après utilisation de l’enregistreur de macro, à réviser le code généré pour en éliminer le code superflu et améliorer sa fiabilité et sa performance.

     

    Connaissons les limites de l’enregistreur de macro

    Indéniablement utile dans la plupart des situations, l’enregistreur de macro ne nous sera pas d’un grand secours lorsque nous utilisons les « Compléments COM ». En effet dans ce cas, il se révèlera incapable de générer le code VBA attendu.

    De plus, les macros générés par l’enregistreur de macro comportent les limitations suivantes :

    • L’enregistreur de macro ne permet pas le passage d’arguments à la macro générée. Si cela est nécessaire, il faudra modifier la macro générée. Voir l’article Microsoft Transmission efficace d’arguments.
    • L’enregistreur ne permet pas de créer complètement des fonctions personnalisées telles que décrites dans l’article Microsoft Créer des fonctions personnalisées.
    • L’enregistreur ne permet pas de créer complètement un code VBA se déclenchant lorsqu’un certain évènement se produit. Par exemple, lorsqu’une certaine cellule est modifiée dans une feuille particulière.
    • L’enregitreur de macro ne peut pas créer des boucles de type :
      • For Next
      • Do While
      • Do Until
      • For each Next
    • L’enregistreur de macro ne peut pas conditionner le déroulement de la macro par les instructions :
      • If-Then-Else
      • Select Case
    • L’enregistreur de macro ne génère aucune déclarations explicite de variables. Voir l’article VBA: L’option explicit

      Résumons les BONNES PRATIQUES à mettre en oeuvre

       

      • Utilisons l’enregistreur de macro aussi souvent que nécessaire. C’est un moyen rapide pour explorer les objets EXCEL, leur collections, méthodes, propriétés.
        Un autre moyen, encore plus rapide : le pur copier/coller de code trouvé sur le NET par exemple. Mais, dans ce cas, il est indispensable de comprendre et de s’approprier ce code. « Science sans conscience n’est que ruine de l’âme » nous enseigne Rabelais. Et n’omettons pas de citer l’auteur du code plagié. 
      • N’enregistrons pas des séquences trop longues d’actions et circonscrivons l’enregistrement à un seul sujet.
      • Révisons systématiquement le code généré.

       

      Allons vers d’autres articles “Bonnes Pratiques VBA”.

      Le débogage de code VBA

      DEBUTONS LE DEBOGAGE : COMPILONS ! 

      Pourquoi compiler ? 

      Quand compiler ?

      Comment compiler ?

      DEBOGUONS LES ERREURS D’EXECUTION ET DE LOGIQUE

      Ajoutons la barre de menu du débogueur

      Exécutons le code en mode pas à pas

      Examinons les techniques et outils à notre disposition

      Affichage de la valeur d’une variable

      Mise en place de point d’arrêt

      Mise en place d’espions

      La fenêtre des « Variables locales »

      La fenêtre d’exécution

      Utilisation de l’instruction « Debug.Print »

      Utilisation de l’instruction « Msgbox »

      APRES DEBOGAGE, N’OUBLIONS PAS !

       

       

      DEBUTONS LE DEBOGAGE : COMPILONS !

      Le langage VBA est du type « interprété » alors que d’autre langages sont de type « compilé » (tels C++, C#, Pascal…)

      Cela signifie qu’il n’y a pas nécessité de compiler les codes VBA pour pouvoir les exécuter.

      L’interpréteur VBA se charge de transformer « à la volée », ligne à ligne, le code VBA compréhensible par l’humain en code compréhensible par la machine (exécutable).

      Toutefois, VBA possède une fonction de compilation produisant à partir du code source VBA un autre objet exécutable par Windows.

      Il semble que cette opération n’ait pas d’impact significatif sur les performances d’exécution des codes VBA, contrairement à ce qu’on pourrait attendre.

       

      Pourquoi compiler ?

      En compilant notre code, nous pourrons éliminer les erreurs de syntaxe non corrigées ou non détectées lors de la saisie du code dans l’éditeur VBE.

      Ici, une liste non exhaustive des erreurs commises couramment détectées lors de la compilation :

      • Instruction IF sans END IF
      • Directive WITH sans END WITH
      • Instruction SELECT sans END SELECT
      • Instruction FOR ou FOR EACH sans NEXT
      • Appel de procédure ou fonction inexistantes ou non atteignables
      • Passage de paramètres non conformes ou omis lors d’appel aux procédures et fonctions.
      • Variable non déclarée en cas d’utilisation de la clause « Option Explicit ».

      VBA ne nous contraint pas à déclarer toutes les variables utilisées dans le code (d’ailleurs, par exemple, l’enregistreur de macro ne le fait pas).

      Cependant, beaucoup d’auteurs de référence recommandent l’utilisation de la clause « Option explicit »

      Concernant l’utilisation des variables en VBA, nous nous reporterons utilement aux chapitres de la formation VBA du site « EXCEL-PRATIQUE » :

      https://www.excel-pratique.com/fr/vba/variables

      https://www.excel-pratique.com/fr/vba/variables_suite

       

      Quand compiler ?

      Le compilateur VBA n’indique pas les erreurs en bloc mais s’arrête à chaque fois qu’il en rencontre une pour la signaler.

      Nous avons tout intérêt, pour corriger nos erreurs de syntaxe, à lancer régulièrement une compilation au fur et à mesure de l’écriture d’une séquence de code conséquente.

      Comment compiler ?

      Nous exécutons la compilation de notre projet VBA par l’activation des choix dans le menu VBE : Débogage/Compiler [nom de projet] ou le raccourci clavier : ‘Alt+D+l’ :

      Menu_Debogage_Compiler

       

      Lorsqu’un projet est compilé sans erreur, le choix « Compiler [nom de projet] » apparaît en grisé dans le sous- menu « Débogage ».

       

      DEBOGUONS LES ERREURS D’EXECUTION ET DE LOGIQUE

      Une fois notre code compilé sans erreur, nous nous attaquons au débogage des erreurs se produisant à l’exécution ainsi que des erreurs de logique.

       

      Ajoutons la barre de menu du débogueur

      Pour nous faciliter la tâche, nous pouvons ajouter à l’éditeur VBA la barre de menu spécifique au débogage : En cliquant droit sur la barre de menu et en sélectionnant « Débogage » :

      La barre suivante est ajoutée :

      Cette barre reprend les fonctions accessibles dans le sous-menu « Débogage » :

      Exécutons le code en mode pas à pas

      Dans l’éditeur VBE, nous avons la possibilité d’exécuter le code suivant diverses modalités :

      En positionnant le curseur sur le début d’une procédure ou fonction et en cliquant sur le bouton dans la barre de débogage   (ou F8) nous exécutons le code en mode pas à pas, sur chaque ligne d’instructions de notre code :

      De cette façon, nous suivrons le cheminement de notre code, en vérifiant la logique et corrigeant les erreurs.

      Nous ne pouvons exécuter de cette façon que les procédures (Sub) ou fonctions (Function) qui n’attendent aucun paramètre d’entrée. Pour déboguer une procédure ou fonction attendant des paramètres, nous débuterons le débogage dans une procédure ou fonction appelante transmettant les paramètres attendus.

      Après avoir activé le mode pas à pas, la ligne de la procédure ou fonction à exécuter est surlignée en jaune :

      Lorsque nous cliquons une nouvelle fois sur le bouton « Pas à pas » (ou F8), le débogueur se positionne sur la première instruction à exécuter, en négligeant le lignes de déclarations de constantes ou de variables :

      Ainsi de suite jusqu’à la fin de la procédure ou fonction (End Sub/End Function)

      En mode d’exécution pas à pas, en plaçant le curseur sur la flèche jaune dans la marge tout en maintenant le clic gauche de la souris, nous avons la possibilité de déplacer la prochaine exécution en aval ou en amont des instructions du code.

      Examinons les techniques et outils à notre disposition

       

      Affichage de la valeur d’une variable

      En suivant l’exécution de notre code en mode « pas à pas », nous avons la possibilité de connaître la valeur de variables impliquée dans l’instruction à exécuter, en plaçant simplement le curseur sur cette variable : un « tip » nous indique sa valeur :

      Mise en place de point d’arrêt

      Nous positionnons un point d’arrêt en cliquant dans la marge devant une instruction (ou en cliquant sur le bouton  ou F9).

      La ligne d’instruction apparaît alors surlignée en rouge foncé avec un repère de même couleur dans la marge :

      Une fois un point d’arrêt positionné, lorsque nous exécutons le code en mode « continu » (F5), l’exécution s’arrêtera sur la ligne avant de l’exécuter :

      Pour effacer tous les points d’arrêts positionnés : (Ctrl+Maj+F9).

       

      Mise en place d’espions

       

      Avec la mise en place d’espions, nous avons la possibilité de définir des expressions permettant soit de visualiser leurs valeurs tout au long de l’exécution, soit de stopper l’exécution lorsque l’expression devient vraie, soit de stopper l’exécution lorsque leurs valeurs changent.

      Nous positionnons un espion en cliquant le bouton  (ou Alt+D+u).

      Dans l’exemple suivant nous positionnons un espion permettant de suivre l’évolution de la valeur de la variable objet « oRange » :

      La fenêtre « Espions » que nous faisons apparaître en cliquant sur le bouton (ou Alt+A+s), liste tous les espions positionnés avec leurs valeurs :

      La fenêtre des « Variables locales »

      La fenêtre « Variables locales » que nous faisons apparaître en cliquant sur le bouton   (ou Alt+A+v), liste toutes les variables de la procédure en cours :

      Et pour les tableaux mémoire (array), la liste de toutes leurs dimensions et valeurs :

      De plus, nous avons la possibilité dans cette fenêtre d’ouvrir, pour les variables objets, la liste de toutes les propriétés de l’objet avec leurs valeurs :

      La fenêtre d’exécution

      La fenêtre « d’exécution » que nous faisons apparaître en cliquant sur le bouton  (ou Ctrl+G), nous offre une multitude d’utilisations :

       

      • En y formulant une question, nous pouvons obtenir immédiatement la réponse.
        Par exemple si nous voulons connaitre le dossier du classeur actif, il suffit d’enter dans la fenêtre le signe « ? » suivi de la propriété recherchée. La valeur est alors restituée dans la ligne suivante de la fenêtre :

       

      • Nous pouvons également y exécuter une instruction en dehors du code de la procédure exécutée. Par exemple avec l’instruction suivante, on modifie la couleur du fond d’une plage définie au préalable :

      Résultat obtenu :

      • Nous pouvons exécuter une procédure ou une fonction en lui passant des paramètres et obtenir la valeur retournée :
      • Nous pouvons affecter une valeur à une variable :
      • Nous pouvons y voir figurer les valeurs affectées par l’instruction « Print» (Cf ci-dessous).

      Utilisation de l’instruction « Debug.Print »

      L’instruction « Debug.Print » suivi d’une valeur introduite dans le code, nous permet de visualiser cette valeur dans la « Fenêtre exécution » (Ctrl+G)

      Notons que cette instruction a l’avantage de pouvoir être laissée dans le code après mise au point du fait que son résultat n’apparaîtra pas à l’utilisateur dans un usage ordinaire.

      Utilisation de l’instruction « Msgbox »

      L’instruction « Msgbox » suivi d’une variable, permet d’obtenir l’affichage d’un message contenant la valeur de cette variable :

      Le déroulement du code est interrompu tant que l’on ne clique pas sur le bouton « OK » du message.

      Nous pouvons noter que le désavantage de cette instruction réside dans le fait qu’elle ne doit pas subsister dans le code une fois la mise au point finalisée pour ne pas faire apparaître aux utilisateurs un message obscur interrompant le déroulement du programme.

       

       

      APRES DEBOGAGE, N’OUBLIONS PAS !

      Après notre phase de mise au point, nous n’oublions pas :

      • De supprimer tous les points d’arrêts positionnés.
      • De supprimer tous les espions interrompant le code.
      • De supprimer toutes les instructions « Msgbox » introduites dans le code pour afficher des valeurs.

       

      Allons vers d’autres articles “Bonnes Pratiques VBA”.

      Version PDF de cet article : Outils de débogage VBA

      VBA: Les Commentaires

      Comment commenter le code VBA ?

       

      Dans VBA, il suffit de faire précéder une partie de texte par une « apostrophe » pour en faire un commentaire.

      Afin de visualiser les commentaires commodément, l’éditeur VBA (VBE) les colore automatiquement en vert les commentaires.

      Pour rendre notre code plus accessible, faisons figurer ainsi un texte explicatif aux endroits nécessaires :

      • En tête d’un module VBA
      • En tête d’une procédure
      • A n’importe quel endroit du code nécessitant une explication

       Par exemple :

      Les commentaires VBA

      VBA: L’option Explicit

      Pourquoi systématiquement utiliser « VBA Option Explicit » ?

       

      Mieux qu’un long argumentaire, illustrons le problème tel qu’il se pose fréquemment.

      Envisageons  un module VBA sans « Option Explicit » contenant la procédure simplissime ‘AquoiSertOptionExplicit’ :

      Sub AquoiSertOptionExplicit()
          Dim sUneVariable As String
          sUneVariable = "C'est la valeur"
          MsgBox "La valeur de la variable est :" & UneVariable
      End Sub
      

      Remarquons qu’une erreur s’est glissée lors de l’écriture de cette procédure : la variable affichée avec l’instruction « Msgbox » est ‘UneVariable’ alors que la variable valorisée dans la ligne précédente est ‘sUneVariable’.

      (Que nous soyons novices ou aguerris en programmation, nous faisons très régulièrement ce type de coquille.) 

      A l’exécution, aucune erreur ne se produit et le message affiché se présente ainsi :

      A ce résultat, nous nous questionnons  : pourquoi cela ne correspond pas à ce que nous attendions ?

      Nous chercherons l’origine du problème, en envisageant parfois de nombreuses hypothèses (qui s’avèreront inexactes) et perdrons beaucoup de temps avant de trouver la solution.

      (Cet exemple est trivial et nous devrions le résoudre rapidemment. Dans  la réalité, il n’en est pas toujours de même.)

      Ajoutons maintenant l’option Explicit’ dans la première ligne du module VBA :

      Si maintenant, nous exécutons la procédure, un message d’erreur de compilation s’affiche tout en surlignant la variable non définie « UneVariable » : 

      Il nous sera alors aisé de comprendre l’origine du problème et de corriger notre erreur d’écriture.

      EN CONCLUSION

      Ajoutons systématiquement ‘Option Explicit’ en tête de chacun de nos modules.

      Remarque 1

      Nous systématiserons l’ajout de ‘Option Explicit’ en tête de chaque module créé en cochant le paramètre ‘Déclaration des variables obligatoire’ de la boîte de dialogue ‘Options’ que l’on active par le menu VBA ‘Outils<Options…’ :

      Remarque 2

      Les macros créées par l’enregistreur de macro s’insèrent dans des modules ne possédant pas l’option ‘explicit’ lorsque la case

      Déclaration des variables obligatoire’ n’a pas été cochée.

      Remarque 3

      Les modules attachés aux objets Excel (« Thisworkbook », « Feuil1 »…) de possèdent pas par défaut l’option Explicit. Il est conseillé de l’ajouter si nous plaçons du code dans ces modules.

       

      Allons vers d’autres articles “Bonnes Pratiques VBA”.