| | |
| Nom de la propriété | Type manipulé | Effet |
|---|
| ActionCible | Entier | Action effectuée lors d'un clic sur le ou les champ(s) cibles de l'étape en cours. Les actions disponibles sont les suivantes : - vgaAucune : Le clic sur le ou les champs cibles est sans effet.
- vgaDéfaut (défaut) : L'action effectuée dépend du type d'effet choisi :
- si l'effet choisi correspond au Grisage des Fenêtres Inactives (GFI), l'action effectuée correspondra à la constante vgaAucune.
- si l'effet choisi correspond au halo, l'action effectuée correspondra à la constante vgaChamp.
- si aucun effet n'a été choisi, l'action effectuée correspondra à la constante vgaChamp.
- vgaChamp : Le champ fonctionne normalement. Les événements associés au champ sont exécutés. Le passage à l'étape suivante doit être fait par programmation.
- vgaChampPuisEtapeSuivante : Le champ fonctionne normalement. A la fin de l'exécution du code du champ, la visite guidée passe automatiquement à l'étape suivante.
Cette action est opérationnelle uniquement sur les champs suivants : Bouton, Interrupteur, Sélecteur et Option de menu. Pour les autres champs, seul le passage à l'étape suivante sera effectué. - vgaEtapeSuivante : Le clic sur le champ permet uniquement de passer à l'étape suivante.
- vgaFin : Le clic sur le champ termine toute la visite guidée.
Cette propriété peut être surchargée par étape. |
| ActionHorsCible | Entier | Action effectuée lors d'un clic sur des champs différents des champs cibles de l'étape en cours. Les actions disponibles sont les suivantes : - vgaAucune : Le clic sur le ou les champs cibles est sans effet.
- vgaDéfaut (défaut) : L'action effectuée dépend du type d'effet choisi :
- si l'effet choisi correspond au Grisage des Fenêtres Inactives (GFI), l'action effectuée correspondra à la constante vgaAucune.
- si l'effet choisi correspond au halo, l'action effectuée correspondra à la constante vgaChamp.
- si aucun effet n'a été choisi, l'action effectuée correspondra à la constante vgaChamp.
- vgaChamp : Le champ fonctionne normalement. Les événements associés au champ sont exécutés. Le passage à l'étape suivante doit être fait par programmation.
- vgaChampPuisEtapeSuivante : Le champ fonctionne normalement. A la fin de l'exécution du code du champ, la visite guidée passe automatiquement à l'étape suivante.
Cette action est opérationnelle uniquement sur les champs suivants : Bouton, Interrupteur, Sélecteur et Option de menu. Pour les autres champs, seul le passage à l'étape suivante sera effectué. - vgaEtapeSuivante : Le clic sur le champ permet uniquement de passer à l'étape suivante.
- vgaFin : Le clic sur le champ termine toute la visite guidée.
Cette propriété peut être surchargée par étape. |
| Bulle | | Paramètres d'affichage de la bulle d'aide affichée pour l'étape en cours. Chacune des sous propriétés peut être surchargée par étape. |
| Bulle.ActionAutorisée | | Actions autorisées dans la bulle d'aide. L'interface de la fenêtre interne par défaut sera adaptée en fonction des options choisies.
Cette propriété et ses sous propriétés sont ignorées si le mode de la bulle d'aide correspond à la constante vgModeTransparent. |
| Bulle.ActionAutorisée.EtapePrécédente | Booléen | - Vrai (par défaut) pour autoriser le passage à l'étape précédente,
- Faux dans le cas contraire.
|
| Bulle.ActionAutorisée.EtapeSuivante | Booléen | - Vrai (par défaut) pour autoriser le passage à l'étape suivante,
- Faux dans le cas contraire.
|
| Bulle.ActionAutorisée.FinVisite | Booléen | - Vrai (par défaut) pour autoriser à terminer la visite,
- Faux dans le cas contraire.
|
| Bulle.Couleur | Entier | Couleur des textes de la bulle (titre et description) Valeur par défaut : - si la propriété Bulle.Mode correspond à la constante vgModeOpaque, la couleur sera 0x000000,
- si la propriété Bulle.Mode correspond à la constante vgModeTransparent, la couleur par défaut sera 0xFFFFFF.
|
| Bulle.CouleurCadre | Entier | Couleur du cadre de la bulle. Valeur par défaut : 0xFF3B85FA |
| Bulle.CouleurFond | Entier | Couleur de fond de la bulle. Cette propriété est ignorée si la propriété Bulle.Mode correspond à la constante vgModeTransparent. Valeur par défaut : 0xFFFFFF |
| Bulle.FenêtreInterne | Chaîne de caractères | Nom de la fenêtre interne du projet à utiliser pour personnaliser l'affichage dans la bulle.
Si cette propriété correspond à chaîne vide (""), la fenêtre par défaut fournie par le moteur d'exécution WINDEV / WINDEV Mobile est utilisée. |
| Bulle.Marge | Entier | Marge en pixels entre les bords de la bulle et son contenu (fenêtre interne). Valeur par défaut : 15 |
| Bulle.Markdown | Booléen | - Vrai si les champs de la fenêtre interne utilisés pour afficher le titre et la description de l'étape sont affichés au format Markdown,
- Faux dans le cas contraire.
|
| Bulle.Mode | Constante de type Entier | Mode d'affichage de la bulle : - vgModeOpaque (par défaut) : la bulle est affichée dans une fenêtre popup avec une flèche qui pointe sur le ou les champs cible. Avec la fenêtre interne par défaut, des boutons permettent de passer à l'étape suivante/précédente ou de terminer la visite.
- vgModeTransparent : la bulle est affichée avec un fond transparent à côté du ou des champs cible. Dans ce mode aucune interaction n'est possible avec les champs de la fenêtre interne. Dans ce mode, il est conseillé d'utiliser l'effet GFI (constante vgtGFI utilisée avec la propriété Effet.Type).
|
| Bulle.PageInterne | Chaîne de caractères | Nom de la page interne du projet à utiliser pour personnaliser l'affichage dans la bulle.
Si cette propriété correspond à chaîne vide (""), la page par défaut fournie par le moteur d'exécution WEBDEV est utilisée. |
| DuréeValidationAutomatique | Durée | Délai en secondes avant la validation automatique des étapes de la visite. A la fin de ce délai, la visite passe automatiquement à l'étape suivante.
Si le délai est de 0, aucun validation automatique n'est effectuée.
Par défaut, cette propriété vaut 0. |
| Effet | | Effet d'affichage à utiliser pour mettre en évidence le ou les champ(s) cible(s) pour toutes les étapes de la visite. Chacune des sous propriétés peut être surchargée par étape. |
| Effet.Agrandissement | Entier | Pourcentage d’agrandissement du halo. Par défaut, cette propriété correspond à 100%. Cette propriété est ignorée pour les autres effets. |
| Effet.Arrondi | Entier | Rayon en pixels de l'arrondi à appliquer pour les coins du rectangle lorsque la forme de l'effet est un rectangle (constante vgfRectangle). Par défaut, cette propriété correspond à 5. |
| Effet.Couleur | Entier | Couleur de l'effet GFI ou halo. Par défaut : - si l'effet correspond au GFI, la couleur correspond à 0x0C0C0C,
- si l'effet correspond au halo, la couleur correspond à 0xCCBFE9.
|
| Effet.DuréeAnimation | Entier | Durée de l'animation de l'effet en millisecondes. Par défaut : - si l'effet correspond au GFI, la durée de l'animation est 300,
- si l'effet correspond au halo, la durée de l'animation est 1000.
|
| Effet.Forme | Entier | Forme à utiliser pour le "trou" (effet GFI) ou pour le halo (effet Halo) : - vgfCercle : cercle,
- vgfRectangle : rectangle (avec bord arrondi selon la valeur de la propriété Effet.Arrondi).
|
| Effet.Marge | Entier | Marge en pixels entre les contours de la forme choisie (propriété Forme) et les bords du ou des champs cibles. Par défaut, cette marge vaut 10 pixels. |
| Effet.Opacité | Entier | Opacité de la couleur de l'effet (pourcentage). Par défaut, pour l'effet GFI, cette propriété correspond à 70%, et pour l'effet halo, cette propriété correspond à 100%. |
| Effet.Type | Constante de type Entier | Type d'effet : - vgtAucun : aucun effet d'affichage
- vgtGFI : grise le contenu de la fenêtre hôte en laissant apparaitre un trou de la forme choisie par la propriété Forme autour du ou des champ(s) cible(s).
- vgtHalo (valeur par défaut) : affiche un halo de la forme choisie par la propriété Forme autour du ou des champ(s) cible(s).
|
| Étape | Tableau de VisiteGuidéeEtape | |
| Identifiant | Chaîne de caractères | Identifiant de la visite utilisé pour la persistance.
Cette propriété doit être spécifiée et son contenu doit être unique pour le projet/l'application en cours. Cet identifiant est notamment utilisé avec la fonction VisiteGuidéeInfo. Il est par exemple possible de ne plus afficher la visite guidée si l'utilisateur l'a déjà vue. Exemple : SI VisiteGuidéeInfo(VisiteDécouverte.Identifiant, ...
vgInfoOccurrence) = 0 ALORS
VisiteGuidéeDémarre(VisiteDécouverte)
FIN
|
| Initialisation | Procédure WLangage | Procédure WLangage exécutée au lancement de la visite guidée. Si cette procédure renvoie Faux, la visite guidée est arrêtée. |
| Terminaison | Procédure WLangage | Procédure WLangage exécutée à la fin de la visite guidée. |
| Version | Entier | Numéro de version de la visite guidée. Par défaut, cette propriété vaut 1.
Cette propriété doit être incrémentée par le développeur selon les nouveautés à montrer dans la visite guidée.Ce numéro de version peut notamment être utilisé avec la fonction VisiteGuidéeInfo. Il est par exemple possible d'afficher la visite guidée si des nouveautés sont disponibles. Exemple :
VisiteNouveauté est un VisiteGuidée
VisiteNouveauté.Identifiant = "Nouveauté de la version"
VisiteNouveauté.Version = 29
SI VisiteGuidéeInfo(VisiteNouveauté, vgInfoVersion) < 29 ALORS
VisiteNouveauté.Étape[1].Cible = SAI_Prénom
VisiteNouveauté.Étape[1].Titre = "Nouveau !"
VisiteNouveauté.Étape[1].Description = ...
"Vous pouvez maintenant saisir votre prénom"
VisiteGuidéeDémarre(VisiteNouveauté)
FIN
|