DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

  • Présentation
  • Définition
  • De quoi est constitué un composant externe ?
  • Que contient un composant externe ?
  • Créer et générer un composant externe
  • Distribuer un composant externe
  • Présentation
  • Utilisation directe du composant
  • Distribution simple d'un composant
  • Distribution grâce à une procédure d'installation
  • Utiliser un composant externe dans une application
  • Déploiement d'une application utilisant un composant externe
  • Présentation
  • Mise à jour des composants et des exécutables déployés
  • Modifier un composant externe
  • Présentation
  • Les différents types de compatibilité
  • Caractéristiques avancées d'un composant
  • Documentation automatique
  • Visibilité d'un élément d'un composant
  • Le fichier WDO
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadWidget IOSApple WatchMac CatalystUniversal Windows 10 App
Autres
Procédures stockées
13. Composant externe en pratique
Page précédenteSommairePage suivante
Présentation

Définition

Un composant externe est un ensemble d'éléments WINDEV, WEBDEV ou WINDEV Mobile : fenêtres, pages, états, analyse, etc. Cet ensemble d'éléments effectue une fonctionnalité précise. Par exemple, un composant peut correspondre à une des fonctionnalités suivantes :
  • Envoi de fax,
  • Envoi d'emails,
  • ...
Remarques :
  • Pour optimiser l'organisation de vos projets, il est possible d'utiliser des composants internes. Pour plus de détails, consultez Composant interne en pratique.
  • Dans la suite de ce chapitre, le terme "composant" signifie "composant externe".
Un composant externe peut être redistribué à d'autres développeurs WINDEV, WEBDEV ou WINDEV Mobile (gratuitement ou non). Ces développeurs pourront ainsi intégrer simplement la fonctionnalité proposée par le composant dans leur application (ou leur site). Le composant sera donc intégré à l'application (ou site), et distribué avec l'application (ou site).
Lors de la création du composant externe, l'auteur spécifie :
  • les éléments du composant visibles ou non par l'utilisateur du composant. Les éléments visibles seront accessibles via le volet "Explorateur de projet" ou par programmation.
  • le mode d'utilisation du composant (comment utiliser le composant, les paramètres permettant d'accéder aux fonctionnalités du composant, etc.). Une documentation succincte (à compléter) est automatiquement générée et associée au composant.
WINDEV Remarque : Des composants exemples sont livrés en standard avec WINDEV. Ces composants sont accessibles depuis le volet "Projet" de l'éditeur : sous le volet "Projet", dans le groupe "Projet", déroulez "Importer" et sélectionnez l'option "Un composant Externe .. Composant utilitaire ou exemple". Les projets correspondants peuvent être ouverts depuis la page d'accueil de WINDEV (Ctrl + <).

De quoi est constitué un composant externe ?

Un composant externe peut être :
  • défini et généré à partir d'un projet WINDEV, WEBDEV ou WINDEV Mobile existant. Une configuration de projet de type "Composant" permettra de sélectionner les éléments du projet existant à intégrer dans le composant.
  • créé à partir d'un projet de type "Composant externe". Ce projet est constitué par défaut d'une plateforme de type "Composant externe" qui contiendra les éléments nécessaires à la création et à la génération du composant.
