Codeunit "Checklist Banner"
Provides functionality to customize the Checklist Banner
Properties
| Name | Value |
|---|---|
| Access | Public |
| Description | Public events for the Checklist Banner |
| InherentEntitlements | X |
| InherentPermissions | X |
Events
OnBeforeUpdateBannerLabels
Integration Event to provide the ability to customize Labels on the Checklist Banner
[IntegrationEvent(False,False)]
internal procedure OnBeforeUpdateBannerLabels(var IsHandled: Boolean, IsEvaluationCompany: Boolean, var TitleTxt: Text, var TitleCollapsedTxt: Text, var HeaderTxt: Text, var HeaderCollapsedTxt: Text, var DescriptionTxt: Text, IsSetupStarted: Boolean, AreAllItemsSkippedOrCompleted: Boolean)
Parameters
| Name | Type | Description |
|---|---|---|
| IsHandled | Boolean |
Whether the labels are handled by the subscriber, set it to false if you want them to be handled by first-party logic |
| IsEvaluationCompany | Boolean |
If the company has type Evaluation |
| TitleTxt | Text |
The title text for the checklist banner |
| TitleCollapsedTxt | Text |
The title collapse text for the checklist banner |
| HeaderTxt | Text |
The header text for the checklist banner |
| HeaderCollapsedTxt | Text |
The header collapse text for the checklist banner |
| DescriptionTxt | Text |
The description text for the checklist banner |
| IsSetupStarted | Boolean |
If setup has started for the checklist banner |
| AreAllItemsSkippedOrCompleted | Boolean |
If all the checklist items are skipped or completed |
OnOpenChecklistBannerPage
Integration Event to provide the ability to skip the welcome state of the checklist banner.
[IntegrationEvent(False,False)]
internal procedure OnOpenChecklistBannerPage(var SkipWelcomeState: Boolean, IsEvaluationCompany: Boolean)
Parameters
| Name | Type | Description |
|---|---|---|
| SkipWelcomeState | Boolean |
Whether to skip the welcome state or not |
| IsEvaluationCompany | Boolean |
If the company has type Evaluation |