FR 6. Propriétés et formules

Un BreadCrumb possède un ensemble de propriétés qui vont permettre de définir sa représentation et ses interactions avec 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 ou de Getter .

⚠️ Pour utiliser une formule en mode Getter, vous devez l'appeler sans paramètres, sauf quand le premier paramètre est une constante du composant (paramètre obligatoire)

Toutes les formules pourront être appelées au premier niveau de l’objet.

Concernant les propriétés touchant aux couleurs, vous pouvez leur passer un code couleur sous forme d'une chaîne CSS ( Exemple: "blue" ou "#0000FF" ou "rgb(0,0,255)" )

$color:="blue:80"
$color:="#0000FF:80" 
$color:="rgb(0,0,255):80"

Par défaut le facteur d'opacité appliqué aux couleurs est de 100%. Pour changer cette valeur à 80 % il suffit d'ajouter cette valeur à la chaîne définissant la couleur en la séparant par le caractère deux points". (Exemple : "blue:80)

Il est recommandé de ne pas modifier manuellement les propriétés dont les valeurs ne sont pas définies par des formules, car elles sont gérées en interne par le composant. Les propriétés liées aux sections seront traitées dans le chapitre de gestion des sections.

Global

Propriétés globales se trouvant au deuxième niveau de l’objet : MyBC.breadCrumb.global

Formule	Description
Name -> string Par défaut : chaîne vide Paramètre : * Nom de l’objet de formulaire (string)	Nom du Breadcrumb et donc de l’objet de formulaire image.
Model -> string Par défaut : arrow Paramètre : * Nom du modèle (string)	Modèle à utiliser : * simple * arrow * groupedButtons
RTL -> boolean Par défaut : False Paramètre : * Disposition des sections (boolean)	Les sections sont générées de droite à gauche (right to left)
MaxSectionToDraw -> longint Par défaut : -1 Paramètre : * Nombre maximum de sections à afficher (longint)	Nombre maximal de section à afficher. Sans limite correspond à -1 qui est la valeur par défaut. Il est possible d'afficher moins de sections que celles créées.

Boxes

Propriétés liées au conteneur se trouvant au deuxième niveau de l’objet : MyBC.breadCrumb.box

Formule	Description
BgColor -> string Par défaut : #F0EEF1 Paramètre : * Couleur de fond (string)	Couleur de l’arrière-plan. Il est possible de définir un taux d’opacité (%) (Ex: black:80 - noir avec une opacité de 80%).
IsCentered -> boolean Par défaut : False Paramètre : * Centrage automatique (boolean)	Permet de centrer le Breadcrumb par rapport à la position et la taille de l’objet image définit dans l’éditeur de formulaire. Ne s’applique que si dynamicSize est activé.
IsDynamicSize -> boolean Par défaut : True Paramètre : * Dimensionnement automatique (boolean)	Dimensionne la largeur du Breadcrumb automatiquement en fonction de la taille des sections.
BoxHeight -> longint Par défaut : -1 Paramètre : * Hauteur du conteneur (longint)	Hauteur du Breadcrumb. Si valeur -1 alors il prend comme hauteur celle définie dans l’éditeur de formulaire.
BoxWidth -> longint Par défaut : -1 Paramètre : * Largeur du conteneur (longint)	Largeur du Breadcrumb. Si valeur -1 alors il prend comme largeur celle définie dans l’éditeur de formulaire.

Box corner radius

Propriétés liées aux angles du conteneur se trouvant au troisième niveau de l’objet : MyBC. breadCrumb.box.cornerRadius

Formule	Description
CornerRadiusLeft -> longint Par défaut : 5 Paramètre : * Valeur du rayon côté gauche du conteneur (longint)	Valeur du rayon appliqué aux angles du côté gauche.
CornerRadiusRight -> longint Par défaut : 5 Paramètre : * Valeur du rayon côté droit du conteneur (longint)	Valeur du rayon appliqué aux angles du côté droit.

Box border

Propriétés liées à la bordure du conteneur se trouvant au troisième niveau de l’objet : MyBC. breadCrumb.box.border

Formule	Description
BorderColor -> string Par défaut : black Paramètre : * Couleur de la bordure (string)	Couleur de la bordure du container. Il est possible de définir un taux d’opacité (%) (Ex: black:80 - noir avec une opacité de 80%).
BorderSize -> longint Par défaut : 2 Paramètre : * Taille de la bordure (longint)	Taille de la bordure du container.

Box padding

Propriétés liées aux paddings du conteneur se trouvant au troisième niveau de l’objet : MyBC. breadCrumb.box.padding

Formule	Description
PaddingH -> longint Par défaut : 0 Paramètre : * Padding horizontal (longint)	Padding horizontal.
PaddingV -> longint Par défaut : 0 Paramètre : * Padding vertical (longint)	Padding vertical.