Ce composant externe peut être ensuite intégré dans d'autres projets WINDEV, WEBDEV, WINDEV Mobile.
Tous les éléments du composant sont totalement indépendants du projet dans lequel le composant est intégré. Le composant externe peut avoir sa propre analyse, ses fenêtres, ses états, ses fichiers, etc.
Lors de la génération du composant externe, il suffit d'indiquer si ces éléments seront accessibles ou non par le projet intégrant ce composant. Les éléments non accessibles ne seront ni visibles ni manipulables par le projet qui importera ce composant.
Le composant externe est constitué de plusieurs fichiers :
<Nom du composant>.WDKFichier composant. Contient tous les éléments du composant externe.
Ce fichier est nécessaire à l'intégration du composant externe dans un projet.
Ce fichier doit également être livré dans la version cliente de l'application utilisant le composant externe.
<Nom du composant>.WDIDescription du composant (uniquement pour le développement d'applications).
Ce fichier est nécessaire à l'intégration du composant externe dans un projet.
Ce fichier ne doit pas être livré dans la version cliente de l'application utilisant le composant externe.
<Nom du composant>.WDZFichier des dépendances du WDK (uniquement pour les composants WEBDEV et WINDEV Mobile)
Fichier contenant les dépendances du fichier WDK. Ces informations sont extraites dans le projet dans lequel le composant est intégré.
  • Dans le cas d'un composant WEBDEV, ce fichier contient par exemple les pages WEBDEV générées, les images, etc.
  • Dans le cas d'un composant Mobile (iOS ou Android), ce fichier contient par exemple les fichiers de génération Android, etc.
<Nom du composant>.WDOFichier optionnel
Fichier au format texte contenant la liste des différents éléments livrés en plus avec le composant externe (fichiers de données, fichiers .INI, etc.). Ce fichier peut être créé manuellement ou généré automatiquement à partir des éléments spécifiés dans le dossier "Autres" du volet "Explorateur de projet". Pour plus de détails, consultez Le fichier WDO.

Que contient un composant externe ?

Un composant externe contient :
  • les différents éléments à redistribuer (fenêtres, états, etc.). Ces éléments peuvent être accessibles ou non lors de l'importation du composant dans un projet WINDEV, WEBDEV ou WINDEV Mobile. Ces éléments ne peuvent pas être modifiés à partir du projet utilisant le composant.
  • une brève description du composant.
  • une aide permettant de réutiliser ce composant. Cette aide est générée à partir des commentaires de code.
Remarque : Par défaut, si un composant externe utilise une analyse et des fichiers de données, les fonctions HFSQL manipuleront ces éléments dans un contexte HFSQL indépendant. Ces paramètres peuvent être modifiés dans les options avancées du composant. Pour plus de détails, consultez Options avancées d'un composant externe.
Créer et générer un composant externe
La création d'un composant externe se fait en plusieurs étapes :
  1. Création du composant externe.
  2. Développement des éléments du composant externe.
  3. Définition des options avancées du composant externe.
  4. Génération du composant externe.
Le composant externe peut alors être distribué et réutilisé. Pour plus de détails, consultez Distribuer un composant externe et Utiliser un composant externe dans une application.
Distribuer un composant externe

Présentation

Lorsque le composant externe a été créé, testé et généré, il peut être mis à disposition des développeurs. Plusieurs méthodes sont possibles :
  • Utilisation directe du composant externe
    Exemple : le composant externe est directement utilisé sur le poste du développeur qui a créé le composant.
  • Distribution simple, en fournissant directement les fichiers nécessaires.
    Exemple : le composant externe est destiné à être utilisé à l'intérieur d'une même société, par plusieurs développeurs. Dans ce cas, les fichiers nécessaires peuvent être copiés sur un disque réseau.
  • Distribution par le GDS : Ce mode de distribution permet aux projets présents dans le GDS d'utiliser directement un composant externe publié dans le GDS. Pour plus de détails, consultez GDS et composants.
    Exemple : Une société partage différents projets par le GDS. Les projets permettant de créer les composants externes et les projets utilisant les composants utilisent tous le même GDS.
  • Distribution à partir d'un programme d'installation (avec une procédure d'installation du composant identique à celle utilisée pour les applications).
    Exemple : Ce mode de distribution est conseillé si le composant externe est destiné à être vendu ou à être distribué à grande échelle, avec des mises à jour régulières.

Utilisation directe du composant

Le composant externe est créé et utilisé sur le même poste.
Lors de l'importation du composant externe dans un projet, il suffit de sélectionner le fichier WDI correspondant au composant. Ce fichier est disponible dans le répertoire EXE du projet du composant.
Le répertoire de génération correspond au répertoire associé à la configuration de projet de type "Composant externe".
Attention : Les fichiers référencés dans le fichier <Nom du composant>.WDO seront automatiquement recopiés dans le répertoire EXE du projet utilisant le composant.
Si le composant externe utilise des fichiers spécifiques (fichiers de données, fichiers texte, etc.), il est nécessaire de créer (ou de compléter) un fichier <Nom du composant>.WDO après la génération du composant. Ce fichier contient la liste des fichiers externes (fichiers de données, fichiers texte, ...) utilisés par le composant. Pour plus de détails, consultez Fichier WDO.

Distribution simple d'un composant

La distribution simple d'un composant externe consiste à fournir uniquement les fichiers nécessaires au fonctionnement du composant par simple copie. Les fichiers sont copiés dans un répertoire spécifique. Ce répertoire peut par exemple être présent sur un serveur réseau.
Lors de l'importation du composant externe dans un projet, il suffit de sélectionner le fichier WDI correspondant au composant dans le répertoire de distribution.
Pour distribuer un composant externe, il est nécessaire de fournir :
  • Les fichiers automatiquement générés par WINDEV ou WEBDEV (fichier <Nom du composant>.WDK et fichier <Nom du composant>.WDI)
  • Si nécessaire, les fichiers spécifiques manipulés par le composant (fichiers de données, fichiers d'initialisation, ...) ainsi que le fichier <Nom du composant>.WDO. Le fichier texte <Nom du composant>.WDO contient la liste des fichiers qui doivent être fournis avec le composant. Pour plus de détails sur ce fichier, consultez Diffusion de composant avancé : le fichier WDO.

Distribution grâce à une procédure d'installation

La diffusion des composants externes à l'aide d'une procédure d'installation consiste à fournir aux utilisateurs du composant externe, un programme d'installation. Ce programme installe tous les fichiers nécessaires à l'utilisation du composant externe dans le répertoire spécifié par l'utilisateur.
Ce mode d'installation permet de gérer automatiquement :
  • le fichier WDO et l'installation des fichiers spécifiques (fichiers de données, ...) utilisés par le composant externe.
  • l'installation d'outils spécifiques (MDAC, driver ODBC pour HFSQL, ...).
  • la mise à jour automatique des fichiers de données utilisés par le composant externe (si nécessaire).
  • la désinstallation du composant externe.
Pour proposer une procédure d'installation pour un composant externe :
  1. Créez la procédure d'installation du composant externe directement par les boutons d'accès rapide :
  2. Dans les différents écrans de l'assistant, spécifiez :
    • le nom du composant externe.
    • les langues proposées dans la procédure d'installation.
    • le titre de la fenêtre principale du programme d'installation. Le bouton "Avancé" permet de configurer l'interface de l'installeur.
    • les fichiers installés. Il est possible d'ajouter des fichiers spécifiques aux fichiers correspondant par défaut au composant. Le fichier WDO sera automatiquement créé à partir de cette liste.
    • le répertoire d'installation par défaut du composant. Le bouton "Avancé" permet de configurer les modifications qui doivent être apportées au système.
    • les modules optionnels à installer.
    • le support d'installation, les options de sécurité et les paramètres avancés.
    • ...
Par défaut, les fichiers nécessaires à l'installation d'un composant externe sont créés dans le sous-répertoire "<Nom projet>\EXE\INSTALL_COMPO<Nom du composant>".
Rappel : Lors de la création de l'installation d'une application, les fichiers nécessaires sont créés dans le sous-répertoire "<Nom projet>\EXE\INSTALL".
Utiliser un composant externe dans une application
Un composant peut être ré-utilisé à tout moment dans n'importe quelle application WINDEV : il suffit de connaître le répertoire des fichiers du composant et de l'importer dans le projet. L'importation du composant peut également se faire via le GDS.
Lorsqu'une nouvelle version d'un composant est disponible, il suffit d'installer les nouveaux fichiers de cette mise à jour dans le répertoire d'installation du composant (selon le mode d'installation utilisé). Pour plus de détails sur les différents modes d'installation d'un composant, consultez Distribuer un composant externe.
Si le composant a été publié et importé via le GDS, les mises à jour sont proposées à l'ouverture du projet utilisant le composant.
La création de l'exécutable (utilisant le composant) se fait de la même manière que pour une application classique WINDEV. Les DLLs nécessaires au fonctionnement du composant sont automatiquement détectées.
Déploiement d'une application utilisant un composant externe

Présentation

Le déploiement d'une application utilisant un ou plusieurs composants se fait de la même façon que le déploiement d'une application classique (option "Procédure d'installation" sous le volet "Projet").
Lors du déploiement d'une application utilisant un composant, les fichiers suivants sont automatiquement installés sur le poste de l'utilisateur :
  • <Nom du composant>.WDK,
  • <Nom de l'application>.EXE,
  • les fichiers nécessaires au fonctionnement du composant et de l'application.

Mise à jour des composants et des exécutables déployés

Lors de la mise à jour d'un composant et/ou d'un exécutable déployé, il est possible d'installer sur le poste de l'utilisateur final :
  • soit l'exécutable de l'application, le composant et les fichiers nécessaires à leur fonctionnement.
  • soit uniquement l'exécutable de l'application et les fichiers nécessaires au fonctionnement de l'application.
  • soit uniquement le composant et les éventuels fichiers nécessaires à son fonctionnement.
Pour plus de détails sur la gestion de la compatibilité entre l'application et son composant, consultez Compatibilité Composant externe et application déployée.
Pour mettre à jour un composant en clientèle, deux possibilités existent :
  1. La recompilation du projet hôte
    Recompilez le projet qui utilise le composant et redistribuez l'application avec le composant. Dans ce cas, aucun problème de version ou de compatibilité ne sera rencontré. La recompilation est nécessaire dans les cas suivants :
    • De nouvelles fonctions ont été ajoutées dans le composant et doivent être prises en compte.
    • Les paramètres de certaines procédures ont été modifiés.
    • Incompatibilité de la nouvelle version avec les anciennes versions du composant.
    • ...
  2. Distribution directe du fichier .WDK
    Fournissez directement une mise à jour du composant (fichier .WDK) en clientèle sans recompilation du projet.
    Cette possibilité s'applique en général lorsque :
    • La nouvelle version sert à corriger un ou des dysfonctionnements d'une version antérieure.
    • De nouvelles fonctions ont été ajoutées dans le composant mais ne sont pas nécessaires au bon fonctionnement de l'application.
Modifier un composant externe

Présentation

A tout moment, un composant créé et généré peut être modifié. Cette modification peut correspondre :
  • soit à l'ajout d'éléments dans le composant.
  • soit à la suppression d'éléments du composant.
  • soit à la modification des droits sur les éléments du composant.
  • soit à la modification d'un des éléments du composant.
Dans tous les cas, après cette modification, le composant doit être re-généré pour prendre en compte les modifications effectuées.

Les différents types de compatibilité

La gestion de la compatibilité est liée aux versions d'un composant. En effet, si des modifications ont été apportées au composant, les applications qui utilisent le composant en déploiement peuvent rencontrer des problèmes d'exécution si elles ne sont pas en phase avec ce composant.
La gestion de la compatibilité est une étape importante dans la modification d'un composant. Il existe 2 types de compatibilité :
  • la compatibilité descendante : la version du composant utilisée (fichier .WDK) pour compiler les applications utilisant ce composant doit être toujours supérieure ou égale à la version actuellement utilisée en déploiement.
    Cette compatibilité est automatiquement gérée. Si le composant installé avec l'application est d'une version inférieure à celle utilisée par l'application, l'application refusera de fonctionner.
  • la compatibilité ascendante : l'utilisation d'une nouvelle version d'un composant avec les projets compilés avec une ancienne version peut être interdite. Il est donc nécessaire de recompiler les projets pour utiliser correctement la nouvelle version du composant.
Caractéristiques avancées d'un composant

Documentation automatique

Un composant externe doit absolument être accompagné d'une documentation pour permettre son utilisation.
WINDEV, WEBDEV et WINDEV Mobile simplifient la réalisation de cette documentation en proposant :
  • Une présentation générale du composant. Cette présentation générale est saisie lors de la génération du composant.
  • Une génération automatique de la documentation technique à partir des commentaires insérés dans le code des éléments du composant.
Quels sont les commentaires de code pris en compte ?
Les commentaires pris en compte automatiquement pour la documentation du composant sont :
  • Les commentaires placés en tête des procédures WLangage.
  • Les commentaires placés en tête des événements suivants :
    • Code d'initialisation des fenêtres ou des pages,
    • Code d'initialisation des états,
    • Code d'initialisation des classes,
    • Code d'initialisation des collections de procédures.
A quel moment la documentation est-elle générée ?
La documentation du composant est créée lors de la première génération du composant ( parmi les boutons d'accès rapide).
Lors de cette génération de la documentation :
  • les commentaires existants dans le code sont utilisés pour créer la documentation.
  • si aucun commentaire n'existe, les éléments accessibles du composant seront automatiquement documentés en précisant les paramètres attendus en entrée et en sortie de chaque élément. Les commentaires correspondants sont automatiquement créés dans les différents éléments.
Remarque : A chaque re-génération du composant, il est possible de re-générer la documentation associée au composant (bouton "Regénérer").

Attention : Si vous utilisez le bouton "Regénérer", les modifications de la documentation effectuées dans l'assistant de génération seront supprimées.
Comment disposer de la documentation d'un composant ?
La présentation générale du composant est automatiquement affichée dans la fenêtre de description du composant.
La documentation technique du composant est disponible :
  • lors de l'intégration d'un composant dans un projet : sous le volet "Projet", dans le groupe "Projet", déroulez "Importer" et sélectionnez "Un composant externe".
  • à tout moment, dans la description des composants intégrés dans le projet.
    Dans le volet "Explorateur de projet" :
    • Dans le dossier "Composants externes", sélectionnez le composant externe voulu.
    • Affichez le menu contextuel (clic droit) et sélectionnez l'option "Description".
    • L'onglet "Détail" permet d'obtenir le détail de la documentation générée.
La documentation spécifique à un élément du composant (fenêtre, ...) peut être obtenue :
  • soit en double-cliquant sur cet élément depuis le volet "Explorateur de projet" ou en appuyant sur la touche F2 depuis le code de cet élément.
  • soit depuis le volet "Explorateur de projet" :
    • Sélectionnez le dossier "Composants externes".
    • Affichez le menu contextuel (clic droit).
    • Sélectionnez l'option "Liste des composants externes importés dans le projet".

Visibilité d'un élément d'un composant

Lors de la création d'un composant, il est possible de définir les éléments du composant qui seront accessibles ou non par l'utilisateur du composant.
  • Si l'élément est accessible, l'utilisateur du composant verra cet élément dans la liste des éléments du projet. Il pourra manipuler ces éléments par programmation (comme s'il s'agissait d'un élément créé dans le projet).
    Remarque : Le code de cet élément n'est cependant pas visible.
  • Si l'élément n'est pas accessible, l'utilisateur ne saura même pas que cet élément existe.
Attention : Selon le mode de déclaration des éléments du projet (classe, collection de procédures, etc.), les éléments accessibles ou non peuvent varier.

Le fichier WDO

Lors de la génération du composant externe, plusieurs fichiers sont automatiquement créés dans le répertoire EXE du projet en cours :
<Nom du composant>.WDKContient tous les éléments WINDEV à redistribuer (fenêtres, états, etc.) avec le composant.
<Nom du composant>.WDIInterface du composant. Ce fichier contient :
  • une aide pour l'utilisation du composant lors de sa réintégration,
  • les éléments nécessaires à l'utilisation du composant dans le projet (information de compilation, etc.).
<Nom du composant>.WDZFichier des dépendances du WDK (uniquement pour les composants WEBDEV et WINDEV Mobile)
Fichier contenant les dépendances du fichier WDK. Ces informations sont extraites dans le projet dans lequel le composant est intégré.
  • Dans le cas d'un composant WEBDEV, ce fichier contient par exemple les pages WEBDEV générées, les images, etc.
  • Dans le cas d'un composant Mobile (iOS ou Android), ce fichier contient par exemple les fichiers de génération Android.

Lors de la diffusion du composant externe, ces fichiers doivent être redistribués.
Si le composant externe utilise des éléments supplémentaires (fichiers de données par exemple), il est nécessaire d'ajouter dans le répertoire EXE du projet :
  • un fichier <Nom du composant>.WDO : Ce fichier contient la liste des fichiers externes (fichiers de données, fichiers texte, etc.) utilisés par le composant externe. Ces fichiers doivent être livrés et installés avec le composant externe.
  • les fichiers devant être redistribués avec le composant externe. Ces fichiers peuvent être placés selon une sous arborescence spécifique. Dans ce cas, le code du composant externe doit gérer l'accès à ces fichiers selon cette même arborescence.
Qu'est-ce que le fichier WDO ?
Le fichier <Nom du composant>.WDO est un fichier au format TXT, pouvant être créé et modifié à tout moment. Ce fichier peut par exemple être créé et modifié avec l'éditeur de texte standard de Windows, NotePad.
Ce fichier contient la liste des fichiers externes (fichiers de données, fichiers texte, etc.) utilisés par le composant externe et devant être livrés et installés avec le composant externe. Ces fichiers doivent être recopiés dans le répertoire EXE des projets utilisant le composant externe.
Ce fichier ".WDO" peut contenir :
  • soit le nom complet du fichier.
    Par exemple : C:\ComposantsWD\ComposantSélecteur\EtatInitial.INI
  • soit le nom du fichier. Ce fichier sera recherché dans le répertoire en cours du composant externe.
    Par exemple : EtatInitial.INI
  • soit un nom de fichier utilisant un chemin relatif. Les syntaxes possibles sont :
    - Répertoire\NomFichier.xxx pour indiquer un sous-répertoire du répertoire en cours.
    - .\NomFichier.xx pour indiquer le répertoire en cours.
    - .\NomFichier.xx pour indiquer le répertoire parent.
    Par exemple : \ComposantSélecteur\EtatInitial.INI
Ce fichier sera utilisé lors de l'intégration du composant externe dans le projet. Les chemins précisés dans le WDO doivent correspondre aux chemins où les fichiers sont installés sur le poste de développement du composant externe.
Lors de l'intégration du composant externe, l'arborescence spécifiée dans le WDO sera conservée et reproduite dans le répertoire EXE du projet. Pour plus de détails, consultez Utiliser un composant externe dans une application.
Exemple : Le composant "Code Postal" utilise un fichier de données "Cedex" (fichiers Cedex.fic et Cedex.ndx). Dans le projet de création du composant, ce fichier de données est présent dans le répertoire EXE du projet.
Pour que le composant soit livré et installé avec le fichier de données, il faut créer le fichier WDO dans le répertoire EXE du projet de création du composant. Ce fichier doit contenir les lignes suivantes :
.\CEDEX.Fic
.\CEDEX.NDX
Diffusion d'un composant avec WDO
Pour diffuser un composant utilisant un fichier WDO, il est nécessaire de fournir :
  • le fichier WDK (si nécessaire)
  • le fichier WDI
  • le fichier WDO
  • tous les fichiers nécessaires référencés dans le fichier WDO.
Page précédenteSommairePage suivante
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire