5. Properties and formulas

A tooltip has a set of properties that will define its representation and interactions with the host form. ln this chapter, we will review the different existing properties accessible by a formula acting as Setter and also as Getter if we do not pass them any parameter. All formulas can be called at the first level of the object.

lt is recommended not to manually modify properties whose values are not defined by formulas because they are managed internally by the component.

Global

Global properties located on the second level of the object : tip.global

Formula	Description
TipName -> string Default value : empty string Parameter : * Tip name (string)	Name of the tooltip (tip).
TipDuration -> real Default value : 0 Parameter : * Tip lifespan/display (real)	Time of appearance of the Tip (value in milliseconds). In case of a zero value, the Tip will not have a display time limit.
AutoRebuid -> boolean Default value : False Parameter : * Activate auto rebuild (boolean)	Allows to force the reconstruction of the Tip automatically after each use of a formula (except for formulas related to animations). Enabling this mode may produce many calls, so it should be used sparingly.

Target

Properties related to the target on the second level of the object : tip.target

Formula	Description
TargetName -> string Default value : empty string Parameter : * Name of the target object (string)	Name of the target form object that will be linked to the Tip.
TargetCoordinates -> object Default value : 0 for each coordinate Parameter : * Left coordinate (longint) * Top coordinate (longint) (optionnal) * Right coordinate (longint) (optionnal) * Bottom coordinate (longint) (optionnal)	This object will contain the values of the target coordinates (left, top, right and bottom). The values are calculated automatically if the target is set.
TipPosition -> string Default value : right-middle Parameter : * position (string) * Apply the default arrow postion (boolean) (optionnal)	Position of the Tip in relation to the target.
TargetMargin -> longint Default value : 0 Parameter : * Left margin (longint) * Top margin (longint) (optionnal) * Right margin (longint) (optionnal) * Bottom margin (longint) (optionnal)	Allows you to set a gap between the Tip and the target.
TargetOffset -> longint Default value : 0 Parameter : * Tip shift (longint)	Allows you to shift the Tip relative to the target.

Container

Properties related to the container on the second level of the object : tip.container

Formula	Description
BackgroundColor -> string Default value : yellow Parameter : * Background color (string)	Background color of the container. Can be either the name of the color (e.g. "red") or the hexa value representing the RGB color (e.g. "#FF0000").
BackgroundOpacity -> longint Default value : 50 Parameter : * Opacity percentage (longint)	Container opacity. Value expressed in percent
BorderColor -> string Default value : gray Parameter : * Border color (string)	Borders color. Can be either the name of the color (e.g. "red") or the hexa value representing the RGB color (e.g. "#FF0000").
BorderOpacity -> longint Default value : 100 Parameter : * Opacity percentage (longint)	Border opacity.
BorderSize -> longint Default value : 1 Parameter : * Size (longint)	Border size.
CornerRadius -> longint Default value : 5 Parameter : * Radius value (longint)	Value of the radius applied to the 4 corners of the Tips.
Padding -> longint Default value : 10 Parameter : * Internal margin size (longint)	Value of the padding applied to the Tip.
TipboxMaxHeight -> longint Default value : 0 Parameter : * Maximum container height (longint)	Allows you define the maximum height of the text box in the container. Not taken into account if maxWidth is greater than zero.
TipboxMaxWidth -> longint Default value : 0 Parameter : * Maximum container width (longint)	Allows you to define the maximum width of the text box in the container. Has priority over maxHeight for practical reasons of resizing the area.
ActivateShadow -> boolean Default value : False Parameter : * Enable effect (boolean)	Enable the shadow effect.
ShadowOffset -> longint Default value : 2 Parameter : * Offset value (longint)	Shadow shift in relation to the tooltip.

Text

Properties related to the text displayed in the container on the second level of the object : tip.text

Formula	Description
TextLabel -> string Default value : Stylish example text Parameter : * Container text (string)	Text to be displayed.
TextFontColor -> string Default value : black Parameter : * Font color (string)	Font color.
TextFontName -> string Default value : Helvetica,Arial,MS Sans Sherif Parameter : * Font name (string)	Name of the font to use. Several fonts can be entered by separating them with a comma without spaces. The component will search for the first usable font available.
TextFontSize -> longint Default value : 11 Parameter : * Font size (longint)	Font size.
TextOpacity -> longint Default value : 100 Parameter : * Text opacity (longint)	Text opacity. Value expressed in percent
TextRotation -> string Default value : empty string Parameter : * Text rotation (string)	Rotation of the text : - left - right

