Pilotage OLE de Word à partir de Borland C++ Builder

LFE

Ce document a pour but de présenter une méthode simple de pilotage OLE de Word à partir de C++ Builder. ♪

- Titre : Pilotage OLE de Word à partir de Borland C++ Builder

- Auteur : LFE

- Parution : 3 novembre 2002

- Licence : Ce document est issu de https://www.developpez.com et reste la propriété exclusive de son auteur. La copie, modification et/ou distribution par quelque moyen que ce soit est soumise à l'obtention préalable de l'autorisation de l'auteur.

Sommaire

- Avant-Propos

- I. Démarrer Word

- I-A. Ouvrir une nouvelle instance

- I-B. Se connecter à une instance existante

- II. Fermer Word

- III. Créer un nouveau document

- IV. Ouvrir un document existant

- IV-A. Ouvrir un document simple

- IV-B. Ouvrir un document en lecture seule

- IV-C. Ouvrir un document protégé par un mot de passe

- V. Enregistrer un document

- V-A. Enregistrer le classeur sous le même nom

- V-B. Enregistrer le document sous un autre nom

- VI. Fermer un classeur

- VII. Utiliser des signets pour insérer du texte dans un document

- VII-A. Accéder aux signets

- VII-B. Insérer le texte

- VIII. Lister les signets contenus dans un document

Avant-Propos

Ce document a pour seul but de présenter une façon simple de piloter Word, en restant indépendant des composants de BCB.
Le code a été écrit et testé avec Borland C++ Builder 6.0 Enterprise anglais et Word 2000 français.

Les commentaires au code sont minimaux, ceci n'étant pas une explication du fonctionnement de Word, mais simplement l'interfaçage avec C++ Builder et le code étant, je pense, explicite par lui-même.

L'utilisation du Variant est quasi générale. Pour rappel, le type Variant est un type de variable qui a la particularité de pouvoir ne pas être déterminé au moment de la compilation, et même de changer en cours d'exécution du programme. Son plus grand intérêt, à mon sens, est qu'il peut aussi contenir une interface vers un objet OLE et donner accès aux propriétés, procédures et fonctions de celui-ci.

La comparaison avec le pilotage d'Excel permet de constater qu'à l'exception des noms de collections et d'objets, les techniques sont identiques, à très peu de choses près.

I - Démarrer Word

Ajouter la ligne suivante dans les include :

#include <utilcls.h>

I-A - Ouvrir une nouvelle instance

Variant vMSWord;

vMSWord = Variant::CreateObject("Word.Application");
vMSWord.OlePropertySet("Visible", true);

La propriété Visible permet de spécifier si Word est affiché a l'écran ou s'il reste en tâche de fond.

I-B - Se connecter à une instance existante

Variant vMSWord;

vMSWord = Variant::GetActiveObject("Word.Application");
vMSWord.OlePropertySet("Visible", true);

Le code suivant permet donc de lancer Word s’il n'est pas déjà actif ou de se connecter à l'instance existante éventuelle

try {
vMSWord = Variant::GetActiveObject("Word.Application");
} catch(...) {
vMSWord = Variant::CreateObject("Word.Application");
}

II - Fermer Word

vMSWord.OleFunction("Quit");
vMSWord = Unassigned;

Positionner vMSWord à Unassigned permet de libérer le Variant.

III - Créer un nouveau document

Variant vWDocument, vWDocuments;

vWDocuments = vMSWord.OlePropertyGet("Documents");
vWDocument = vWDocuments.OleFunction("Add");

Word tient à jour une liste de tous les documents ouverts, dans une collection appelée Documents.

Ouvrir un nouveau document revient simplement à ajouter un nouvel élément à cette collection. La fonction Add renvoie un Variant faisant référence au nouveau document.

IV - Ouvrir un document existant

IV-A - Ouvrir un document simple

Variant vFileName, vWDocuments, vWDocument;

vFileName = "c:\\Home\\Sources\\Cpp\\Word\\Document1.doc";
vWDocuments = vMSWord.OlePropertyGet("Documents");
vWDocument = vWDocuments.OleFunction("Open", vFileName);

Ouvrir un document se fait sur le même principe que la création, à savoir l'ajout a la collection Documents d'un nouvel élément, non plus avec la fonction Add, mais la fonction Open.

