ToolTip Property

Article
06/30/2022
2 minutes to read

Version: Available or changed with runtime version 1.0.

Sets the string used for the tooltip of an action, a field, a FactBox, or an activity button.

In the client, tooltips appear when you point to the caption of the control.

Applies to

Page Label
Page Field
Page Part
Page System Part
Page Chart Part
Page Action Area
Page Action
Page Action Group

Note

List page field tooltips are only shown in the Web client and Tablet client.

Note

Activity button tooltips are only shown in the Web client.

Note

ActionContainers tooltips are only shown in the Web client for the subtype Embedding.

Parameters

Locked
Type: Boolean
If true the ToolTip is locked and should not be translated.

Comment
Type: Text
Descriptive text for the ToolTip, for example, with regards to translation.

MaxLength
Type: Integer
Sets the maximum length of the specific ToolTip.

Remarks

The default is an empty string, which means there will be no tooltip. According to the user assistance model for Business Central, apps are expected to apply tooltips to controls on pages. Tooltips can be up to 1024 characters long, exceeding this does not throw an error, but the rest of the tooltip is truncated .... The best practice is to not exceed 200 characters. For more information, see Guidelines for tooltip text.

The following example illustrates how you can apply tooltips in an app:

field("Reward ID";"Reward ID")
{
    ApplicationArea = All;
    ToolTip = 'Specifies the level of reward that the customer has at this point.';
}

Or, with parameters:

field("Reward ID";"Reward ID")
{
    ApplicationArea = All;
    ToolTip = 'Specifies the level of reward that the customer has at this point.', Locked = true, Comment = 'Keep like this, do not translate.', MaxLength = 100;
}

Applies to

Parameters

Remarks

See Also

Feedback