appendDocLink (RichTextItem - Java™)

Adds a doclink to a rich text item.

Defined in

Syntax

public void appendDocLink(Document doc)
    throws NotesException
public void appendDocLink(Database db)
    throws NotesException
public void appendDocLink(View vw)
    throws NotesException
public void appendDocLink(Document doc, String comment)
    throws NotesException
public void appendDocLink(Database db, String comment)
    throws NotesException
public void appendDocLink(View vw, String comment)
    throws NotesException
public void appendDocLink(Document doc, String comment, String hotspottext)
    throws NotesException
public void appendDocLink(Database db, String comment, String hotspottext)
    throws NotesException
public void appendDocLink(View vw, String comment, String hotspottext)
    throws NotesException

Parameters

Document doc

The document to which you want to link.

Database db

The database to which you want to link.

View vw

The view to which you want to link.

String comment

The text that appears when a user presses and holds the mouse over the link.

String hotspottext

Boxed text which the user clicks to follow the link. This text appears in place of a token.

Usage

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

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.

Language cross-reference

AppendDocLink method in LotusScript® NotesRichTextItem class

EditMakeDocLink @command in formula language

Example