Visual Basic 6.0 et le format XML

C'est un langage qui permet de décrire une classe d'objets « documents xml ». Au sein de ces documents, le XML impose une structure aux données de façon lisible dans un simple format texte. Le XML utilise le principe bien connu de balises, mais celles-ci sont propres au créateur du document et non pas standardisées comme pour du HTML. Il est donc évidemment impératif de bien choisir ses balises pour la bonne compréhension de la structure du document. Un exemple est bien plus parlant :

<?xml version="1.0" encoding="ISO-8859-1" ?> 
<developpez>
   <membre fonction="Responsable Visual Basic">
      <nom>Cécile Muno</nom>
      <pseudo>khany</pseudo>
      <activite>
         <date-inscription>20/10/2002</date-inscription>
         <nbmsg>1721</nbmsg>
         <nbtutoriel>4</nbtutoriel>
     </activite>
   </membre> 
   <membre>
      <nom/>
      <pseudo>jpdar</pseudo>
      <activite>
         <date-inscription>29/12/2005</date-inscription>
         <nbmsg>14</nbmsg>
         <nbtutoriel>0</nbtutoriel>
      </activite>
   </membre> 
   <membre fonction="admin">
      <nom>Cédric Chatelain</nom>
      <pseudo>cchatelain</pseudo>
      <activite>
         <date-inscription>26/05/2002</date-inscription>
         <nbmsg>2840</nbmsg>
         <nbtutoriel>10</nbtutoriel>
      </activite>
   </membre> 
</developpez>

Pour ceux qui n'auraient pas ou peu eu l'occasion de côtoyer le format XML, voici un survol très rapide du vocabulaire lié à cette norme. Pour plus de précisions, rendez-vous sur le forum XML.

Un document XML est reconnaissable par :

• les éléments de balisage : un « élément » est composé d'une balise ouvrante, de la balise fermante associée et de tout ce qui se trouve entre ces balises ;
• une balise ouvrante peut aussi contenir un ou plusieurs « attributs » ;
• les nœuds : essence même du document XML, ils modélisent tous les éléments et le document lui-même est modélisé par le nœud « / » appelé « racine du document XML ».

En reprenant notre exemple précédent, nous pouvons donc dire :

<!---Balises ouvrantes/fermantes--->
<developpez>  </developpez>

<!---Attributs : fonction dans la balise membre--->
<membre fonction="Responsable Visual Basic">
</membre>

<!---Eléments--->
   <membre>
      <nom/>
      <pseudo>...</pseudo>
      <nbmsg>...</nbmsg>
   </membre>

Et pour vous donner une idée de l'agencement des nœuds, voici une partie de la représentation de l'arbre XML associé à cet exemple :

Il ne sert à rien d'aller plus loin dans le détail des normes XML, vous trouverez tout ce qui vous intéresse sur le forum XML ainsi qu'en lisant les tutoriels XML de developpez.com.

Il en existe beaucoup et son utilisation dépend exclusivement du type d'application que vous devez écrire, mais, sachez que cette norme peut être invariablement utilisée pour les raisons suivantes :

• la facilité de lecture d'un document XML par qui que ce soit ;
• le nombre sans cesse croissant des applications qui utilisent et optimisent cette norme ;
• la simplicité d'utilisation sur Intranet/Extranet ;
• la rapidité de création d'une structure XML ;
• l'aisance d'exploitation via le code de ce type de document ;
• l'inutilité d'une formation pour encoder des données sous un tel format ;
• importation et exportation de données à partir et vers de multiples applications ;
• …

Comme pour tout composant non référencé à la base dans Visual Basic 6, il faut évidemment cocher les bonnes références avant de pouvoir utiliser la norme XML. Au fil du temps, cette norme a poursuivi son évolution dans les systèmes d'exploitation, il existe donc plusieurs références. Dans ce petit projet, j'ai choisi Microsoft XML 3.0, car elle est installée automatiquement avec Internet Explorer 6 et vous n'aurez ainsi aucun problème pour exécuter ce programme.

