ICommand​.Tooltip [Property][Get]

Gets this commands Tooltip text.

Defined As

• [VBA] String Tooltip

• [Cicode] STRING Tooltip

• [C++] VARIANT_BOOL Tooltip

Execution Result

If the property get succeeds, the return value will be Success. If the return variable is invalid, the return value will be InvalidArgument. If the command has been deleted, the return value will be GeneralFailure.

Remarks

This returns the text that is displayed in a tooltip window when the mouse pointer hovers over the command's button.

Calling Syntax

This example assumes there is a valid Command object as retrieved from a Process Analyst's CommandSystem. (for example, VBA: ProcessAnalyst.CommandSystem.Item(1))

[VBA]

Sub Example(Command As Object)

Dim tooltip As String

`Getting Property value

tooltip = Command.Tooltip

End Sub

[Cicode]

FUNCTION Example(OBJECT hCommand)
// Getting property value
STRING sTooltip = _ObjectGetProperty(hCommand, "Tooltip");
END