display_text

Field.display_text

Domain:

client

Language:

javascript

Class:

Field()

Description

Represents the field’s value as a string.

Display_text property is a read-only string representation of a field’s value to display in a data-aware control. If an on_field_get_text event handler is assigned, display_text is the value returned by this event handler. Otherwise, display_text is the value of the lookup_text property for lookup fields , and text property, converted according to the language locale settings, for other fields.

Display_text is the string representation of the field’s value property when it is not being edited. When the field is being edited, the text property is used.

Example

function on_field_get_text(field) {
    if (field.field_name === 'customer' && field.value) {
        return field.owner.firstname.lookup_text + ' ' + field.lookup_text;
    }
}

See also

Related attributes

• text

• lookup_text

Related functions

• on_field_get_text

Related concepts

• Fields

• Lookup fields