FR 3. Propriétés et formules

Chaque instance possède un ensemble de propriétés qui vont permettre de définir sa représentation dans le formulaire hôte. Dans ce chapitre, nous allons passer en revue les différentes propriétés existantes accessibles par une formule faisant office de Setter mais également de Getter si on ne leur passe aucun paramètre. Toutes les formules pourront être appelées au premier niveau de l’objet.

Propriétés de la barre de progression linéaire

Zone de progression

Propriétés liées à la zone de progression se trouvant au deuxième niveau de l’objet : MyBar.progressArea

Formule	Description
PBBGColor -> string Par défaut : none Paramètre : * Couleur de fond (string)	Couleur de fond de l’arrière-plan.
PBBorderColor -> string Par défaut : #3276DC Paramètre : * Couleur de bordure (string)	Couleur de la bordure extérieur.
PBBorderSize -> longint Par défaut : 1 Paramètre : * Taille de bordure (longint)	Taille de la bordure extérieure.
PBCornerRadius -> longint Par défaut : 2 Paramètre : * Rayon des angles (longint)	Arrondi des angles de la bordure extérieur.
PBAreaHeight -> longint Par défaut : 20 Paramètre : * Taille en hauteur (longint)	Hauteur de la zone de progression.
PBAreaWidth -> longint Par défaut : 360 Paramètre : * Taille en largeur (longint)	Largeur de la zone de progression.

Zone SVG

Propriété liée à la zone SVG se trouvant au deuxième niveau de l’objet : MyBanner.svgArea

Formule	Description
PBWindowColor -> string Par défaut : white:0 Paramètre : * Couleur de fond (string)	Couleur de fond de la zone SVG. Il est possible de définir un taux d’opacité (%). Voir valeur par défaut

Contenu textuel

Propriétés liées au contenu textuel se trouvant au deuxième niveau de l’objet : MyBanner.text

Formule	Description
PBTextPosition -> string Par défaut : middle Paramètre : * Position du titre (string)	Position du titre par rapport à la barre de progression. Valeurs possibles : « top », « middle » et « bottom ». A noter que la taille de la police du titre s’adapte à la taillle de la barre s’il est positionné à l’intérieur (middle).
PBTitle -> string Par défaut : $value_l Paramètre : * Label du titre (string)	Label du titre. Deux « placeholder » sont disponible pour afficher la valeur actuelle de la barre de progression. Placeholders : - Valeur en longint : $value_l - Valeur en réel : $value_r

Barre de progression

Propriétés liées à la barre se trouvant au deuxième niveau de l’objet : MyBanner.bar

Formule	Description
PBBarColor -> string Par défaut : #3B88FD:80 Paramètre : * Couleur de la barre (string)	Couleur de la barre de progression. Il est possible de définir un taux d’opacité (%). Voir valeur par défaut.
PBBarOffset -> real Par défaut : 1.5 Paramètre : * Taille du padding (real)	Padding entre la bordure extérieure et la barre de progression.
PBPictFormObjName -> string Par défaut : chaîne vide Paramètre : * Nom de l'objet de formulaire (string)	Nom de l’objet de formulaire de type image accueillant la barre de progression.
PBBarSpeed -> real Par défaut : 1 Paramètre : * Vitesse d'animation (real)	La vitesse représente des tics. Cela correspond au temps de transition entre chaque pourcent lors de l’animation.

Pourcentage et format du texte

Propriétés liées au pourcentage et format du texte se trouvant au deuxième niveau de l’objet : MyBanner.percent

Formule	Description
PBActivateAnimation -> boolean Par défaut : False Paramètre : * Activation des animations (boolean)	Activation/désactivation des effets d’animations sur les transitions entre l’ancienne et la nouvelle valeur.
PBDisplayText -> boolean Par défaut : True Paramètre : * Afficher/Cacher le texte (boolean)	Afficher/Cacher le titre.
PBFontColor -> string Par défaut : black Paramètre : * Couleur de la police (string)	Couleur de la police.
PBFontName -> string Par défaut : Helvetica,Arial Paramètre : * Nom de police (string)	Nom de la police appliqué aux éléments textuels.
PBFontSize -> longint Par défaut : 12 Paramètre : * Taille de police (longint)	Taille de la police appliquée aux éléments textuels.
PBFontStyle -> string Par défaut : bold Paramètre : * Style du texte (string)	Style appliqué aux éléments textuels. Les valeurs suivantes sont acceptées : - Bold - Italic - Strikethrough - Underline
PBPercentValue -> real Par défaut : 0 Paramètre : * Valeur courante (real)	Valeur courante de la barre de progression. La valeur peut se situer de 0 à 100.

