Skip to content

psToolTip - cCJAction

Gets and sets the tool tip text that appears when an item is highlighted

Type: Property
Access: Read/Write
Data Type: String
Parameters: None

Syntax

Property String psToolTip
Access Type Syntax
Read Access: Get psToolTip to StringVariable
Write Access: Set psToolTip to StringVariable/Value

Description

psToolTip is used to set and get the tool tip text that appears in a menu or toolbar item. The text will appear when an item is highlighted (i.e., a mouse hover over or a popup menu item selection).

Tool tips will appear in toolbar items if the cCJCommandBarSystem pbToolBarScreenTips property is true, which is the default.

Tooltips can also appear in popup menu items if the cCJCommandBarSystem pbShowPopupBarToolTips property is true, which is not the default.

Sample

Object oMyMenuItem is cCJMenuItem
    Set psCaption to "Select Me"
    Set psToolTip to "Select Me in tooltip"
    Set psDescription to "Select Me in idle statusbar pane"
    Set psImage to "SelectMe.ico"

    Procedure OnExecute
        Showln "Select Me was selected"
    End_Procedure   
End_Object

ToolTips can display a single line of text or multiple lines. You can embed the CR LF characters in your ToolTip string to break the string into multiple lines.

Define CR_LF for (Character(13)+Character(10))

Set psToolTip to ("This is a ToolTip string that is split" + CR_LF + ;
                  "across two lines.")

See Also

psCaption | psDescription | psShortcut