4. Properties and formulas

A banner has a set of properties that will allow you to define its appearance in the host form.

In this chapter, we will review the different existing properties accessible by a formula that acts as Setter and also as Getter if no parameters are passed to them.

All formulas can be invoked at the first level of the object.

Banner

Properties related to the banner at the second level of the object: MyBanner.banner

Formula	Description
BannerName -> string Default value : AJUI_Banner_2use or AJUI_cr_2use Parameter : * Banner name (string)	name of the banner if type is window or name of the cornerRibbon if the type is cornerRibbon.
BannerBGColor -> string Default value : black:50 Parameter : * Background color (string)	Background color of the banner. It is possible to define an opacity rate (%). See default value.
BannerHeight -> longint Default value : 150 Parameter : * Banner height (longint)	Height of the banner.
BannerWidth -> longint Default value : 400 Parameter : * Banner width (longint)	Width of the banner.
BorderColor -> string Default value : darkgray Parameter : * Border color (string)	Color of the banner border.
BorderSize -> longint Default value : 0 Parameter : * Border size (longint)	Size of the banner border.
CornerRadius -> longint Default value : 15 Parameter : * Corner radius (longint)	Corner radius.
BannerPosition -> string Default value : bottom-right Parameter : * "cornerRibbon" banner position (string)	Banner position for the "cornerRibbon" type. Possible position: top-left | top-right | bottom-left | bottom-right
BannerType -> string Default value : cornerRibbon Parameter : * Banner type (string)	Type de bannière à utiliser. Type possible : cornerRibbon | window | spinner | windowSpinner

Text

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

Formula	Description
Message -> string Default value : AJUI Banner Parameter : * Message from the banner (string)	Message that will be displayed in the banner.
TextColor -> string Default value : white Parameter : * Font color (string)	Color of the text.
TextFontName -> string Default value : Arial Parameter : * Name of the font (string)	Name of the font. Some fonts may not be SVG compatible.
TextFontSize -> longint Default value : 32 Parameter : * Font size (longint)	Font size.
TextFontStyle -> string Default value : normal Parameter : * Font style (string)	SVG property that can be applied at the text level. Possible property: normal | italic | oblique | inherit
TextFontWeight -> string Default value : bold Parameter : * Font weight (string)	SVG property that can be applied at the text level. Possible property: normal | bold | bolder | lighter | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900 | inherit

Window

Properties related to the window on the second level of the object: MyBanner.window

Formula	Description
WindowBGColor -> string Default value : black:50 Parameter : * Background color (string)	Background color of the "window" banner. It is possible to define an opacity rate (%). See default value.
WindowRef -> longint Default value : 0 Parameter : * Reference to the window form (longint)	Reference to the form to be filled in with the banner. The value 0 represents the current form.

Picture

Properties related to the image at the second level of the object: MyBanner.picture

Formula	Description
IsPicture -> boolean Default value : false Parameter : * Use picture or text (boolean)	If true, the banner hold a picture, if not the banner hold a text. Only applies to the "window" banner.
PicturePath -> string Default value : empty string Parameter : * File path in the "resources" folder (string)	File path of the picture to be displayed. The picture must be in the 4D application's resource folder and the path is always relative. Example : "Images/info.png" (used the 4D folder separator constant to build the string path in a clean way)

Spinner

Properties related to the spinner at the second level of the object : MyBanner.banner.spinner

Formula	Description
SpinnerScale -> real Default value : 0.5 Parameter : * Spinner scale (real)	The scaling of the spinner in relation to the window. This does not apply to the type "windowSpinner" because its size will adapt according to the text box.
WindowSpinnerSide -> string Default value : right Parameter : * Spinner align (string)	Alignment of the spinner to the text. Possible value : left | right

Ribbon

Properties related to the ribbon at the second level of the object: MyBanner.banner.ribbon

Formula	Description
RibbonTargetName -> string Default value : empty string Parameter : * Name of the form object (string)	Name of the form object that will receive the ribbon.
RibbonTargetCoordinates -> object Default value : 0 for each coordinate Parameters : * Left coordinate (longint) * Top coordinate (longint) * Right coordinate (longint) * Bottom coordinate (longint)	Coordinates of an area that will receive the ribbon. In Getter mode, the formula returns an object containing all four coordinates.