IV-B - Ouvrir un document en lecture seule

Variant vFileName, vWDocuments, vWDocument, vReadOnly, vLink;

vFileName = "c:\\Home\\Sources\\Cpp\\Word\\Document1.doc";
vLink = Unassigned;
vReadOnly = true;
vWDocuments = vMSWord.OlePropertyGet("Documents");
vWDocument = vWDocuments.OleFunction("Open", vFileName, vLink, vReadOnly);

Ouvrir un document en lecture seule se fait en passant le 3e paramètre de la fonction Open avec une valeur true.

La fonction Open possède une série de paramètres dont la liste exhaustive se trouve dans l'aide de VBA pour Word.

À noter que les paramètres facultatifs doivent être passés comme des Variants Unassigned, et non des NULL, comme on pourrait le penser au premier abord.

IV-C - Ouvrir un document protégé par un mot de passe

Variant vFileName, vWDocuments, vWDocument, vReadOnly, vLink, vFormat, vReadPass;

vFileName = "c:\\Home\\Sources\\Cpp\\Word\\Document1.doc";
vLink = Unassigned;
vReadOnly = false;
vFormat = Unassigned;
vReadPass = "MotDePasse";
vWDocuments = vMSWord.OlePropertyGet("Documents");
vWDocument = vWDocuments.OleFunction("Open", vFileName, vLink, vReadOnly, vFormat, vReadPass);

Le 5e paramètre de la fonction Open permet de spécifier le mot de passe utilisé pour la protection en lecture du classeur.

V - Enregistrer un document

V-A - Enregistrer le classeur sous le même nom

Une fois le document ouvert, pour l'enregistrer, il suffit de faire :

vWDocument.OleProcedure("Save");

V-B - Enregistrer le document sous un autre nom

Une fois le document ouvert, pour l'enregistrer en changeant de nom, il suffit de faire :

Variant vFileName;

vFileName = "c:\\Home\\Sources\\Cpp\\Word\\Document1.doc";
vWDocument.OleProcedure("Saveas", vFileName);

VI - Fermer un classeur

Variant vSaveChanges, vFileName;

vSaveChanges = Unassigned;
vFileName = "c:\\Home\\Sources\\Cpp\\Word\\Document1.doc";
vWDocument.OleFunction("Close", vSaveChanges);

Le 1er paramètre de la fonction Close permet de spécifier si les modifications sont enregistrées

- true : les modifications sont enregistrées ;

- false : les modifications ne sont pas enrgistrées ;

- Unassigned : demande à l'utilisateur.

Le 2e paramètre de la fonction Close permet de spécifier le nom sous lequel le classeur sera enregistré.

Ces deux paramètres sont facultatifs.

VII - Utiliser des signets pour insérer du texte dans un document

VII-A - Accéder aux signets

Variant vBookMarks, vWDocument, vBookMark;

vBookMarks = vWDocument.OlePropertyGet("BookMarks");
if (vBookMarks.OleFunction("Exists", "signet1")) {
vBookMark = vBookMarks.OleFunction("Item", "signet1");
vBookMark.OleFunction("Select");
// ...
}

Pour accéder à un signet, il faut d'abord ouvrir la collection BookMarks, et vérifier que le signet existe : Exists.

La fonction Item permet d'extraire un signet de la collection.

Select permet de l'atteindre.

VII-B - Insérer le texte

Variant vBookMark, vContent;

vContent = vBookMark.OlePropertyGet("Range");
vContent.OleFunction("InsertAfter", "texte");

Une fois le signet atteint, il faut accéder au Range.

La fonction InsertAfter permet d'insérer le texte à la position courante du curseur.

VIII - Lister les signets contenus dans un document

Le code qui suit permet de lister tous les signets contenus dans un document Word et de les afficher dans un ListBox.

Variant vBookMark, vBookMarks, vContent;

int iCount;
AnsiString aBookName;
vBookMarks = vWDocument.OlePropertyGet("BookMarks");
iCount = vBookMarks.OlePropertyGet("Count");
for (int i=1; i <= iCount; i++) {
vBookMark = vBookMarks.OleFunction("Item", i);
aBookName = vBookMark.OlePropertyGet("Name");
ListBox1->Items->Add(aBookName);
vBookMark = Unassigned;
}