Divider

Propriétés du séparateur se trouvant au deuxième niveau de l’objet : MyBC.breadCrumb.divider

Formule	Description
DividerMargin -> longint Par défaut : 0 Paramètre : * Marge du divider (longint)	Marge du divider.
Divider -> string Par défaut : > Paramètre : * Séparateur (string)	Caractère(s) à utiliser comme séparateur pour le modèle simple.

Divider font

Propriétés du séparateur pour le modèle simple se trouvant au troisième niveau de l’objet : MyBC. breadCrumb. divider.font

Formule	Description
DividerFontColor -> string Par défaut : blue Paramètre : * Couleur de police (string)	Couleur du séparateur. Il est possible de définir un taux d’opacité (%) (Ex: black:80 - noir avec une opacité de 80%).
DividerFontName -> string Par défaut : Arial Paramètre : * Nom de police (string)	Nom de la police à utiliser. Plusieurs polices peuvent être définies en les séparant par une virgule sans espace. Le composant recherchera la première police utilisable par rapport à votre OS. Attention, certaines polices abaissent certain caractères et donc ceux-ci ne pourront pas être verticalement centrés au niveau du Breadcrumb.
DividerFontSize -> longint Par défaut : 24 Paramètre : * Taille de police (longint)	Taille du séparateur.
DividerFontStyle -> string Par défaut : none Paramètre : * Style de police (string)	Style à appliquer au séparateur. Disponible : * bold * italic * underline * strikethrough Il est possible d’utiliser plusieurs styles en les séparant par une virgule sans espace.

Divider arrow

Propriétés pour le modèle arrow se trouvant au troisième niveau de l’objet : MyBC. breadCrumb. divider.arrow

Formule	Description
ArrowBorderSize -> longint Par défaut : 4 Paramètre : * Épaisseur de la flèche (longint)	Épaisseur de la flèche.
ArrowColor -> string Par défaut : #0048AA Paramètre : * Couleur de la flèche (string)	Couleur de la flèche. Il est possible de définir un taux d’opacité (%) (Ex: black:80 - noir avec une opacité de 80%).
IsFirstSectionWithArrow -> boolean Par défaut : True Paramètre : * Flèche à la première section (boolean)	Si faux, la largeur de la flèche est à zéro pour la première section.
IsLastSectionWithArrow -> boolean Par défaut : False Paramètre : * Flèche à la dernière section (boolean)	Si faux, la largeur de la flèche est à zéro pour la dernière section.
ArrowPaddingH -> longint Par défaut : 16 Paramètre : * Padding de la section (longint)	Padding horizontal appliqué au niveau du contenu de la section dans un modèle arrow.
ArrowWidth -> string Par défaut : 50% Paramètre : * Largeur de la flèche (string)	Largeur de la flèche. Vous pouvez passer une valeur en pixel ou en pourcentage (exemple : 50% ou 20px)

Section types

Propriétés liées aux états et types de section se trouvant au cinquième niveau de l’objet : MyBC. breadCrumb. sectionTypes[Type][State]

Formule	Description
SectionBgColor -> string Par défaut : #D4E3FE Paramètre : * Type et état (constante) * Couleur de fond (string)	Couleur de l’arrière-plan. Il est possible de définir un taux d’opacité (%) (Ex: black:80 - noir avec une opacité de 80%).
SectionBorderColor -> string Par défaut : black Paramètre : * Type et état (constante) * Couleur de bordure (string)	Couleur de la bordure.
SectionBorderSize -> longint Par défaut : 0 Paramètre : * Type et état (constante) * Taille de bordure (longint)	Taille de la bordure.
SectionFontColor -> string Par défaut : #0148AA Paramètre : * Type et état (constante) * Couleur de police (string)	Couleur de la police. Il est possible de définir un taux d’opacité (%) (Ex: black:80 - noir avec une opacité de 80%).
SectionFontName -> string Par défaut : Arial Paramètre : * Type et état (constante) * Nom de police (string)	Nom de la police.
SectionFontSize -> longint Par défaut : 12 Paramètre : * Type et état (constante) * Taille de police (longint)	Taille de la police.
SectionFontStyle -> string Par défaut : none Paramètre : * Type et état (constante) * Style de police (string)	Style de la police. Disponible : * bold * italic * underline * strikethrough Il est possible d’utiliser plusieurs styles en les séparant par une virgule sans espace.
PictureOpacity -> longint Par défaut : 100 Paramètre : * Type et état (constante) - Pourcentage d'opacité (longint)	Pourcentage d’opacité des images.
ReplacingColor -> string Par défaut : chaîne vide Paramètre : * Type et état (constante) * Couleur de remplacement (string)	Couleur devant remplacer la couleur actuelle dans une image de type SVG.