Partager via


Procédure pas à pas : appeler du code à partir de VBA dans un projet Visual Basic

Cette procédure pas à pas montre comment appeler une méthode dans une personnalisation au niveau du document pour Microsoft Office Word à partir du code Visual Basic pour Applications (VBA) dans le document. La procédure implique trois étapes de base : ajouter une méthode à la ThisDocument classe d’élément hôte, exposer la méthode au code VBA, puis appeler la méthode à partir du code VBA dans le document.

S’applique à : Les informations contenues dans cette rubrique s’appliquent aux projets au niveau du document pour Excel et Word. Pour plus d’informations, consultez Fonctionnalités disponibles par type d’application et de projet Office.

Bien que cette procédure pas à pas utilise Word spécifiquement, les concepts présentés par la procédure pas à pas s’appliquent également aux projets au niveau du document pour Excel.

Cette procédure pas à pas décrit les tâches suivantes :

  • Création d’un document qui contient du code VBA.

  • Faire confiance à l’emplacement du document à l’aide du Centre de fiabilité dans Word.

  • Ajout d’une méthode à la classe d’élément ThisDocument hôte.

  • Exposer la méthode au code VBA.

  • Appel de la méthode à partir du code VBA.

Note

Il est possible que pour certains des éléments de l'interface utilisateur de Visual Studio, votre ordinateur affiche des noms ou des emplacements différents de ceux indiqués dans les instructions suivantes. L'édition de Visual Studio dont vous disposez et les paramètres que vous utilisez déterminent ces éléments. Pour plus d’informations, consultez Personnaliser l’IDE Visual Studio.

Prerequisites

Vous devez disposer des éléments suivants pour exécuter cette procédure pas à pas :

Créer un document qui contient du code VBA

La première étape consiste à créer un document prenant en charge les macros qui contient une macro VBA simple. Le document doit contenir un projet VBA avant de créer un projet Visual Studio basé sur ce document. Sinon, Visual Studio ne peut pas modifier le projet VBA pour permettre au code VBA d’appeler l’assembly de personnalisation.

Si vous disposez déjà d’un document qui contient du code VBA que vous souhaitez utiliser, vous pouvez ignorer cette étape.

Pour créer un document qui contient du code VBA

  1. Démarrez Word.

  2. Enregistrez le document actif sous la forme d’un document Word avec macros activées (*.docm) avec le nom DocumentWithVBA. Enregistrez-le dans un emplacement pratique, tel que le bureau.

  3. Dans le ruban, cliquez sur l’onglet Développeur .

    Note

    Si l’onglet Développeur n’est pas visible, vous devez d’abord l’afficher. Pour plus d’informations, consultez Guide pratique pour afficher l’onglet Développeur du ruban.

  4. Dans le groupe Code , cliquez sur Visual Basic.

    Visual Basic Editor s’ouvre.

  5. Dans la fenêtre Projet , double-cliquez sur ThisDocument.

    Le fichier de code de l’objet ThisDocument s’ouvre.

  6. Ajoutez le code VBA suivant au fichier de code. Ce code définit une fonction simple qui ne fait rien. Le seul objectif de cette fonction est de s’assurer qu’un projet VBA existe dans le document. Cela est nécessaire pour les étapes ultérieures de cette procédure pas à pas.

    Sub EmptySub()
    End Sub
    
  7. Enregistrez le document et quittez Word.

Créer le projet

Vous pouvez maintenant créer un projet au niveau du document pour Word qui utilise le document avec macro que vous avez créé précédemment.

Pour créer un projet

  1. Démarrez Visual Studio.

  2. Dans le menu Fichier , pointez sur Nouveau, puis cliquez sur Projet. Si votre IDE est défini pour utiliser les paramètres de développement Visual Basic, dans le menu Fichier , cliquez sur Nouveau projet.

  3. Dans le volet modèles, développez Visual Basic, puis développez Office/SharePoint.

  4. Sélectionnez le nœud Compléments Office .

  5. Dans la liste des modèles de projet, sélectionnez le projet document Word 2010 ou Word 2013 Document .

  6. Dans la zone Nom , tapez CallingCodeFromVBA.

  7. Cliquez sur OK.

    L’Assistant Projet Visual Studio Tools pour Office s’ouvre.

  8. Sélectionnez Copier un document existant et, dans le chemin d’accès complet de la zone de document existant , spécifiez l’emplacement du document DocumentWithVBA que vous avez créé précédemment. Si vous utilisez votre propre document avec macro, spécifiez plutôt l’emplacement de ce document.

  9. Cliquez sur Terminer.

    Visual Studio ouvre le document DocumentWithVBA dans le concepteur et ajoute le projet CallingCodeFromVBA à l’Explorateur de solutions.

Faire confiance à l’emplacement du document

Avant de pouvoir exposer du code dans votre solution au code VBA dans le document, vous devez faire confiance à VBA dans le document pour l'exécuter. Il existe plusieurs façons de procéder. Pour cette procédure pas à pas, faites confiance à l’emplacement du document dans le Centre de gestion de la confidentialité dans Word.

