FR 3. Propriétés et formules

Liste des propriétés

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

Nom	Type	Par défaut	Formule	Paramètres	Description
backgroundColor	string	none	PBBGColor	- Couleur de fond (string)	Couleur de fond de l’arrière-plan.
borderColor	string	#3276DC	PBBorderColor	- Couleur de bordure (string)	Couleur de la bordure extérieur.
borderSize	longint	1	PBBorderSize	- Taille de bordure (longint)	Taille de la bordure extérieure.
cornerRadius	longint	2	PBCornerRadius	- Rayon des angles (longint)	Arrondi des angles de la bordure extérieur.
Height	longint	20	PBAreaHeight	- Taille en hauteur (longint)	Hauteur de la zone de progression.
Width	longint	360	PBAreaWidth	- 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

Nom	Type	Par défaut	Formule	Paramètres	Description
windowBGColor	string	white:0	PBWindowColor	- 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

Nom	Type	Par défaut	Formule	Paramètres	Description
position	string	middle	PBTextPosition	- 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).
title	string	#$value_l	PBTitle	- 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

Nom	Type	Par défaut	Formule	Paramètres	Description
color	string	#3B88FD:80	PBBarColor	- 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.
offset	real	1.5	PBBarOffset	- Taille du padding (real)	Padding entre la bordure extérieure et la barre de progression.
pictureFormObjName	string	Chaîne vide	PBPictFormObjName	- Nom de l'objet de formulaire (string)	Nom de l’objet de formulaire de type image accueillant la barre de progression.
speed	real	1	PBBarSpeed	- 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

Nom	Type	Par défaut	Formule	Paramètres	Description
animation	boolean	False	PBActivateAnimation	- Activation des animations (boolean)	Activation/désactivation des effets d’animations sur les transitions entre l’ancienne et la nouvelle valeur.
display	boolean	True	PBDisplayText	- Afficher/Cacher le texte (boolean)	Afficher/Cacher le titre.
font.color	string	black	PBFontColor	- Couleur de la police (string)	Couleur de la police.
font.name	string	Helvetica, Arial	PBFontName	- Nom de police (string)	Nom de la police appliqué aux éléments textuels.
font.size	longint	12	PBFontSize	- Taille de police (longint)	Taille de la police appliquée aux éléments textuels.
font.style	string	bold	PBFontStyle	- Style du texte (string)	Style appliqué aux éléments textuels. Les valeurs suivantes sont acceptées : - Bold - Italic - Strikethrough - Underline
value	real	0	PBPercentValue	- 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

Nom	Type	Par défaut	Formule	Paramètres	Description
radius	longint	100	CPBExternalRadius	- Rayon de la barre (longint)	Taille du rayon de la barre de progression en pixels
autoRadiusSize	boolean	True	CPBRadiusAutoSize	- 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

Nom	Type	Par défaut	Formule	Paramètres	Description
color	string	lightgray	CPBBackgroundColor	- Couleur de l'arrière-plan (string)	Couleur de fond de l’arrière-plan de la barre de progression.
fillColor	string	none	CPBBackgroundFillColor	- Couleur du centre (string)	Couleur de fond de l'intérieur de la barre de progression.
width	longint	16	CPBBackgroundWidth	- 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

Nom	Type	Par défaut	Formule	Paramètres	Description
color	string	#3B88FD:80	CPBBarColor	- 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.
linecap	string	butt	CPBBarLinecap	- Forme des côtés (string)	Forme des extrémités de la barre de progression. Valeurs possibles : - butt - round - square
pictureFormObjName	string	empty string	CPBPictFormObjName	- Nom de l'objet de formulaire (string)	Nom de l’objet de formulaire de type image accueillant la barre de progression.
speed	real	1	CPBBarSpeed	- Vitesse d'animation (real)	La vitesse représente des ticks. Cela correspond au temps de transition entre chaque pourcent lors de l’animation.
width	longint	12	CPBBarWidth	- 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

Nom	Type	Par défaut	Formule	Paramètres	Description
subtitle	string	%	CPBSubTitle	- 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
title	string	$value_l	CPBTitle	- 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

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