3. Properties and formulas

Each instance has a set of properties that will allow you to define its representation in the host form. In this chapter, we will review the different existing properties accessible by a formula that acts as Setter but also as Getter if no parameters are passed to them. All formulas can be called up at the first level of the object.

Properties of the linear progress bar

Progress Area

Properties related to the progress area on the second level of the object : MyBar.progressArea

Formula	Description
PBBGColor -> string Default value : none Parameter : * Font color (string)	Font color of the background.
PBBorderColor -> string Default value : #3276DC Parameter : * Border color (string)	Color of the outer border.
PBBorderSize -> longint Default value : 1 Parameter : * Border size (longint)	Size of the outer border.
PBCornerRadius -> longint Default value : 2 Parameter : * Corner radius (longint)	Corner radius of the outer border.
PBAreaHeight -> longint Default value : 20 Parameter : * Height (longint)	Height of the progress area.
PBAreaWidth -> longint Default value : 360 Parameter : * Width (longint)	Width of the progress area.

SVG AREA

Properties related to the SVG area on the second level of the object : MyBanner.svgArea

Formula	Description
PBWindowColor -> string Default value : white:0 Parameter : * Background color (string)	Background color of the SVG Area. It is possible to define an opacity rate (%). See default value.

Textual content

Properties related to textual content at the second level of the object : MyBanner.text

Formula	Description
PBTextPosition -> string Default value : middle Parameter : * Title position (string)	Position of the title in relation to the progress bar. Possible values: "top", "middle" and "bottom". Note that the font size of the title adapts to the size of the bar if it is positioned inside (middle).
PBTitle -> string Default value : $value_l Parameter : * Title label (string)	Title label. Two placeholders are available to display the current value of the progress bar. Placeholders : - Value in longint : $value_l - Value in real : $value_r

Progress bar

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

Formula	Description
PBBarColor -> string Default value : #3B88FD:80 Parameter : * Bar color (string)	Color of the progress bar. It is possible to define an opacity rate (%). See default value.
PBBarOffset -> real Default value : 1.5 Parameter : * Padding size (real)	Padding between the outer border and the progress bar.
PBPictFormObjName -> string Default value : empty string Parameter : * Name of the form object (string)	Name of the image form object hosting the progress bar.
PBBarSpeed -> real Default value : 1 Parameter : * Animation speed (real)	Speed represents tics. This corresponds to the transition time between each percent during the animation.

Percentage and format of the text

Properties related to the percentage and format of the text on the second level of the object : MyBanner.percent

Formula	Description
PBActivateAnimation -> boolean Default value : False Parameter : * Activation of animations (boolean)	Enable/disable animation effects on transitions between the old and new values.
PBDisplayText -> boolean Default value : True Parameter : * Show/hide text (boolean)	Show/hide title.
PBFontColor -> string Default value : black Parameter : * Font color (string)	Font color applied to text elements.
PBFontName -> string Default value : Helvetica,Arial Parameter : * Font name (string)	Font name applied to text elements.
PBFontSize -> longint Default value : 12 Parameter : * Font size (longint)	Font size applied to text elements.
PBFontStyle -> string Default value : bold Parameter : * Font style (string)	Font style applied to text elements. The following values are accepted : - Bold - Italic - Strikethrough - Underline
PBPercentValue -> real Default value : 0 Parameter : * Current value (real)	Current value of the progress bar. The value can range from 0 to 100.

Properties of the circular progress bar

Size of the circle

Property related to the size of the circle on the second level of the object : MyBar.cpb

Formula	Description
CPBExternalRadius -> longint Default value : 100 Parameter : * Radius of the bar (longint)	Size of the radius of the progress bar (pix).
CPBRadiusAutoSize -> boolean Default value : True Parameter : * Activate auto calculation (boolean)	Enables automatic calculation of the radius size according to the size of the form object associated with the instance. The smallest value between the width and length of the form object is used.

Bar background

Properties related to the background of the bar on the third level of the object : MyBanner.cpb.bgBar

Formula	Description
CPBBackgroundColor -> string Default value : lightgray Parameter : * Background color (string)	Background color of the background of the progress bar.
CPBBackgroundFillColor -> string Default value : none Parameter : * Center color (string)	Background color of the center.
CPBBackgroundWidth -> longint Default value : 16 Parameter : * Background size (longint)	Width of the bar background.

Progress bar

Properties related to the progress bar on the third level of the object : MyBanner.cpb.bar

Formula	Description
CPBBarColor -> string Default value : #3B88FD:80 Parameter : * Bar color (string)	Color of the progress bar. It is possible to define an opacity rate (%). See default value.
CPBBarLinecap -> string Default value : butt Parameter : * Shape of the extremity (string)	The shape of the extremity of the progress bar. Possible values : - butt - round - square
CPBPictFormObjName -> string Default value : empty string Parameter : * Name of the form object (string)	Name of the image form object hosting the progress bar.
CPBBarSpeed -> real Default value : 1 Parameter : * Animation speed (real)	Speed represents tics. This corresponds to the transition time between each percent during the animation.
CPBBarWidth -> longint Default value : 12 Parameter : * Bar width (string)	Width of the progress bar.

Textual content

Properties related to text content on the third level of the object : MyBanner.cpb.text

Formula	Description
CPBSubTitle -> string Default value : % Parameter : * Subtitle label (string)	Subtitle label. Two placeholders are available to display the current value of the progress bar. Placeholders : - Value in longint : $value_l - Value in real : $value_r
CPBTitle -> string Default value : $value_l Parameter : * Title label (string)	Title label. It uses the same placeholders in relation to the subtitles.

Percentage and text format

Properties related to the percentage and format of the text on the third level of the object : MyBanner.cpb.percent

Formula	Description
CPBActivateAnimation -> boolean Default value : False Parameter : * Activation of animations (boolean)	Enable/disable animation effects on transitions between the old and new values.
CPBDisplayText -> boolean Default value : True Parameter : * Show/hide text (boolean)	Show/hide title.
CPBFontColor -> string Default value : gray:80 Parameter : * Font color (string)	Font color applied to the text elements. It is possible to define an opacity rate (%). See default value.
CPBFontName -> string Default value : Helvetica,Arial Parameter : * Font name (string)	Font name applied to text elements.
CPBFontSize -> longint Default value : 35 Parameter : * Font size (longint)	Font size applied to text elements.
CPBFontStyle -> string Default value : bold Parameter : * Font style (string)	Font style applied to text elements. The following values are accepted : - Bold - Italic - Strikethrough - Underline
CPBPercentValue -> real Default value : 0 Parameter : * Current value (real)	Current value of the progress bar. The value can range from 0 to 100.