CaptionML Property
Sets the string that is used to identify a control or other object in the user interface.
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.
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).
You can enter values for the CaptionML property in two ways:
If you enter a value for the Caption Property, then the CaptionML property is set to the value of the current language. For example, if the current system language is Danish, then a value of DAN =<value> is placed in the CaptionML field.
If you choose the AssistButton in the CaptionML value field, then the Multilanguage Editor opens and displays two columns: Language and Value. The Language column is populated with all languages that are defined by Windows. You specify the CaptionML value for a language by entering a value in the Value field for that language. You must close the Multilanguage Editor by choosing OK. If you press ESC to close the Multilanguage Editor, then the CaptionML field is not updated.
When you export objects as XML, the CaptionML property values are included.
Note
On Role Center type pages, the CaptionML property value is used as the display name for the associated Profile in the client.
For query columns, when you run the query from Object Designer, the About This Query window that opens in the RoleTailored client displays the value for the Name Property of the query column, not the CaptionML Property.
Default Values
The following table shows how the default caption is determined for the various objects in Dynamics NAV.
| 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 |