CaptionML Property

Sets the string that is used to identify a control or other object in the user interface.

Note

To submit an app to AppSource, you must use .xliff translation files. For more information, see Working with Translation Files.

Applies To

  • Codeunit objects

  • XMLport objects

  • Menu objects, menu buttons, menu groups, and menu items

  • Pages, including general page properties and Group, Part, and Field controls.

  • Query objects and query columns

  • Report objects

  • Table objects and table fields

  • XMLport objects

Remarks

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 Multilanguage Development.

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 semicolons to separate entries.

The following example shows a CaptionML value.

CaptionML = DAN='Navn',DEU='Name',ESP='Nombre',FRA='Nom';

In this example, values are set for Danish (DAN), German Standard (DEU), Spanish Traditional Sort (ESP), and French Standard (FRA).

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

The following table shows how the default caption is determined for the various objects in Dynamics 365 Business Central.

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

See Also

Caption Property
Name Property