Propriétés de la barre de progression circulaire

Taille du cercle

Propriété liée à la taille du cercle se trouvant au deuxième niveau de l’objet : MyBar.cpb

Formule	Description
CPBExternalRadius -> longint Par défaut : 100 Paramètre : * Rayon de la barre (longint)	Taille du rayon de la barre de progression en pixels
CPBRadiusAutoSize -> boolean Par défaut : True Paramètre : * Activer le calcul automatique (boolean)	Permet d’activer le calcul automatique de la taille du rayon en fonction de la taille de l’objet de formulaire associé à l’instance. La plus petite valeur entre la largeur et la longueur de l’objet de formulaire est utilisée.

Arrière-plan de la barre

Propriétés liées à la d’arrière-plan de la barre se trouvant au troisième niveau de l’objet : MyBanner.cpb.bgBar

Formule	Description
CPBBackgroundColor -> string Par défaut : lightgray Paramètre : * Couleur de l'arrière-plan (string)	Couleur de fond de l’arrière-plan de la barre de progression.
CPBBackgroundFillColor -> string Par défaut : none Paramètre : * Couleur du centre (string)	Couleur de fond de l'intérieur de la barre de progression.
CPBBackgroundWidth -> longint Par défaut : 16 Paramètre : * Largeur de l'arrière-plan (longint)	Largeur de l’arrière-plan de la barre

Barre de progression

Propriétés liées à la barre de progression se trouvant au troisième niveau de l’objet : MyBanner.cpb.bar

Formule	Description
CPBBarColor -> string Par défaut : #3B88FD:80 Paramètre : * Couleur de la barre (string)	Couleur de la barre de progression. Il est possible de définir un taux d’opacité (%). Voir valeur par défaut.
CPBBarLinecap -> string Par défaut : butt Paramètre : * Forme des côtés (string)	Forme des extrémités de la barre de progression. Valeurs possibles : - butt - round - square
CPBPictFormObjName -> string Par défaut : chaîne vide Paramètre : * Nom de l'objet de formulaire (string)	Nom de l’objet de formulaire de type image accueillant la barre de progression.
CPBBarSpeed -> real Par défaut : 1 Paramètre : * Vitesse d'animation (real)	La vitesse représente des ticks. Cela correspond au temps de transition entre chaque pourcent lors de l’animation.
CPBBarWidth -> longint Par défaut : 12 Paramètre : * Largeur de la barre (string)	Largeur de la barre de progression.

Contenu textuel

Propriétés liées aux contenus textuelles se trouvant au troisième niveau de l’objet : MyBanner.cpb.text

Formule	Description
CPBSubTitle -> string Par défaut : % Paramètre : * Label du sous-titre (string)	Label du sous-titre. Deux « placeholder » sont disponible pour afficher la valeur actuelle de la barre de progression Placeholders : - Valeur en longint : $value_l - Valeur en réel : $value_r
CPBTitle -> string Par défaut : $value_l Paramètre : * Label du titre (string)	Label du titre. Il utilise les mêmes « placeholders » par rapport aux sous-titres.

Pourcentage et format du texte

Propriétés liées au pourcentage et format du texte se trouvant au troisième niveau de l’objet : MyBanner.cpb.percent

Formule	Description
CPBActivateAnimation -> boolean Par défaut : False Paramètre : * Activation des animations (boolean)	Activation/désactivation des effets d’animation sur les transitions entre l’ancienne et la nouvelle valeur.
CPBDisplayText -> boolean Par défaut : True Paramètre : * Afficher/Cacher le texte (boolean)	Afficher/Cacher le titre.
CPBFontColor -> string Par défaut : gray:80 Paramètre : * Couleur de la police (string)	Couleur de la police. Il est possible de définir un taux d’opacité (%). Voir valeur par défaut.
CPBFontName -> string Par défaut : Helvetica,Arial Paramètre : * Nom de police (string)	Nom de la police appliquée aux éléments textuels.
CPBFontSize -> longint Par défaut : 35 Paramètre : * Taille de police (longint)	Taille de la police appliquée aux éléments textuels.
CPBFontStyle -> string Par défaut : bold Paramètre : * Style du texte (string)	Style appliqué aux éléments textuels. Les valeurs suivantes sont acceptées : - Bold - Italic - Strikethrough - Underline
CPBPercentValue -> real Par défaut : 0 Paramètre : * Valeur courante (real)	Valeur courante de la barre de progression. La valeur peut se situer de 0 à 100.