Arrow

Properties related to the drawing of the Tip arrow on the second level of the object : tip.arrow

Formula	Description
ArrowPosition -> string Default value : middle Parameter : * Arrow position (string)	Position of the arrow (see chapter Tooltips for the positions available).
ArrowHeight -> longint Default value : 16 Parameter : * Height (longint)	Height size of the arrow.
ArrowWidth -> longint Default value : 20 Parameter : * Width (longint)	Width size of the arrow.
ArrowOffset -> longint Default value : 10 Parameter : * Offset value (longint)	Allows you to add an offset of the arrow from its initial position related to the border (no effect when center and middle positions are set).
Curved -> boolean Default value : False Parameter : * Curved arrow (boolean)	Allows to curve the angles of the arrow.
ArrowCurve -> real Default value : 0.9 Parameter : * Ratio (real)	Ratio to be applied to the angle of the arrow tip (see chapter Tooltips).
CornerCurveStart -> real Default value : 0.5 Parameter : * Ratio (real)	Ratio to be applied, which defines the starting point of the curve for both the start and end angles of the arrow (see chapter Tooltips).
CornerCurveEnd -> real Default value : 0.15 Parameter : * Ratio (real)	Ratio to be applied, which defines the end point of the curve for both the start and end angles of the arrow (see chapter Tooltips).

Subform

Properties related to the subform of the container at the second level of the object : tip.subform

Formula	Description
SubformName -> string Default value : empty string Parameter : * Name of the form in the Host database (string)	Name of the form associated with the container subform.

Closebox

Properties related to the closebox located at the second level of the object : tip.closeBox

Formula	Description
CloseBoxDisplay -> boolean Default value : False Parameter : * Display (boolean)	Display the closebox in the Tip container. When this value is set to true, the property "onClick" is also set to true.
ActivateOnClickCB -> boolean Default value : False Parameter : * Enable the onClick event (boolean)	Enabling the onClick event of the closeBox.
CloseBoxSize -> longint Default value : 5 Parameter : * Size between 2 and 20 (longint)	Size of the closeBox. Must be a value between 2 min. and 20 max.

Animations

Properties related to the animations on the second level of the object : tip.animation

Formula	Description
ActivateAnimation -> boolean Default value : True Parameter : * Enable animations (boolean)	Enables animations (does not concern fade in and fade out).
AnimationRefresh -> longint Default value : 20 Parameter : * Refresh value (longint)	Refresh value of animations. Expressed in number of drawing refreshes per second. This value applies to animations and for Fade in and Fade out effects.

Blink

Properties related to the Blink animation on the third level of the object : tip.animation.blink

Formula	Description
BlinkNumber -> longint Default value : 0 Parameter : * Number of effects (longint)	Number of Blink.
BlinkDuration -> longint Default value : 1000 Parameter : * Duration of a blink (longint)	Duration of a Blink (in milliseconds).
BlinkOn -> longint Default value : 50 Parameter : * Percent time for the Blink ON (longint)	Display time proportionally to the total duration of a blink (value in percent).

Jump

Properties related to the Jump animation on the third level of the object : tip.animation.jump

Formula	Description
JumpNumber -> longint Default value : 0 Parameter : * Number of effects (longint)	Number of jump effects.
JumpDuration -> longint Default value : 1000 Parameter : * Duration of a jump (longint)	Duration of the jump effect, this includes the round trip (milliseconds).
JumpOffset -> longint Default value : 20 Parameter : * Jump distance (longint)	Distance to go for the jump effect.
JumpkOn -> longint Default value : 50 Parameter : * Percent time for the Jump ON (longint)	Time of going up proportionally to the total duration of a jump (value in percent).

Fade in and out

Properties related to the Fade effects on the third level of the object : tip.animation.fade

Formula	Description
ActivateFadeIn -> boolean Default value : False Parameter : * Enable effect (boolean)	Enables the fade in animation.
ActivateFadeOut -> boolean Default value : False Parameter : * Enable effect (boolean)	Enables the fade out animation.
TimerFadeIn -> longint Default value : 1000 Parameter : * Duration (longint)	Duration of the fade in effect (milliseconds).
TimerFadeOut -> longint Default value : 1000 Parameter : * Duration (longint)	Duration of the fade out effect (milliseconds).