Rich Text

AddRecordLink

Description

Appends a record link to the current contents of a RichText object. It takes an item pointer as its sole parameter. This must point to a record.

Syntax

bOK = rt:AddRecordLink(ptr[, strDisplayText])

Parameters

ptr: item pointer: the record to link to.
strDisplayText: string: Optional. The text to display for the link. If not supplied, the record link will be 'automatic' - that is, it will automatically display the record name as the link display text (and the text will update if the name changes).

Return Value

bOK: boolean: true if successful

Remarks

Example <

pi = fhNewItemPtr()
 
... (set pi to point to appropriate record) ...
 
rt = fhNewRichText()
rt:AddText("He inherited the land from ")
rt:AddRecordLink(pi, "his father")