GetDisplayNameAsList

Description

Returns the field values that comprise the unique key (also known as a display name) of the Entity as an array. The array includes empty elements for fields that have no value. This method is similar to GetDisplayName but returns each unique key field value as a separate element of the returned String array. The field values are returned in the unique key order specified by the schema.

For state-based record types, the unique key is the record's visible ID, which has the format DBnnnnnn (for example, PASNY00012332), where DB is the database name and nnnnnn is the record number.

For stateless record types, the unique key is formed from the values of the unique key fields defined by the administrator. If there is just a single unique key field, its value will be the unique key. If there are multiple fields forming the unique key, their values will be concatenated in the order specified by the administrator. For state-based record types, calling this method is equivalent to getting the value of the "id" system field using a FieldInfo Object.

The unique key should not be confused with the database ID, which is not visible to the user. The database ID is retrieved by the GetDbId method.

Note: This method became available in version 7.1.

Syntax

VBScript


entity.GetDisplayNameAsList

Perl


$entity->GetDisplayNameAsList();

Identifier: Description
entity: An Entity object representing a user data record. Inside a hook, if you omit this part of the syntax, the Entity object corresponding to the current data record is assumed (VBScript only).
Return value: An array of Strings containing the record's unique key. Each string contains the value or values stored for each of the specified field names. For VBScript, a Variant containing an array of Strings. For Perl, a reference to an array of Strings.