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 ficheirs fichiers word au format docx (attention, c’est uniquement du format docx)

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

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.

...

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éd 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).

...

• 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.

...

• 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
  

Liste des fonctions de OpenXML

...

char OpenXml_GetMsgError*
Renvoi le texte de la dernière erreur

...

int OpenXml_Begin*
Chargement de la dll DhdivaltoOpenXML.dll et initialisation de la dll
Renvoi
0 si pas d'erreur
1 si la dll n'existe pas
2 si une fonction n'existe pas, par exemple si la dll est une ancienne version
3 si erreur d'initialisation

...

int OpenXml_End*
Fin de l'utilisation de la dll DhdivaltoOpenXML
Renvoi toujours 0

...

int OpenXml_FileOpen(fic,creation)*
Chargement d'un fichier xlsx
Paramètres
1 fic A ;nom du fichier xlsx avec son chemin
1 creation X = 0 ;0=ne pas créer le fichier s'il n'existe pas 1=créer le fichier s'il n'existe pas
Renvoi
0 si pas d'erreur
1 si erreur

...

int OpenXml_FileClose*
Fermeture du fichier xlsx en cours
Renvoi
0 si pas d'erreur
1 si erreur

...

int OpenXml_ColumnWidth(colonne,taille)*
Changement de la taille d'une colonne c'est unité de mesure Excel, par défaut c'est 10
Paramètres
1 colonne N
1 taille N
Renvoi
0 si pas d'erreur

...

string OpenXml_GotoSheet(feuille,creation)*
Gestion des feuilles de calcul selon la valeur du paramètre création
Renvoi toujours le nom de la feuille en cours ou "1" si erreur
Paramètres
1 feuille Anom de la feuille
1 creation x = 0 type d'opération création et autres opérations
Renvoi
Le nom de la feuille en cours si pas d'erreur
"1" si erreur
Types d'opérations selon les cas suivant :
retour = OpenXml_GotoSheet(" " ,0)
renvoi le nom de la feuille en cours quel que soit la valeur du champ creation.
Si nom de la feuille n'est pas vide alors le champ création indique une opération
retour = OpenXml_GotoSheet("xxx" ,0)
permet d'aller sur la feuille xxx , si xxx n'existe pas alors il y aura une erreur
retour = OpenXml_GotoSheet("xxx" ,1)
permet d'aller sur la feuille xxx , si xxx n'existe pas alors on crée une feuille vide
retour = OpenXml_GotoSheet(" " ,2)
liste des feuilles séparer par des ; la liste est toujours clôturée par un dernier caractère point-virgule
retour = OpenXml_GotoSheet("xxx" ,3)
duplique la feuille en cours à la fin des feuilles et lui donne le nom xxx
Attention il faut que la feuille en cours à dupliquer soit simple car openxml ne gère pas lLes feuilles complexes avec du graphique etc.
retour = OpenXml_GotoSheet("xxx" ,4)
suprime la feuille xxx
Attention il faut que la feuille à supprimer soit simple car openxml ne gère pas les feuilles complexes avec du graphique etc.
Si la feuille à supprimer est la feuille en cours alors on va sur la première feuille, et s'il n'y a plus de feuille alors on crée une feuille vierge et on se positionne dessus.

...

char OpenXml_Read(lig,col)*
Lecture d'une cellule, renvoi le texte de la cellule , le retour peut être un type String ( type S en diva)
Les dates sont toujours au format AAAAMMJJ quel que soit le format d'affichage des dates.
Les datetimes sont toujours au format AAAAMMJJHHMMSS quel que soit le format d'affichage des datetimes.
Paramètres
1 lign ;numéro de ligne
1 coln ;numéro de colonne

...

int OpenXml_GetTypeLastRead*
Renvoi le type du contenu de la cellule qu'on vient de lire
Renvoi
0 inconnu, par défaut alpha
1 alpha
2 numérique
3 time hhmmss
4 date aaaammjj
5 date time aaaammjjhhmmss

...

Format des polices et couleur de fond des cellules

Les couleurs de fond des cellules vont de 1 à 56, ce sont les couleurs standards d'Excel.
La couleur 0 indique 'ne pas changer la couleur si la cellule existe' sinon la couleur du fond de la nouvelle cellule sera la couleur de fond par défaut des cellules Excel ( ou de la colonne si la colonne a une couleur prédéfinie)
Liste des couleurs : nota la couleur 24 est souvent utilisé pour mettre en relief une cellule.

...

Les Polices :
Pour pouvoir modifier la police par défaut qu'aura le texte de la cellule, il faut créer une description de la police dans les styles du fichier xlsx .
Il faut appeler la fonction OpenXml_CreateFont pour créer la police et elle renvoi un indice qui doit être indiqué dans la fonction OpenXml_WriteFormat
Attention cet indice n'est valide que dans le fichier xlsx en cours, c'est local au fichier xlsx.

...

...

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éd 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
  

Liste des fonctions de OpenXML

Voir la page dédiée YOpenXml new

Exemple de programme diva

...