PC SOFT

DOCUMENTATION EN LIGNE
DE WINDEV, WEBDEV ET WINDEV MOBILE

  • Présentation
  • Développer un composant externe
  • Remarque
  • Créer un composant externe
  • Options avancées du composant externe
  • Modifier les options avancées du composant
  • Droits d'accès du composant sur les éléments de l'application utilisant le composant
  • Style : Mode de gestion des gabarits sur les éléments du composant.
  • Générer un composant externe
  • Générer un composant externe existant
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Autres
Procédures stockées
Présentation
La création d'un composant externe doit être effectuée à partir d'un projet contenant tous les éléments nécessaires au fonctionnement du composant. Il est donc conseillé d'utiliser un projet spécifique pour créer chaque composant externe.
La création d'un composant externe se fait en plusieurs étapes :
  1. Développement des éléments du composant externe.
  2. Création 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.
Remarque : A partir de la version 19, HFSQL est le nouveau nom de HyperFileSQL.
Développer un composant externe
Le développement d'un composant externe se fait à partir d'un projet WINDEV, WEBDEV ou WINDEV Mobile. Il est conseillé d'utiliser un projet spécifique pour développer chaque composant externe.
Voici quelques points importants à prendre en compte lors du développement des différents éléments du composant externe :
  1. Commentaires du code
    Lors du développement des éléments du composant externe, n'oubliez pas d'insérer des commentaires dans votre code. En effet, ces commentaires constitueront la documentation de votre composant. C'est à partir de ces commentaires que les utilisateurs de vos composants pourront les utiliser. Pour plus de détails, consultez Documentation automatique des composants.
    Si ces commentaires ne sont pas présents dans votre code, 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.
    Par exemple :
    Description des paramètres d'entrée/sortie de 'Fenêtre1' :
    Paramètres :
    Param1 : < indiquez ici le rôle de Param1 >
    Valeur de retour :
    Aucune
  2. Déclaration des éléments et visibilité
    Selon le mode de déclaration des éléments (classes, procédures, collections de procédures), les éléments seront plus ou moins accessibles par l'utilisateur du composant externe. Pour plus de détails, consultez Visibilité d'un élément d'un composant externe.
    Remarque : Si un composant externe utilise une analyse et des fichiers de données, par défaut, les fonctions HFSQL manipuleront ces éléments dans un contexte HFSQL indépendant. Ce fonctionnement peut être modifié dans les options avancées du composant.
  3. Pour exécuter depuis le composant externe, une procédure du projet accueillant le composant externe, utilisez la fonction ExécuteTraitement avec la constante trtProcédureProjet.

Remarque

Un composant externe peut comporter des classes dans son interface. Il est possible de dériver ces classes dans le projet hôte, de surcharger les méthodes virtuelles, de faire du polymorphisme. L'héritage entre plusieurs niveaux de composants externes est disponible.
Créer un composant externe
Pour créer un composant externe :
  1. Sélectionnez l'option "Atelier .. Composant Externe .. Définir un nouveau composant à partir de ce projet". L'assistant de création du composant externe se lance.
    Remarque : Si vous n'avez pas créé de configuration de projet spécifique à la création d'un composant externe, l'assistant de création d'une configuration de projet se lance. Pour optimiser l'organisation de vos projets, il est conseillé d'utiliser les configurations de projet. Pour plus de détails, consultez Configuration de projet.
    Dans ce cas, l'assistant demande :
    • le nom et la description de la configuration de projet.
    • les options de compatibilité de la configuration :
      • Multi-produit : Le composant externe sera généré uniquement pour un type de projet spécifique ou pour une utilisation dans tous les produits (WINDEV, WEBDEV et WINDEV Mobile).
      • Plate-forme : Il est possible d'activer ou non les erreurs de compilation pour la compatibilité 64 bits ou Linux.
    • les éléments intégrés dans la configuration de projet.
  2. L'assistant de génération d'un composant externe se lance ensuite.
  3. Dans l'assistant de création du composant externe :
    • Indiquez le nom du composant externe et son libellé.
    • Sélectionnez les éléments du projet en cours nécessaires au fonctionnement du composant externe.
    • Pour chaque élément du composant externe, indiquez si cet élément doit être accessible depuis le projet utilisant le composant externe. Si l'élément est accessible, le développeur (du projet utilisant le composant externe) pourra utiliser l'élément comme tout autre élément de son projet. Pour plus de détails sur les éléments à rendre visibles ou non, consultez Visibilité d'un élément d'un composant externe.
  4. Validez. Le composant externe est créé. Pour le distribuer, il est nécessaire de le générer.
    Il est possible de générer immédiatement le composant externe. Cette option est conseillée si tous les éléments du composant externe ont été développés, testés et sont prêts à être distribués.
