Skip to content

docs(AC0011): document HeadlinePart field control exception #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Arthurvdv wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(AC0011): document HeadlinePart field control exception #146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions content/docs/analyzers/ApplicationCop/AC0011.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ The rule checks the following elements for an explicit `Caption`, `CaptionClass`
### Exception

- **API pages** — pages with `PageType = API` and all controls and actions within them are exempt. API pages serve data to integrations and do not render captions in the client.
- **Field controls on HeadlinePart pages** — the runtime ignores the `Caption` property on field controls of pages with `PageType = HeadlinePart`; only `Expression`, `Visible`, `ApplicationArea`, `Drilldown`, and `DrillDownPageID` apply there. Field controls are exempt, including fields added through a page extension that extends a HeadlinePart page. The page object, actions, and groups on HeadlinePart pages are still checked.
- **Page fields sourced from a table field** — when a page field references a table field (`field(MyField; Rec."My Field")`), the diagnostic is raised only if both the page field and the underlying table field lack a Caption.
- **Page parts referencing another page** — a part control only triggers the diagnostic when both the part and the related page lack a Caption.
- `ShowCaption = false` — controls where the caption is explicitly hidden are not checked.
Expand All @@ -86,4 +87,5 @@ The rule checks the following elements for an explicit `Caption`, `CaptionClass`
### See also

- [Caption Property](https://learn.microsoft.com/dynamics365/business-central/dev-itpro/developer/properties/devenv-caption-property) on Microsoft Learn
- [Creating a Role Center Headline](https://learn.microsoft.com/dynamics365/business-central/dev-itpro/developer/devenv-create-role-center-headline#in-development) on Microsoft Learn
- [Working with Translation Files](https://learn.microsoft.com/dynamics365/business-central/dev-itpro/developer/devenv-work-with-translation-files) on Microsoft Learn