DisplayText Data Attribute (v.22)

Since version 22 Domain API provides data attribute named DisplayText for each entity.
As the name suggests, the value of DisplayText attribute is the display text of the domain object.

The display text is built using string interpolation  of the DisplayTextFormat of the entity.
For example, for customers the default display text format is "{Party.PartyName:T}" - that is the name of the party transliterated in current culture language using the T format specifier for MultiLanguageString.


The display text format for each entity can be customized in the corresponding EntitySettings record of the entity modifying the DisplayTextFormat data attribute.

The default display text format of each entity is defined by the system. For entities that have Code and Name the default display text format is defined by the database configuration option CodeNameFormat - the system default is "{Name}".

Each entity that supports Code and Name provides CodeDataMember and NameDataMember. For example for Products CodeDatamember = PartNumber and NameDataMember = Name; for Customers CodeDataMember = Number and NameDataMember = Party.PartyName.

DefaultDisplayTextFormat, CodeDataMember and NameDataMember can be found in the documentation of each entity.


Here is a link to the technical documentation for DisplayText:



Domain API example

The DisplayText attribute does not participates in the default attributes of the entity - that means it must be included explicitly in the $select clause in order to be included in the result:



Have more questions? Submit a request


Please sign in to leave a comment.
Powered by Zendesk