Pour créer un composant externe :
  1. Créez une configuration de projet pour le composant externe : sous le volet "Projet", dans le groupe "Configuration de projet", déroulez "Nouvelle configuration" et sélectionnez "Composant externe (.WDK)". L'assistant de création d'une configuration de projet se lance et demande :
    • le nom et la description de la configuration de projet.
    • les options de compatibilité de la configuration :
      • Multi-produit : Le composant externe sera généré uniquement pour un type de projet spécifique ou pour une utilisation dans tous les produits (WINDEV, WEBDEV et WINDEV Mobile).
      • Plate-forme : Il est possible d'activer ou non les erreurs de compilation pour la compatibilité 64 bits ou Linux.
    • les éléments intégrés dans la configuration de projet.
  2. Développez le composant externe.
Pour le distribuer, il est nécessaire de le générer. Pour plus de détails, consultez le paragraphe Générer un composant externe.
Options avancées du composant externe
Les options avancées du composant externe permettent de définir :
  • les droits d'accès du composant sur les éléments de l'application utilisant le composant.
  • le mode de gestion des gabarits sur les éléments du composant.

Modifier les options avancées du composant

Pour modifier les options avancées du composant :
  1. Sélectionnez l'option "Atelier .. Composant Externe .. Liste des composants générés à partir de ce projet".Sous le volet "Projet", dans le groupe "Projet", déroulez "Liste des éléments" et sélectionnez "Liste des composants générés".
  2. Sélectionnez le composant.
  3. Cliquez sur le bouton "Options...".

Droits d'accès du composant sur les éléments de l'application utilisant le composant

Trois possibilités :
  • le composant et son application hôte utilisent des contextes indépendants (option par défaut) :
    Le composant ne pourra manipuler ni les fichiers de données, ni les éléments du projet hôte.
    Versions 15 et supérieures
    Il est également possible de définir le contexte d'exécution du composant dans le projet hôte. Le contexte d'exécution peut être :
    • global. Dans ce cas, le même contexte sera utilisé si le composant externe est chargé par le projet et par un autre composant externe du projet.
    • isolé (par défaut). Dans ce cas, si le même composant est chargé par le projet et par un composant du projet, chaque composant utilisera un contexte spécifique.
    Nouveauté 15
    Il est également possible de définir le contexte d'exécution du composant dans le projet hôte. Le contexte d'exécution peut être :
    • global. Dans ce cas, le même contexte sera utilisé si le composant externe est chargé par le projet et par un autre composant externe du projet.
    • isolé (par défaut). Dans ce cas, si le même composant est chargé par le projet et par un composant du projet, chaque composant utilisera un contexte spécifique.
    Il est également possible de définir le contexte d'exécution du composant dans le projet hôte. Le contexte d'exécution peut être :
    • global. Dans ce cas, le même contexte sera utilisé si le composant externe est chargé par le projet et par un autre composant externe du projet.
    • isolé (par défaut). Dans ce cas, si le même composant est chargé par le projet et par un composant du projet, chaque composant utilisera un contexte spécifique.
  • le composant est autorisé à manipuler uniquement les fichiers de données de l'application hôte. Dans ce cas, les contextes HFSQL seront identiques.
  • le composant est autorisé à manipuler les fichiers de données de l'application hôte ainsi que ses éléments (fenêtres, états, ...). Dans ce cas, les contextes d'exécution seront identiques.