Comme vous avez pu le constater sur l'image représentant l'arbre de notre document XML, le principe d'élaboration est basé sur des niveaux de balises. Bien visualiser la logique de cette cascade de nœuds est essentiel pour développer le code d'exploitation. En effet, le principe sera toujours le même, quelle que soit la manipulation à effectuer sur le document : il faudra progresser logiquement dans les nœuds, niveau par niveau. Vous ne pouvez en effet pas atteindre directement un nœud de niveau 3 sans avoir référencé les nœuds de niveau supérieur au préalable.

Dans l'exemple de document que nous allons exploiter, voici un schéma pour vous expliquer plus simplement les niveaux de nœuds :

Les puristes de la norme XML n'aimeront peut-être pas ce genre de « nivelage », mais il est bien plus facile de s'y retrouver dans la programmation en ayant bien en vue le nombre de nœuds à définir pour progresser dans le document. Aidé par l'arbre XML, il sera dès lors simple de placer vos « définitions ».
Par exemple :

Dim oDvpDOMDocument As MSXML2.IXMLDOMDocument
Dim oNoeudMembre As MSXML2.IXMLDOMElement                ' élément membre
Dim oNoeudEnfantMembre As MSXML2.IXMLDOMElement          ' élément fils de oNoeudMembre
Dim oNoeudEnfantMembreActivite As MSXML2.IXMLDOMElement  ' élément fils de oNoeudEnfantMembre

Ceci est évidemment un exemple, car, parfois, il n'est pas utile de déclarer tous les nœuds enfants, on peut passer d'un nœud de même niveau à un autre nœud de même niveau sans déclarer les nœuds enfants.

Cette liste est réduite à sa plus simple expression aussi bien pour les éléments existants que pour les méthodes et propriétés associées.

II-C-1. MSXML2.DOMDocument▲

Set oNoeudMembre = oDvpDOMDocument.createElement("membre")

II-C-2. MSXML2.IXMLDOMElement▲

II-C-3. MSXML2.IXMLDOMNode▲

II-C-4. MSXML2.IXMLDOMNodeList▲

Dim oListeNoeuds As MSXML2.IXMLDOMNodeList
Dim oNoeud As MSXML2.IXMLDOMNode

For Each oNoeud In oListeNoeuds
 ......
Next

Ce petit tour d'horizon est bien trop rapide pour vous faire plonger dans toutes les possibilités des méthodes et propriétés de l'objet XML.
Pour vous familiariser avec leur utilisation, je vous propose quelques petits codes tout simples, juste pour bien comprendre la logique d'exploitation d'un document XML.

Il faut juste attirer l'attention sur le fait qu'il existe deux manières de charger un document XML : synchrone ou asynchrone.
Par défaut, le fichier est chargé de manière asynchrone. Il faut spécifier :

oDvpDOMDocument.async = False

pour charger tout le document en mémoire. Ce sera le cas dans les exemples associés au tutoriel vu que le fichier est en local et très petit.

Le document sera chargé pour chaque action choisie dans l'exemple afin de ne pas vous obliger un ordre d'exécution précis des exemples fournis.
Vous pouvez donc choisir n'importe quelle action de l'application en exemple pour voir le code d'ouverture et de chargement d'un document XML.

Le principe de la recherche consiste à parcourir les nœuds à partir de la racine, soit en cherchant une balise précise, soit en cherchant un attribut.

Il faut donc bien veiller à définir les « elements », « nodes », « nodelist » dont on peut avoir besoin. Évidemment, dans l'exemple c'est assez simple puisque l'on connait la structure du document et le nom des balises.
La programmation est moins aisée s'il faut partir d'un document XML dont on ne connait pas la structure. Ce n'est pas le but dans cette introduction.
L'exemple joint recherche un pseudo précis.

Dans notre exemple, cela consiste à ajouter un nouveau membre dans le XML des membres de developpez.com.
L'ajout concerne se fait toujours en signalant à la racine du document XML que l'on va créer un nouvel élément.
Dès que vous avez compris cela, trouver le code est relativement simple sachant que la procédure est la même pour chaque niveau de création d'une balise.

