Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-08-06 17:36:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make BCQuality aware of ToolTips definied on the source

Browse source
This commit is contained in:
Kilian Seizinger 2026-07-20 09:33:34 +02:00
parent 712dee9ec1
commit 48ead8fc21
6 changed files with 68 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

14
microsoft/knowledge/style/tooltip-required-on-page-fields.bad.al
View file

@ -1,3 +1,15 @@
tableextension 50251 "Sample Tooltip Bad Ext" extends Customer
{
fields
{
field(50251; "Reward Level"; Code[10])
{
Caption = 'Reward Level';
DataClassification = CustomerContent;
}
}
}
page 50251 "Sample Tooltip Bad"
{
PageType = Card;
@ -8,7 +20,7 @@ page 50251 "Sample Tooltip Bad"
{
group(General)
{
field("No."; Rec."No.")
field("Reward Level"; Rec."Reward Level")
{
ApplicationArea = All;
}

24
microsoft/knowledge/style/tooltip-required-on-page-fields.good.al
View file

@ -1,3 +1,16 @@
tableextension 50250 "Sample Tooltip Good Ext" extends Customer
{
fields
{
field(50250; "Loyalty Points"; Integer)
{
Caption = 'Loyalty Points';
DataClassification = CustomerContent;
ToolTip = 'Specifies the number of loyalty points the customer has collected.';
}
}
}
page 50250 "Sample Tooltip Good"
{
PageType = Card;
@ -8,17 +21,20 @@ page 50250 "Sample Tooltip Good"
{
group(General)
{
field("No."; Rec."No.")
field("Loyalty Points"; Rec."Loyalty Points")
{
ApplicationArea = All;
ToolTip = 'Specifies the number that identifies the customer.';
}
field(Amount; Rec."Balance (LCY)")
field(BalanceDue; BalanceDueAmount)
{
ApplicationArea = All;
ToolTip = 'Shows the total balance in local currency.';
Caption = 'Balance Due';
ToolTip = 'Shows the total balance due in local currency.';
}
}
}
}
var
BalanceDueAmount: Decimal;
}

14
microsoft/knowledge/style/tooltip-required-on-page-fields.md
View file

@ -1,28 +1,32 @@
---
bc-version: [all]
domain: style
keywords: [tooltip, page-field, aa0218, codecop, accessibility, specifies]
keywords: [tooltip, page-field, table-field, aa0218, aa0234, codecop, accessibility, inheritance, specifies]
technologies: [al]
countries: [w1]
application-area: [all]
---
# Every page field needs a `ToolTip` (CodeCop AA0218)
# Every page field needs a `ToolTip` — inline or inherited from the source table field (CodeCop AA0218/AA0234)
## Description
CodeCop AA0218 requires a non-empty `ToolTip` property on every field control on a page. The tooltip is what users see on hover and is what screen readers announce; an empty or missing tooltip removes a piece of UI affordance that is part of BC's accessibility baseline. AppSource technical validation rejects pages with missing tooltips. The companion rules AA0219 and AA0220 push the wording further — tooltips should describe what the field shows, conventionally starting with `'Specifies …'`, though `'Shows …'` and similar variants are acceptable when they clearly describe the field's purpose.
Every field control on a page must present a non-empty tooltip: it is what users see on hover and what screen readers announce, and AppSource technical validation rejects pages without it. The tooltip does not have to be declared on the page control. Since BC 2024 release wave 1 (BC 24, runtime 13.0), table fields carry a `ToolTip` property, a bound page field inherits its source field's tooltip at runtime, and a page-level `ToolTip` acts only as a contextual override. CodeCop AA0234 recommends writing tooltips on table fields, and AA0218 — the rule requiring a tooltip on every page field and action — takes source-field tooltips into account, so it does not fire on a bound page field whose table field defines the text.
The companion rules AA0219 and AA0220 push the wording further — tooltips should describe what the field shows, conventionally starting with `'Specifies …'`, though `'Shows …'` and similar variants are acceptable when they clearly describe the field's purpose.
Acceptable exceptions: table fields inside `Upgrade`, `Migration`, `HybridBC14`, `HybridSL`, and `HybridGP` codeunits and tables are allowed to omit the tooltip — those types are not surfaced to users.
## Best Practice
Every field control on a regular page carries `ToolTip = 'Specifies …';` (or a clear alternative phrasing). Compose the text in the form "what this value shows" rather than "what the user does with it".
Every field control on a regular page carries `ToolTip = 'Specifies …';` (or a clear alternative phrasing). Compose the text in the form "what this value shows" rather than "what the user does with it". The inline property may be omitted when the source already defines the text: the bound table field (BC 24 and later — the preferred single place, per AA0234) or, for `RunObject` actions, the targeted object (see `../ui/runobject-action-inherits-target-object-tooltip.md`).
See sample: `tooltip-required-on-page-fields.good.al`.
## Anti Pattern
A field control with no `ToolTip` property at all, or `ToolTip = '';`. AA0218 flags both; the hover state is blank and the screen reader has nothing to announce.
A field whose tooltip exists nowhere — the source table field declares no `ToolTip` and the page control declares none either — or a control with `ToolTip = '';`. The hover state is blank and the screen reader has nothing to announce; AA0218 flags exactly these cases.
Equally wrong in review: demanding an inline `ToolTip` on a bound page field whose source table field already defines one. The control inherits the table text at runtime; requiring a duplicate on the page is a false positive and reintroduces the pre-BC24 duplication that AA0234 exists to remove (see `../ui/bound-page-field-inherits-source-field-tooltip.md`).
See sample: `tooltip-required-on-page-fields.bad.al`.