Function Reference

GUICtrlSetTip

Sets the tip text associated with a control.

GUICtrlSetTip ( controlID, tiptext [, "title" [, icon [, options]]]]] )

 

Parameters

controlID The control identifier (controlID) as returned by a GUICtrlCreate... function.
tiptext Tip text that will be displayed when the mouse is hovered over the control.
title [optional] The title for the tooltip Requires IE5+
icon [optional] Pre-defined icon to show next to the title: Requires IE5+. Requires a title.
0 = No icon, 1 = Info icon, 2 = Warning icon, 3 = Error Icon
options [optional] Sets different options for how the tooltip will be displayed (Can be added together):
1 = Display as Balloon Tip Requires IE5+
2 = Center the tip horizontally along the control.

 

Return Value

Success: Returns 1.
Failure: Returns 0.

 

Remarks

This tip text is displayed in a tooltip rectangular area.
To skip an optional parameter, leaving it's default value intact, use the Default keyword..
You may use @CR or @LF to create multi-line tooltips.
The title, icon and Balloon Tip option all require Internet Explorer 5.0 or later in order to function.
To display an icon, you must specify a non-empty title. The icon appears on the same row as the title and thus requires a title to be present.

 

Related

GUICtrlUpdate...

 

Example


#include <GUIConstantsEx.au3>

Opt('MustDeclareVars', 1)

Example()

Func Example()
    Local $msg
   
    GUICreate("My GUI control tip")  ; will create a dialog box that when displayed is centered

    GUICtrlCreateLabel("my label", 10, 20)
    GUICtrlSetTip(-1, "tip of my label")
   
    GUISetState()

    ; Run the GUI until the dialog is closed
    While 1
        $msg = GUIGetMsg()
       
        If $msg = $GUI_EVENT_CLOSE Then ExitLoop
    WEnd
EndFunc   ;==>Example