Edit

Define tooltips for table and page fields

Even a well-designed user interface can confuse some users. You can't predict every question, so the base application includes tooltips for all page fields. Tooltips explain what data users can enter and how Business Central uses it. Keep tooltips in mind when you develop your solution's user interface.

Learn more in Help users get unblocked (by providing tooltips).

Adding tooltips to table fields (2024 release wave 1 or later)

Starting in Business Central 2024 release wave 1, you can define tooltips on table fields. When a tooltip is defined on a table field, any page that uses the field automatically inherits the tooltip.

The following example shows how tooltips are defined on the table level:

table 50102 MyTable
{
    DataClassification = CustomerContent;

    fields
    {
        field(1; MyField; Integer)
        {           
            ToolTip = 'Field number one is always the best!';
        }

        field(2; MySecondField; Integer) {  }
    }
}

Tip

The AL Language extension for Microsoft Dynamics 365 Business Central for Visual Studio Code includes the CodeCop informational rule AA0234: You should write a tooltip in the Tooltip property for all fields on table objects. Consider enabling the rule if you want to ensure that all fields have a tooltip. Learn more about code analysis in Using the code analysis tool.

Overriding tooltips on table fields (2024 release wave 1 or later)

Starting in Business Central 2024 release wave 1, you can define tooltips on table fields. A page field inherits a table field's tooltip unless you define another tooltip on the page field. In that case, the client displays the page field's tooltip.

The following example shows how a page field overrides a tooltip defined on a table field:

page 50103 MyPage
{
    PageType = Card;
    ApplicationArea = All;
    UsageCategory = Administration;
    SourceTable = MyTable;

    layout
    {
        area(Content)
        {
            group(GroupName)
            {
                field(First; Rec.MyField)
                {                   
                    ToolTip = 'This tooltip overwrites the tooltip defined on the table field.';
                }

                field(Second; Rec.MySecondField)
                {    
                    ToolTip = 'Tooltip on page field (it was never defined on the table)';
                }
            }
        }
    }
}

Adding tooltips to page fields (2023 release wave 2 or earlier)

In Business Central 2023 release wave 2 or earlier, you can only define tooltips on page fields.

If you display a table field on multiple pages, such as a card and a list, you must define the tooltip on each page.

Help users get unblocked (by providing tooltips)
Build your first sample extension with extension objects, install code, and upgrade code
Page object

  • Last updated on