Skip to main content

AppendDocLink (NotesRichTextItem - LotusScript)

Inserts a doclink in a rich text item.

Defined in

NotesRichTextItem

Syntax

Call notesRichTextItem .AppendDocLink( linkTo , comment$ [, HotSpotText$ ] )

Parameters

linkTo

NotesDatabase, NotesView, or NotesDocument. The database, view, or document to which you want to link.

comment$

String. The text that appears when a user presses and holds the mouse pointer over the doclink.

HotSpotText$

Note: This parameter is new with Release 5.

Optional. String. If supplied, the HotSpotText appears in the rich text item as boxed text which can be clicked on with the mouse to follow the doclink. In this case, no other token appears in the text.

Usage

By default the insertion occurs at the end of the item. You can change the insertion point with BeginInsert and EndInsert.

For this method to work you must set a default view in the database.

In an open document in edit mode (the NotesDocument via NotesUIDocument.Document), changes made to rich text will not appear on screen immediately as they would with fields of other types. There is no method to cause this update to occur. You must close and reopen the document to see changes.

Example