GetHelpText Function

Class

AnyWin class.

Action

Returns the popup help text currently displayed for the control.

Availability

Windows operating systems.

This functionality is supported only if you are using the Classic Agent.

Syntax

sText = GetHelpText()
Variable Description
sText The currently displayed help text, or an empty string (" "). STRING.

Notes

  • GetHelpText provides support for the ToolTips control.

  • GetHelpText is not supported for .NET tooltips. In .NET, the tooltip is not a property of the control, and tooltip text will not return with the GetHelpText function.

  • GetHelpText is not designed to work with browser controls. In a browser, the alt tag is sometimes used to simulate a tooltip, but there is no actual tooltip control.

  • GetHelpText returns the pop-up help text that is currently displayed for a control. Before calling this function, a script should call MoveMouse to place the mouse in the window whose help text is required. You do not need to add a delay between the MoveMouse and GetHelpText calls to make the help text appear.

  • An 0x0… response indicates that the control did not return any help text.

Example

[ ] MyApp.Toolbar1.PushButton("Copy").MoveMouse()
[ ] Verify(MyApp.Toolbar1.PushButton("Copy").GetHelpText (), "Copy to clipboard")