FR 6. Propriétés et formules

Un bouton 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 et également de Getter si on ne leur passe aucun paramètre.

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

⚠️ concernant les formules nécessitant l’état du bouton (state/état), celui-ci est obligatoire, seul le deuxième paramètre est optionnel pour réaliser un Getter.

Concernant les propriétés touchant aux couleurs, vous pouvez leur passer un code couleur en hexadécimal (Ex : 0x00FFFFFF) ou sous forme de chaînes CSS (Ex : "black", "#0A509E").

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.

NB : Dans les sections suivantes de ce chapitre 2 nous serons amenés à utiliser le terme Btn (Button) en lieu et place de Bouton pour des soucis de cohérences avec les noms définis en anglais dans les formules.

Global

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

Formule	Description
Composition -> string Par défaut : text Paramètre : * Composition du bouton (string)	Composition du bouton : - text - picture - composite
Name -> string Par défaut : chaîne vide Paramètre : * Nom du bouton (string)	Nom du bouton et donc de l’objet de formulaire image.
OnClick -> string Par défaut : chaîne vide Paramètres : * Callback (string) * Paramètres (object)	Nom de la méthode de callback sur l’événement « On Click ». Vous pouvez passer en deuxième paramètre un objet contenant les paramètres du callback.
OnDoubleClick -> string Par défaut : chaîne vide Paramètres : * Callback (string) * Paramètres (object)	Nom de la méthode de callback sur l’événement « On Double Click ». Vous pouvez passer en deuxième paramètre un objet contenant les paramètres du callback.
Type -> string Par défaut : rectangle Paramètre : * Type du bouton (string)	Type du bouton (forme) : - rectangle - circle.

Box

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

Formule	Description
BGColor -> string Par défaut : #4d9ad4 Paramètres : * État du bouton (constante) * Couleur de fond primaire (string)	Couleur du bouton principale. Il est possible de définir un taux d’opacité (%) (Ex: black:80 - noir avec une opacité de 80%).
CornerRadius -> longint Par défaut : 5 Paramètres : * État du bouton (constante) * Taille de l’arrondi des bords (longint)	Valeur du rayon appliqué aux quatre angles du bouton.
Height -> longint Par défaut : -1 Paramètres : * État du bouton (constante) * Hauteur du bouton (longint)	Hauteur du bouton. La valeur -1 prend comme hauteur celle définie dans l’éditeur de formulaire
Resizable -> boolean Par défaut : False Paramètre : * Redimensionne l’objet formulaire	Si vrai (True), il prendra en compte les valeurs définies (width et height). Si faux (False), il prend en compte les dimensions de l’objet de formulaire image défini dans l’éditeur de formulaire.
Width -> longint Par défaut : -1 Paramètres : * État du bouton (constante) * Largeur du bouton (longint)	Largeur du bouton. La valeur -1 prend comme largeur celle définie dans l’éditeur de formulaire.

Border

Propriétés liées à la bordure se trouvant au deuxième niveau de l’objet : btn.border

Formule	Description
BorderColor -> string Par défaut : #0a509e Paramètres : * État du bouton (constante) * Couleur de bordure (string)	Couleur de la bordure. Il est possible de définir un taux d’opacité (%).
BorderSize -> longint Par défaut : 0 Paramètres : * État du bouton (constante) * Taille de bordure (longint)	Taille de la bordure.

Text

Propriétés liées aux éléments textuels se trouvant au deuxième niveau de l’objet : btn.text

Formule	Description
FontColor -> string Par défaut : white Paramètres : * État du bouton (constante) * Couleur du texte (string)	Couleur du texte. Il est possible de définir un taux d’opacité (%).
FontName -> string Par défaut : Arial, Helvetica, MS Sans Serif Paramètres : * État du bouton (constante) * Nom de police (string)	Nom de la police à utiliser. Plusieurs polices peuvent être entrées en les séparant par une virgule sans espace. Le composant recherchera la première police utilisable par rapport à votre OS.
FontSize -> longint Par défaut : 16 Paramètres : * État du bouton (constante) * Taille de police (longint)	Taille de police.
FontStyle -> string Par défaut : chaîne vide Paramètres : * État du bouton (constante) * Style de police (string)	Style de police : - Bold - Italic - Underline - Strikethrough
Label -> string Par défaut : Label Paramètres : * État du bouton (constante) * Libellé du bouton (string)	Texte à afficher.
TextMarginHorizontal -> longint Par défaut : 0 Paramètres : * État du bouton (constante) * marge horizontale (longint)	Marge horizontale appliquée au texte permettant d’ajouter un écart lorsque celui-ci est aligné à gauche ou à droite. Si le texte est centré, cela permet de le compresser. La marge s’applique de chaque côté du texte.

