TooltipOption Property

When used with the EnableTooltip and HighlightEnabled properties, the TooltipOption property allows you to specify where the tooltip text comes from:

  • The object's Description property.
  • The Dynamo_Description property.
  • From a run mode tag value supplied when you load tag status symbols for your picture.

A tooltip will be displayed for the specified object only when EnableTooltip and HighlightEnabled properties are set to TRUE.

Syntax

object.TooltipOption [= enumTooltipOptions]

Properties

The TooltipOption property syntax has these parts:

Part

Description

object

An object expression that evaluates to an object in the Applies To list.

enumTooltipOptions

An enumeration that represents the type of description used for the tooltip text:

Valid entries:
0 – TooltipDescription  (uses the configured object's Description)
1 – TooltipTagStatus (allows you to change the object's Description in run mode when you load a new set of tag groups - see LoadTagGroupFile Method)
2 – TooltipDynamoDescription (uses Dynamo object's Description for tooltip text)

 

Applies To