La mise à jour d'une donnée reste basée sur le même principe que la recherche à la seule différence que l'on modifie la donnée contenue dans la balise ciblée. On procède alors en modifiant la propriété Text, ce qui est une chose assez aisée à réaliser.

Très similaire à l'ajout de données sauf qu'il faut créer le document en y plaçant l'entête propre à ce type de document ainsi que l'extension ad hoc.

Un simple exemple de la gestion des erreurs via « parseError ».

En quelques points, voici comment procéder.

• Se baser sur l'exemple joint à ce tutoriel en y ajoutant une feuille portant votre nom/pseudo.
• Se baser sur le document XML utilisé. Vous pouvez le modifier suivant vos besoins, mais, dans ce cas, faites-en une copie et appelez-la « dvp-xxxx.xml » où « xxx » est votre nom/pseudo.
• Lancez l'exécution de votre feuille à partir de la feuille Sélection en y ayant placé un nouveau bouton avec un titre explicite.
• Commentez clairement votre code sans user d'abréviations.

Il est bien évident que les codes seuls ne peuvent pas renseigner sur ce que vous avez voulu réaliser. Une explication substantielle est donc nécessaire en accompagnement.
Veuillez respecter ces quelques consignes dans vos explications :

• précisez sur quel système d'exploitation vous travaillez ainsi que tout autre renseignement qui pourrait affecter l'exécution du code ;
• décrivez précisément quelles références sont nécessaires et prenez la peine éventuellement de faire une capture d'écran pour montrer la(es) référence(s) cochées ;
• en début de vos explications, faites un résumé succinct du but de votre code ;
• soyez clair et précis dans le texte explicatif, évitez les abréviations et le style sms ;
• tapez le texte dans un traitement de texte d'utilisation courante voire même dans le bloc-note, cela est largement suffisant. La mise en page n'est pas nécessaire (sauf si vous désirez chapitrer le texte), elle sera de toute façon adaptée au format actuel du tutoriel.

Afin d'intégrer votre proposition à ce tutoriel, il est nécessaire que je reçoive, sous forme de fichiers « ZIP » :

• le programme d'exemple initial complété par votre(vos) feuille(s) et zippé dans un fichier nommé « xml.zip » ;
• votre fichier d'explications zippé dans un fichier nommé « expl-xxx.zip » où « xxx » est votre nom/pseudo ;
• éventuellement un fichier zippé contenant vos images sous le nom « images-xxx.zip » où xxx est votre nom/pseudo ;
• prévenez-moi par MP pour me signaler votre participation. Envoyez-moi les zip sur mon mail rédaction ou donnez-moi un lien Internet où les télécharger. (Vous pouvez regrouper les différents *.zip dans un seul zip portant votre nom/pseudo) ;
• toute communication concernant votre proposition avant ou après réalisation se fera exclusivement par MP.

Je me charge de l'intégration de vos commentaires et du programme modifié dans ce tutoriel en référençant, bien entendu, que vous en êtes l'auteur exclusif. Les sources publiées sont toujours libres de droits, mais le texte associé est protégé au même titre que tous les tutoriels publiés sur développez.

Je précise aussi que l'intégration de votre code est soumise à l'approbation de l'équipe Visual Basic quant à sa nécessité, la manière de coder, la pertinence des commentaires et explications ainsi que la facilité d'exécution. Il est évident que nous vous tiendrons au courant des remarques éventuelles afin de faire évoluer positivement votre proposition et aboutir à son intégration.

• Votre code doit répondre à une utilisation générale assez courante et être complet quant à la solution proposée.
• Ne seront acceptés que les codes proprement indentés et commentés.
• Ne seront acceptés que les codes accompagnés d'un fichier d'explications claires et complètes.
• Le code doit être testé et fonctionnel sous une installation standard de Visual Basic 6.0.
• L'acceptation ou le refus d'un code est du ressort de l'ensemble de l'équipe Visual Basic. Il ne sera pris en compte aucune demande de renseignements, réclamation, question ou quelconque correspondance qui ne serait pas rédigée suivant les règles de developpez.com (sms, orthographe, politesse…).

À vos codes et bon travail !