PromotedActionCategories Property

Version: Available or changed with runtime version 1.0.

Sets a category for a promoted action.

Applies to

• Page

Parameters

Locked
 Type: Boolean
If true the PromotedActionCategories is locked and should not be translated.

Comment
 Type: Text
Descriptive text for the PromotedActionCategories, for example, with regards to translation.

MaxLength
 Type: Integer
Sets the maximum length of the specific PromotedActionCategories property value.

Syntax

PromotedActionCategories = 'New caption,Process caption,Report caption,Category4 caption';

Or, with parameters:

PromotedActionCategories = 'New caption,Process caption,Report caption,Category4 caption', Locked = true, Comment = 'Keep like this, do not translate.', MaxLength = 100;

Remarks

Note

With Business Central 2022 release wave 2, the way that you promote actions on pages or page extensions has changed. Promoting actions is defined in a specific section of the page definition and contains a reference to the action. For more information, see Promoted Actions.

Promoted actions appear in the action bar on a page. You promote an action by setting the Promoted Property to true. You use the PromotedCategory Property to set the category of an action, which allows you to group similar actions under a common caption. You can choose between 20 categories: New, Process, Report, and Category4 through Category20.

By default, the category names are used as the captions in the ribbon. You use this property to customize these captions. The new caption names must be expressed as a string list, where the first three places correspond to the captions of the New, Process and Report categories, respectively, the fourth place to Category4's caption, the fifth to Category5's and so on.

Note

Any empty spaces in the string of promoted action categories are removed. This means that PromotedActionCategories = 'New caption,,,Category4 caption'; is interpreted as PromotedActionCategories = 'New caption,Category4 caption';. To maintain the sequence, you must fill in any empty spaces by, for example, using Category4, Category5 etc.

See Also

Properties
Promoted Property
PromotedActionCategoriesML Property
PromotedCategory Property
Actions Overview