Quand autoriser le composant à manipuler les fichiers de données de l'application hôte ?
Par exemple, si l'application livrée est constituée d'une application principale et d'options fournies sous forme de composants. Dans ce cas, les composants manipulent les fichiers de données de l'application principale.
Remarque : Si le composant est autorisé à manipuler les fichiers de données et possède sa propre analyse, l'analyse du composant sera ignorée. Le composant utilisera l'analyse du projet hôte.
Dans notre exemple, lors du développement d'un composant, ce composant peut être associé à l'analyse de l'application principale. Ainsi, l'utilisation des déclarations externes pour manipuler les fichiers de données est inutile. De plus, la complétion sera automatique sous l'éditeur de code.
Pour plus de détails sur les contextes HFSQL, consultez Contexte HFSQL.

Style : Mode de gestion des gabarits sur les éléments du composant.

Par défaut, il est possible d'appliquer le gabarit du projet hôte sur les différents éléments du composant externe. Pour plus de détails sur les gabarits, consultez Gabarit.
Remarques :
  • L'onglet "Style" des options du composant externe permet d'autoriser ou non l'application du gabarit par le projet client.
  • Versions 23 et supérieures
    Pour ne pas appliquer le gabarit du projet client sur une fenêtre du composant externe :
    1. Affichez la fenêtre de description de la fenêtre du composant.
    2. Dans l'onglet "Style", cochez l'option "Conserver toujours le style/gabarit d'origine".
    3. Validez.
    Nouveauté 23
    Pour ne pas appliquer le gabarit du projet client sur une fenêtre du composant externe :
    1. Affichez la fenêtre de description de la fenêtre du composant.
    2. Dans l'onglet "Style", cochez l'option "Conserver toujours le style/gabarit d'origine".
    3. Validez.
    Pour ne pas appliquer le gabarit du projet client sur une fenêtre du composant externe :
    1. Affichez la fenêtre de description de la fenêtre du composant.
    2. Dans l'onglet "Style", cochez l'option "Conserver toujours le style/gabarit d'origine".
    3. Validez.
Générer un composant externe
Un composant externe ne peut être distribué et réutilisé que s'il a été généré. La génération du composant externe permet de créer les fichiers nécessaires à la distribution du composant externe.
Cette génération peut être effectuée :
  • directement lors de la création du composant externe.
  • à tout moment :
    • soit par l'option "Atelier .. Composant Externe .. Générer un composant",
    • soit depuis la liste des composants présents dans le projet (option "Atelier .. Composant Externe .. Liste des composants générés à partir de ce projet").
Cette génération peut être effectuée à tout moment :
  • soit depuis la configuration de projet du composant :
    • sous le volet "Projet", dans le groupe "Génération", cliquez sur "Générer".
    • dans les boutons d'accès rapide, cliquez sur l'icône de génération du composant :
  • soit depuis la liste des composants présents dans le projet : Sous le volet "Projet", dans le groupe "Projet", déroulez "Liste des éléments" et sélectionnez "Liste des composants générés". Sélectionnez le composant et cliquez sur "Générer".
Remarque : Si le composant externe a été modifié, il est nécessaire de le re-générer avant de le distribuer à nouveau. Pour plus de détails, consultez Modifier un composant externe.

Générer un composant externe existant

