GetNotesFont (NotesRichTextItem - LotusScript®)

Returns an identifier for a font face in a document.

Note: This method is new with Release 6.

Defined in

NotesRichTextItem

Syntax

notesFont% = notesRichTextItem .GetNotesFont( faceName$ , addOnFail )

Parameters

faceName$

String. The name of the font face, which must be valid for the platform on which the agent is running.

addOnFail

Boolean.

  • True assigns an identifier for the font face if one is not already assigned in the current document.
  • False (default) returns 0 if an identifier is not assigned for the font face in the current document.

Return value

notesFont%

Integer. The identifier associated with the specified font face, or 0.

Usage

The identifier can be used to set NotesFont in NotesRichTextStyle.

Identifiers assigned by GetNotesFont are in the range 5 through 254.

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