Pour faire confiance à l’emplacement du document

  1. Démarrez Word.

  2. Cliquez sur l’onglet Fichier .

  3. Cliquez sur le bouton Options de Word .

  4. Dans le volet Catégories, cliquez sur Centre de gestion de la confidentialité.

  5. Dans le volet d’informations, cliquez sur Paramètres du Centre de gestion de la confidentialité.

  6. Dans le volet Catégories, cliquez sur Emplacements approuvés.

  7. Dans le volet d’informations, cliquez sur Ajouter un nouvel emplacement.

  8. Dans la boîte de dialogue Emplacement approuvé Microsoft Office , accédez au dossier qui contient le projet CallingCodeFromVBA .

  9. Sélectionnez Les sous-dossiers de cet emplacement sont également approuvés.

  10. Dans la boîte de dialogue Emplacement approuvé Microsoft Office , cliquez sur OK.

  11. Dans la boîte de dialogue Centre de gestion de la confidentialité, cliquez sur OK.

  12. Dans la boîte de dialogue Options word , cliquez sur OK.

  13. Quittez Word.

Ajouter une méthode à la classe ThisDocument

Maintenant que le projet VBA est configuré, ajoutez une méthode à la ThisDocument classe d’élément hôte que vous pouvez appeler à partir du code VBA.

Pour ajouter une méthode à la classe ThisDocument

  1. Dans l’Explorateur de solutions, cliquez avec le bouton droit sur ThisDocument.vb, puis cliquez sur Afficher le code.

    Le fichier ThisDocument.vb s’ouvre dans l’Éditeur de code.

  2. Ajoutez la méthode suivante à la classe ThisDocument. Cette méthode crée une table avec deux lignes et deux colonnes au début du document. Les paramètres spécifient le texte affiché dans la première ligne. Plus loin dans cette procédure pas à pas, vous allez appeler cette méthode à partir du code VBA dans le document.

    Public Sub CreateTable(ByVal firstColumnHeader As String, _
        ByVal secondColumnHeader As String)
    
        Me.Paragraphs(1).Range.InsertParagraphBefore()
        Dim table1 As Word.Table = Me.Tables.Add(Me.Paragraphs(1).Range, 2, 2)
    
        With table1
            .Style = "Table Professional"
            .Cell(1, 1).Range.Text = firstColumnHeader
            .Cell(1, 2).Range.Text = secondColumnHeader
        End With
    End Sub
    
  3. Construisez le projet.

Exposer la méthode au code VBA

Pour exposer la CreateTable méthode au code VBA dans le document, définissez la propriété EnableVbaCallers pour l’élément ThisDocument hôte sur True.

Pour exposer la méthode au code VBA

  1. Dans l’Explorateur de solutions, double-cliquez sur ThisDocument.vb.

    Le fichier DocumentWithVBA s’ouvre dans le concepteur.

  2. Dans la fenêtre Propriétés , sélectionnez la propriété EnableVbaCallers et remplacez la valeur par True.

  3. Cliquez sur OK dans le message qui s’affiche.

  4. Construisez le projet.

Appeler la méthode à partir du code VBA

Vous pouvez maintenant appeler la CreateTable méthode à partir du code VBA dans le document.

Note

Dans cette procédure pas à pas, vous allez ajouter du code VBA au document lors du débogage du projet. Le code VBA que vous ajoutez à ce document sera remplacé la prochaine fois que vous générez le projet, car Visual Studio remplace le document dans le dossier de sortie de build par une copie du document à partir du dossier du projet principal. Si vous souhaitez enregistrer le code VBA, vous pouvez le copier dans le document dans le dossier du projet. Pour plus d’informations, consultez Combiner des personnalisations au niveau du document et VBA.

Pour appeler la méthode à partir du code VBA

  1. Appuyez sur F5 pour exécuter votre projet.

  2. Sous l’onglet Développeur , dans le groupe Code , cliquez sur Visual Basic.

    Visual Basic Editor s’ouvre.

  3. Dans le menu Insertion , cliquez sur Module.

  4. Ajoutez le code suivant au nouveau module.

    Ce code appelle la CreateTable méthode dans l’assembly de personnalisation. La macro accède à cette méthode à l’aide de la CallVSTOAssembly propriété de l’objet ThisDocument . Cette propriété a été générée automatiquement lorsque vous définissez la propriété EnableVbaCallers précédemment dans cette procédure pas à pas.

    Sub CreateTable()
        Call ThisDocument.CallVSTOAssembly.CreateTable("Employee Name", "Start Date")
    End Sub
    
  5. Appuyez sur F5.

  6. Vérifiez qu’une nouvelle table a été ajoutée au document.

  7. Quittez Word sans enregistrer vos modifications.

Étapes suivantes

Vous pouvez en savoir plus sur l’appel de code dans les solutions Office à partir de VBA dans les rubriques suivantes :