Редагувати

Поділитися через

ToolTip Property

  • Стаття

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
  • Page Custom Action
  • Page System Action
  • Page File Upload Action
  • Query Column
  • Table field

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 doesn't 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.

With the Locked parameter, you can specify that the tooltip shouldn't be translated. This is useful when the tooltip is a technical term or a proper name, for example. The Comment parameter is used to provide additional information about the tooltip, for example, to explain why the tooltip shouldn't be translated. The MaxLength parameter is used to specify the maximum length of the tooltip. If the tooltip exceeds the maximum length, the rest of the tooltip is truncated ....

Note

With runtime version 14.0, the ToolTip property is available for query columns.

Note

With runtime version 13.0, the ToolTip property is available for table fields. A table field tooltip will, like the caption, be applied on page controls that reference the table field. This allows you to specify the tooltip in one place and have it applied to all controls that reference the table field. With runtime 13.0, there's a new code action to help move the tooltip from page controls to table fields or clean them up from the page in case of duplicates. For more information, see AL code actions.

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;
}

User assistance model
Guidelines for tooltip text
Configuring the help experience
ToolTipML property
Build your first sample extension with extension objects, install code, and upgrade code
Multilanguage development