Tooltip.property

Description

Settings for tooltips for a column or control.

Applies to

Button, Column, Computed Field, Graph, GroupBox, InkPicture, Line, OLE, Blob OLE, Oval, Picture, Rectangle, Report, RoundRectangle, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Tooltip.property

Describe and Modify argument:

"controlname.Tooltip.property { = 'value ' }"

SyntaxFromSql:

Column ( Tooltip.property = value )
Text ( Tooltip.property = value )

Parameter

Description

controlname

The control whose Tooltip properties you want to get or set.

When generating DataWindow syntax with SyntaxFromSql, the Tooltip settings apply to all columns or all text controls.

property

A property that applies to the tooltip of a control, as listed in the Property table below.

value

Values for the properties are shown below. Value can be a quoted DataWindow expression.


Property for Tooltip

Value

Backcolor

(exp) A long specifying the color (the red, green, and blue values) to be used for the background color of the tooltip box.

This property will take effect only when the Windows classic style option is selected. Select "Enable Windows Classic Style in the IDE" in the System Options for this property to take effect when running the application from the IDE; and select "Windows classic style" in the project painter for this property to take effect when running the application executable.

Delay.initial

(exp) An integer specifying the time in milliseconds before the tooltip box displays (minimum zero, maximum 32767). Default value is 0.

Delay.visible

(exp) An integer specifying the time in milliseconds that the tootip box remains visible (minimum zero, maximum 32767). Default value is 32000.

Enabled

(exp) Whether the tooltip is enabled. Values are:

1 -- The tooltip is enabled.

0 -- (Default) The tooltip is disabled.

HasCloseButton

Reserved for future use only

Icon

(exp) A string for the icon to display to the left of the title in the tooltip box. The default is for no icon to display. Three stock icons are available for display in the tooltip box: Info, Warning, and Error.

0 -- None

1 -- Info

2 -- Warning

3 -- Error

Isbubble

(exp) Whether the tooltip box displays as a basic rectangle or a callout bubble.

Values are:

0 -- Displays the standard tooltip shape.

1 -- Displays the tooltip as a rounded callout bubble.

MaxWidth

Reserved for future use only

Position

Reserved for future use only

Tip

(exp) A string specifying the text for the tooltip. If you use an expression, make sure the result is converted to a string.

Title

(exp) A string specifying the tooltip box title. If you use an expression, make sure the result is converted to a string.

Textcolor

(exp) A long expression specifying the color (the red, green, and blue values) to be used as the control's tooltip color.

This property will take effect only when the Windows classic style option is selected. Select "Enable Windows Classic Style in the IDE" in the System Options for this property to take effect when running the application from the IDE; and select "Windows classic style" in the project painter for this property to take effect when running the application executable.


Usage

In the painter

Select the control and set the value on the Tooltip tab of the Properties view.

Not available for columns or controls in RichText, Graph, or OLE DataWindow objects. If you want to add a tooltip to an InkPicture in a DataWindow, that InkPicture must not be enabled.

Examples

dw_1.Object.oval_1.Tooltip.Color = RGB(255, 0, 128)
ls_data = dw_1.Describe("oval_1.Tooltip.Color")
dw_1.Modify("emp_name.Tooltip.Color='11665407'")
SQLCA.SyntaxFromSQL(sql_syntax, &
   "Style(...) Column(Tooltip.Delay.Visible=15 ...) &
    ...",    ls_Errors)
SQLCA.SyntaxFromSQL(sql_syntax, &
  "Style(...) Column(Tooltip.TextColor=11665407 ...)"&
  , ls_Errors)