Picture

Propriétés liées aux éléments images se trouvant au deuxième niveau de l’objet : btn.picture

Formule	Description
ColorToReplace -> string Par défaut : chaîne vide Paramètres : * État du bouton (constante) * Couleur à remplacer (string)	Couleur actuelle d’un SVG. Ici c'est la valeur de la balise « fill ».
PictureHeight -> longint Par défaut : -1 Paramètres : * État du bouton (constante) * Hauteur de l'image (longint)	Hauteur de l’image. La valeur -1 prend la hauteur originelle de l'image.
PictureOpacity -> longint Par défaut : 100 Paramètres : * État du bouton (constante) * Opacité de l'image (longint)	Picture opacity rate.
PicturePath -> string Par défaut : chaîne vide Paramètres : * État du bouton (constante) * Chemin du fichier image (string)	Chemin de dossier depuis le dossier « ressources ». Vous pouvez également utiliser « # » plus le nom de votre fichier image comme chemin ( valable uniquement avec un template AJUI Button importé si la ou les images associées sont dans le même dossier que le template)
PictureRatio -> real Par défaut : 1 Paramètres : * État du bouton (constante) * Ratio de la taille de l'image (real)	Agrandis/réduis la taille de l'image. Il est pris en considération à la place des propriétés hauteur et largeur. La valeur 1 désactive la prise en compte du ratio (1 = taille actuelle de l'image).
ReplacingColor -> string Par défaut : chaîne vide Paramètres : * État du bouton (constante) * Nouvelle couleur (string)	Couleur devant remplacer la couleur actuelle dans une image de type SVG.
PictureScale -> longint Par défaut : 0 Paramètres : * État du bouton (constante) * Échelle de l’image (string)	Redimensionnement de l’image par rapport à la taille du bouton d’après ce pourcentage. À la priorité sur toutes les autres propriétés modifiant la taille. La valeur zéro désactive cette opération. La valeur doit être comprise entre 0 et 100
PictureWidth -> longint Par défaut : -1 Paramètres : * État du bouton (constante) * Largeur de l'image (longint)	Largeur de l’image. La valeur -1 prend la largeur originelle de l'image.

Composite

Propriétés liées aux éléments composites se trouvant au deuxième niveau de l’objet : btn.composite

Formule	Description
CompActiveSecondColor -> boolean Par défaut : False Paramètre : * Activer la couleur secondaire (boolean)	Active la couleur secondaire.
BGSecondaryColor -> string Par défaut : #9fddf9 Paramètres : * État du bouton (constante) * Couleur de fond secondaire (string)	Couleur secondaire pour le composite. Il est possible de définir un taux d’opacité (%).
CompLinked -> boolean Par défaut : False Paramètre : * Lier le texte et l'image (boolean)	Lie le texte à l’image et applique un padding entre eux (couleur secondaire n’est pas active dans ce cas).
CompPadding -> longint Par défaut : 10 Paramètres : * État du bouton (constante) * Padding entre le texte et l'image (longint)	Padding entre l’image et le texte si lié.
CompPicturePosition -> string Par défaut : left Paramètres : * État du bouton (constante) * Position de l'image (string)	Position de l’image dans le bouton (ne s’applique que pour les composites). Position disponible : - left - right - top - bottom
CompPictSizeAllocation -> longint Par défaut : 30 Paramètres : * État du bouton (constante) * Taille allouée à l'image (longint)	Espace alloué à l’image par rapport au texte. Cela sert à redimensionner l’image si elle dépasse les limites du bouton. Cette valeur sera appliquée sur la hauteur ou la largeur en fonction de la position de l’image par rapport au texte. Cette valeur représente des pixels.
CompTextAlign -> string Par défaut : center Paramètres : * État du bouton (constante) * Alignement du texte (string)	Alignement du texte dans le bouton composite : - left - center - right).