Pour générer un composant externe existant :
  1. Sélectionnez l'option "Atelier .. Composant Externe .. Générer un composant".Affichez la configuration de projet du composant, puis sous le volet "Projet", dans le groupe "Génération", cliquez sur "Générer".
  2. L'assistant de génération du composant externe se lance.
  3. Sélectionnez si nécessaire le nom du composant externe à générer.
  4. Sélectionnez les éléments du projet en cours nécessaires au fonctionnement du composant externe.
  5. Pour chaque élément du composant externe, indiquez si cet élément doit être accessible depuis le projet utilisant le composant externe. Si l'élément est accessible, le développeur (du projet utilisant le composant externe) pourra utiliser l'élément comme tout autre élément de son projet. Pour plus de détails, consultez Visibilité d'un élément d'un composant externe.
  6. Indiquez si le composant externe peut être traduit lors de son utilisation. Si l'option "Autoriser la traduction du composant" est cochée, sélectionnez les différents éléments du composant externe qui pourront être traduits. Les éléments cochés dans cette liste pourront être traduits, les éléments non cochés ne seront pas proposés pour la traduction.
    Pour plus de détails, consultez Traduction d'un composant externe.
  7. Choisissez les langues gérées par le projet à intégrer dans votre composant externe. Plus le nombre de langues gérées par le composant externe sera faible, plus la taille du composant externe sera petite.
  8. Si des composants sont présents dans le projet, il est possible d'intégrer ces composants dans le composant qui est en cours de génération (cas de composants imbriqués par exemple).
  9. Indiquez si un changement du numéro de version du composant externe est nécessaire (cas d'une modification d'un composant externe). Pour plus de détails sur la gestion des différentes versions d'un composant externe, consultez Modifier un composant externe.
  10. Indiquez si nécessaire les informations du composant externe : Propriétaire, libellé, copyright, ... Ces informations seront visibles :
    • lors de l'intégration du composant externe dans un projet WINDEV ou WEBDEV.
      Ces informations sont également affichées dans la description du composant externe, accessible depuis le volet "Assistants, Exemples et Composants" (option "Description" du menu contextuel du composant).
    • dans les propriétés du fichier WDI et WDK sous l'explorateur Windows (onglet "PC SOFT").
  11. Sélectionnez l'image du composant externe. Cette image sera utilisée aussi bien sous l'explorateur Windows que dans le volet "Assistants, Exemples et Composants".
    Rappel : Les différents composants présents sur le poste en cours sont accessibles depuis le volet "Assistants, Exemples et Composants" (option "Composants"). Pour plus de détails, consultez Gestion des composants depuis le volet "Assistants, Exemples et Composants".
    Sélectionnez l'image du composant externe. Cette image sera utilisée sous l'explorateur Windows.
  12. Saisissez la présentation générale du composant externe.
    Cette présentation générale sera automatiquement affichée sous WINDEV lors du survol du composant externe présent dans le volet "Assistants, Exemples et Composants".
    Rappel : Les différents composants présents sur le poste en cours sont accessibles depuis le volet "Assistants, Exemples et Composants" (option "Composants"). Pour plus de détails, consultez Gestion des composants depuis le volet "Assistants, Exemples et Composants".
    Saisissez la présentation générale du composant externe.
    Cette présentation générale sera automatiquement intégrée à la description du composant externe.
  13. L'assistant de génération présente automatiquement la documentation technique associée au composant externe.
    Pour plus de détails sur les règles de création des commentaires, consultez Documentation automatique des composants.
  14. Indiquez si un système d'aide (au format CHM) doit être généré. Ce système d'aide sera copié à côté du composant. Ce système d'aide contient toute la documentation technique du composant externe.
  15. Indiquez si la saisie de MCU (Macro-Code Utilisateur) est autorisée. Pour plus de détails, consultez Gestion des macro-codes utilisateur.
  16. Indiquez si le composant externe doit :
    • Être publié dans un répertoire du GDS. Cette option permet de mettre simplement le composant externe à disposition des projets du GDS. Pour plus de détails, consultez composant externe et GDS.
    • Être enregistré dans le centre de ré-utilisabilité. Dans ce cas, il pourra être mis simplement à la disposition d'autres développeurs (utilisant ou non le GDS).
  17. Indiquez le nom physique du composant externe. Ce nom sera attribué aux fichiers correspondant au composant externe.
  18. Validez. Le composant externe est généré.
Les fichiers suivants sont créés dans le répertoire EXE du projet en cours :Les fichiers suivants sont créés dans le répertoire de génération de la configuration de projet :
<NomComposant>.WDKCe fichier contient tous les éléments à redistribuer (fenêtres, états, ...).
Ce fichier est nécessaire lors du déploiement des applications utilisant le composant externe.
<NomComposant>.WDIInterface du composant externe. Ce fichier contient :
  • une aide pour l'utilisation du composant externe lors de sa réintégration.
  • les éléments à l'utilisation du composant externe dans le projet (information de compilation, ...).
Attention : La génération du composant externe peut être relativement longue si le composant externe contient beaucoup d'éléments accessibles.
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire