DisplayNameHeader

Description

Returns the unique keys of the attachments in this field.

This is a read-only property; it can be viewed but not set. The unique keys are set using HCL Compass Designer, not the HCL Compass API.

Syntax

VBScript

attachmentField.DisplayNameHeader 

Perl

$attachmentField->GetDisplayNameHeader(); 

Identifier

Description

attachmentField

An AttachmentField object representing one attachment field of a record.

Return value

For Visual Basic, Variant containing an Array whose elements are strings. Each String contains the DisplayName of one Attachment Object associated with this field.For Perl, a reference to an array of strings.

Example

VBScript

' This example assumes there is at least 1 attachment field 
' associated with the record. 
set sessionObj = GetSession

set attachFields = entity.AttachmentFields 
set attachField1 = attachFields.Item(0) 

keys = attachField1.DisplayNameHeader 
x = 0 
For Each key in keys 
     sessionObj.OutputDebugString "Displaying key number " & x & " - " & key 
& vbcrlf
     x = x + 1 
Next 

Perl

# This example assumes that there is at least 1 attachment

# field associated with the record. Otherwise, GetAttachmentFields

# won't return anything interesting and an error would be generated

$session = $entity->GetSession();

# Get the collection of attachment fields

$attachfields = $entity->GetAttachmentFields();



# Get the first attachment fields

$attachfield1 = $attachfields->Item(0)



# Get the list of unique keys for identifying each attachment.

$keys = $attachfield1->GetDisplayNameHeader();



# Iterate through the list of keys and print the key value

$x = 0;

foreach $key (@$keys)

 {

 $session->OutputDebugString("Displaying key number".$x." - 
      ".$key);

 $x++;

 }