DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

Aide / Développer une application ou un site / Composant / Composant Externe
  • Présentation
  • Intégrer le composant dans le projet
  • Intégrer un composant dans un projet
  • Fichiers automatiquement copiés lors de l'intégration du composant dans un projet
  • Manipuler les éléments d'un composant par programmation
  • Remarque : la documentation technique du composant
  • Conflits de noms
  • Utiliser une procédure d'un composant en compilation dynamique
  • Classes et composants
  • Mise à jour d'un composant
  • Déploiement d'une application utilisant un composant
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
Présentation
Un composant externe peut être réutilisé à tout moment dans n'importe quelle application : il suffit de connaître le répertoire des fichiers du composant externe.
Cette page d'aide présente comment :
Intégrer le composant dans le projet

Intégrer un composant dans un projet

Pour intégrer un composant dans un projet :
  1. Ouvrez le projet sous WINDEV, WEBDEV ou WINDEV Mobile.
  2. Sous le volet "Projet", dans le groupe "Projet", déroulez "Importer" et sélectionnez "Un composant externe .. A partir d'un fichier". Un sélecteur de fichiers s'ouvre.
  3. Sélectionnez le fichier WDI du composant à importer. Selon le mode de diffusion choisi, ce fichier peut être présent :
    • soit dans le répertoire de création du composant si le poste de création et d'utilisation du composant sont identiques,
    • soit dans le répertoire où les fichiers du composant ont été mis à disposition,
    • soit dans le répertoire où la procédure d'installation du composant a copié les fichiers du composant.
      Pour plus de détails, consultez Distribuer un composant.
  4. Validez. La fenêtre de description du composant sélectionné apparaît. Cette fenêtre présente :
    • la description du composant (société, version, ...).
      Il est possible de choisir le mode de chargement du composant (au lancement du projet ou à la première utilisation d'un élément du composant). Par défaut, le composant est chargé à la première utilisation d'un élément du composant.
    • la documentation du composant. Cette documentation permet de savoir comment utiliser les différents éléments du composant.
  5. Validez. Les différents éléments accessibles et utilisables du composant apparaissent dans le volet "Explorateur du projet". Une icône spécifique indique que l'élément provient d'un composant.

Fichiers automatiquement copiés lors de l'intégration du composant dans un projet

Lors de l'intégration du composant dans le projet, tous les fichiers nécessaires au composant sont automatiquement copiés dans le répertoire du projet :
  • Le fichier <Nom du composant>.WDI est copié dans le répertoire du projet.
  • Le fichier <Nom du composant>.WDK est copié dans le sous-répertoire EXE du projet.
  • Si des fichiers ont été spécifiés dans le fichier optionnel <Nom du composant>.WDO, ces fichiers sont recopiés dans le répertoire EXE du projet (en respectant l'arborescence précisée dans le fichier WDO).
Manipuler les éléments d'un composant par programmation
Les éléments visibles d'un composant intégré dans un projet peuvent être manipulés uniquement par programmation.
Pour manipuler un élément du composant (fenêtre, ...) par programmation, il suffit de manipuler l'élément comme s'il s'agissait d'un élément créé dans le projet.
  1. Consultez la documentation de l'élément.
    Pour cela, effectuez une des manipulations suivantes :
    • double-cliquez sur l'élément depuis le volet "Explorateur du projet".
    • appuyez sur la touche F2 depuis le code de l'élément.
  2. La documentation de l'élément apparaît sous l'éditeur de code. Cette documentation présente les paramètres nécessaires à l'utilisation de l'élément (paramètres attendus en entrée ou en sortie, ...).
  3. Utilisez l'élément selon les informations précisées dans la documentation comme si cet élément appartenait au projet.
    • Pour ouvrir une fenêtre, utilisez par exemple la fonction Ouvre en passant si nécessaire les paramètres attendus par cette fenêtre.
      Ouvre(FenêtreDuComposant [, Param1, Param2])
    • Pour imprimer un état, utilisez la fonction iImprimeEtat en passant si nécessaire les paramètres attendus par cet état.
      iImprimeEtat(EtatComposant [, Param1, Param2])
    • Pour appeler une procédure, utilisez la syntaxe habituelle.
      ProcédureDuComposant(Param1,Param2)
    • Pour utiliser une classe, déclarez une variable du type de la classe.
      MaVariable est un objet ClasseDuComposant

      La variable s'utilise par la suite comme une variable objet normale.
En cas de conflit avec un élément du projet, il suffit de préfixer le nom de l'élément par le nom du composant. Par exemple :
Ouvre(MonComposant.MaFenêtre)
Pour utiliser le nom de l'élément dans une variable, il est nécessaire de préciser le nom du composant. Par exemple :
sFenêtre est une chaîne = "MonComposant.MaFenêtre"
Ouvre(sFenêtre)
Aucune fonction WLangage spécifique à la manipulation du composant n'est nécessaire.

Remarque : la documentation technique 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 .. A partir d'un fichier".
  • à tout moment, dans la description des composants intégrés dans le projet :
    • Sous le volet "Explorateur de projet", sélectionnez le dossier "Composants externes".
    • Affichez le menu contextuel et sélectionnez "Liste des composants externes importés dans le projet".
    • Le bouton [Description] permet d'obtenir les informations et la documentation du composant.

Conflits de noms

Attention : si un élément de votre projet et un élément du composant ont le même nom, pour utiliser l'élément du composant, il est nécessaire de préfixer cet élément par le nom du composant.
Par exemple, la fenêtre "Menu" est disponible dans le projet en cours et dans le composant "Email" utilisé par le projet. Pour ouvrir la fenêtre "Menu" du composant "Email", il est nécessaire d'utiliser la syntaxe suivante :
Ouvre("Email.Menu")

Utiliser une procédure d'un composant en compilation dynamique

Pour utiliser une procédure d'un composant en compilation dynamique :
  1. Il est nécessaire que le composant soit chargé. Le composant peut être défini comme "Chargé au lancement de l'application" ou chargé grâce à la fonction ComposantCharge.
  2. Il est nécessaire d'utiliser le nom complet pour désigner la procédure et de faire suivre ce nom de parenthèses pour indiquer qu'une procédure doit être utilisée (et non une variable globale) :
    NomComposant.NomCollection.NomProcédure()

    Remarque : Il est également possible d'utiliser la fonction Exécute :
    Exécute("NomComposant.NomCollection.NomProcédure")

Classes et composants

Un composant 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 est disponible.
Mise à jour d'un composant
  • Lorsque 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.
  • Lors de l'ouverture du projet utilisant ce composant, le changement de version du composant sera automatiquement détecté et une mise à jour du projet sera proposée. Il est conseillé de recompiler le projet.
    Remarque : Il est possible de forcer la mise à jour d'un composant depuis la liste des composants présents dans le projet :
    • Sous le volet "Explorateur de projet", sélectionnez le dossier "Composants externes".
    • Affichez le menu contextuel et sélectionnez "Liste des composants externes importés dans le projet".
    • Cliquez sur bouton "Mise à jour".
  • Si le composant a été distribué avec une application WINDEV, il est nécessaire de mettre le composant à jour. Pour plus de détails, consultez Déploiement d'une application utilisant un composant.
Déploiement d'une application utilisant un composant
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.
Pour plus de détails sur le déploiement d'une application utilisant un ou plusieurs composants, consultez Déploiement d'une application utilisant un composant.
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 31/08/2022

Signaler une erreur ou faire une suggestion | Aide en ligne locale