CaptionML Property
Version: Available or changed with runtime version 1.0.
Sets the text string that displays with the object, control, or other element in user interface for the current language.
Applies to
- Table
- Table field
- Page Field
- Field Group
- Page
- Request Page
- Page Label
- Page Group
- Page Part
- Page System Part
- Page Action
- Page Action Separator
- Page Action Group
- Xml Port
- Report
- Query
- Query Column
- Query Filter
- Report Column
- Enum Value
- Page Custom Action
- Page System Action
- Page File Upload Action
- Page View
- Report Layout
- Profile
- Enum Type
- Permission Set
Syntax
CaptionML = ENU= 'Name',DAN='Navn',ESP='Nombre',FRA='Nom',ENC='Name';
Remarks
Note
To submit an app to AppSource, you must use .xliff translation files. For more information, see Working with Translation Files.
The CaptionML property is multilanguage enabled, so it can contain a list of text strings in different languages. The string that is used is selected according to the user's language settings. For more information, see Working with Translation Files.
The CaptionML property has the following format.
<Language ID>='<caption>'
<Language ID>
is the standard Windows three-letter language ID, and <caption>
is the caption text for this language. Use commas to separate entries.
The following example shows a CaptionML value.
CaptionML = DEU='Name',DAN='Navn',ESP='Nombre',FRA='Nom',ENC='Name';
In this example, values are set for Danish (DAN), German Standard (DEU), Spanish Traditional Sort (ESP), French Standard (FRA), and English Canadian (ENC).
Note
On Role Center type pages, the CaptionML property value is used as the display name for the associated Profile in the client.
Default Values
When the CaptionML property does not include an entry for the language used in the client at runtime, then a default value for the caption string will be used according to the following:
If there is an
ENU
entry, then its caption string is used.If there are no language entries in CaptionML property, then the caption string is determined according to the following table:
Object, control, or other element Default caption Table object Name property Table Field Name property Report Name property XMLport Name property Codeunit Name property Menu button and menu item Name property Page objects and page controls (container, group, part, and field) Name property Query objects Name property Query columns CaptionML property of the underlying table field for the column