Module de liaison OpenXML pour Microsoft Excel et Word

Généralités

Ce module permet la liaison avec des fichiers au format OpenXml, pour

  • lecture et l'écriture de cellules dans des fichiers excel au format xlsx (attention c'est uniquement du format xlsx)

  • lecture et écriture de texte dans des fichiers word au format docx (attention, c’est uniquement du format docx)

En mode client léger distant, ce module n'est exécutable que du côté serveur, le fichier xlsx/docx doit être donc du côté serveur et pas du côté client léger.

Le traitement des fichiers word est disponible depuis la version Harmony 411 uniquement

 

Liste des modules et des dll :

  • yopenxml.dhop : module diva de liaison avec la dll divalto open xml

  • DhdivaltoOpenXML.dll : dll qui contient les fonctionnalités de lecture et d'écriture des cellules excel

  • DocumentFormat.OpenXml.dll : dll qui contiens les fonctionnalités de lecture et d'écritures des fichiers excel .xlsx à travers des flux xml

  • WindowsBase.dll : dll qui contient des fonctions de base qui sont utilisées par les 2 dll précédentes

 

Avantages

  • La lecture et l'écriture des cellules sont nettement plus rapides qu'avec les fonctions OLE Automation, d'où un gain important de performance, notamment pour les imports ou les exports volumineux,.

  • Le module YOpenXml repose sur une librairie standard fournie par Microsoft, permettant de gérer les documents Word, Excel, Powerpoint, etc.

  • Il n'est pas nécessaire d'installer Office (MS ou Open) sur le serveur pour utiliser la librairie.

  • Les fichiers générés sont lisibles aussi bien dans Excel que dans Open-Office.

  • Contrairement à YOffice, le module YOpenXml s'exécute coté serveur. Il fonctionnera correctement avec le client HTML5.

Limitations

  • La couverture fonctionnelle de YOpenXML est moins importante que celle de YOffice.

  • Les fonctions « client léger » ne sont pas implémentées et le module s'exécute uniquement côté serveur.

  • Les formules de la feuille de calcul ne sont pas réévaluées lors de l'écriture d'une cellule (contrairement à Yoffice).

  • Les fonctions génèrent des documents pour Office 2007 et les versions ultérieures.

 

Mise en oeuvre

Le module YOpenXml s'exécute coté serveur uniquement. Si l'on veut utiliser l'ERP en client léger, le programme doit gérer les transferts du fichier entre le client et le serveur.
Si l'on veut modifier un fichier Excel existant, il conviendra donc dans un premier temps de le copier sur le serveur avec un appel à LCWinUpload. A la fin du traitement, la copie retour sur le client se fait avec un LCWinDownload.


Le programme Diva doit charger la Dll avant son utilisation en appelant la fonction OpenXml_Begin.

Il doit la décharger avant de se terminer en appelant la fonction OpenXml_End.

Fonctionnalités

Fonctionnalités Excel

On appellera la fonction OpenXml_FileOpen pour charger ou pour créer un fichier xlsx puis la fonction OpenXml_FileClose pour mettre le fichier à jour et le refermer.
Les fonctionnalités disponibles

  • Ouverture ou création d'un fichier XLSX.

  • Lecture de la valeur d'une cellule.

  • Gestion des onglets (ou feuilles) : choix de l'onglet (ou feuille), création, duplication, suppression.

  • Modification de la largeur d'une colonne.

  • Ecriture d'une cellule :

    • Plusieurs formats de donnée sont supportés : texte, date, numérique, etc.

    • Définition d'un style pour le texte de la cellule : police, couleur et taille des caractères, attributs gras/souligné.

    • Définition d'une couleur de fond pour la cellule.

  • Sauvegarde du fichier après modification.

  • Récupérer le texte de la dernière erreur produite

 

Principes Excel

OpenXML ne remplace pas yoffice, il permet principalement l'écriture ou de la lecture massivement de cellules Excel.
OpenXML ne contient donc pas toutes les fonctions de yoffice mais juste les fonctions de bases pour lire et écrire des cellules et l'écriture de cellule avec un format (formatage/couleur/police).


La dll OpenXML ne permet pas l'écriture de formules et ne fait pas le recalcul de la feuille des formules, pour cela il charger le fichier dans Excel, il est donc conseiller après avoir écrit des cellules et fermer le fichier xlsx:

  • d'ouvrir yoffice

  • de charger le fichier xlsx dans Excel avec les fonctions de yoffice, Excel va alors mettre à jour les résultats des cellules car dans OpenXML, si on modifie une cellule, alors on positionne une information dans le fichier xlsx qui indique a Excel qu'il faut refaire le calcul des formules.

  • puis de sauvegarder la feuille xlsx avec yoffice.

 


Seuls les fichiers Excel avec l'extension xlsx sont utilisables par OpenXML.
Ce sont des fichiers qui contiennent la description des feuilles et des cellules du tableau sous forme de flux XML et ensuite ces flux XML sont zipper pour en faire un seul fichier xlsx
La dll dé-zippe le fichier xlsx pour lire et modifier les flux XML du fichier.
Pour charger et décharger la dll il faut commencer et finir le programme diva par l'appel aux fonctions OpenXml_Begin() et OpenXml_End().
Puis appelé la fonction OpenXml_FileOpen(fic,creation) pour charger ou pour créer un fichier xlsx puis la fonction OpenXml_FileClose() permet de mettre a jour le fichier et de le fermer.


Lorsque le fichier est ouvert on peut :

  • se positionner sur une feuille avec la fonction OpenXml_GotoSheet(feuille,creation)

  • lire des cellules avec OpenXml_Read(lig,col)
    -définir la taille des colonnes avec OpenXml_ColumnWidth(colonne,taille)
    -connaitre la taille de la feuille Excel avec OpenXml_GetSizeSheet puis OpenXml_GetStartRow / OpenXml_GetEndRow / OpenXml_GetStartColumn / OpenXml_GetEndColumn

  • créer une police avec la fonction OpenXml_CreateFont(gras, taille, indexcouleur, nom, italique, soulignee, barree)

  • écrire des cellules avec OpenXml_WriteFormat(lig, col, valeur, form, decim, multi, zero, indexcouleurfond)
    Et enfin la fonction OpenXml_GetMsgError permet de récupérer le texte de la dernière erreur

Fonctionnalités Word

On appellera la fonction OpenXmlWord_OpenFile pour charger ou OpenXmlWord_CreateFile pour créer un fichier docx puis la fonction OpenXmlWord_CloseFile pour mettre le fichier à jour et le refermer.
Les fonctionnalités disponibles

  • Ouverture ou création d'un fichier DOCX.

  • Création de paragraphes

  • Insertion de texte ou fichiers

  • Remplacement

  • Modification de propriétés

Liste des fonctions de OpenXML pour Excel

Voir la page dédiée Open XML pour les fichiers XLSX
ainsi que les exemples Exemples OpenXml - Excel

Liste des fonctions de OpenXML pour Word

Voir la page dédiée Open XML pour les fichiers DOCX

ainsi que les exemples Exemples Open XML - Word