GetFormattedText (NotesRichTextItem - LotusScript®)

Returns the contents of a rich text item as plain text.

Defined in

NotesRichTextItem

Syntax

plainText$ = notesRichTextItem .GetFormattedText( tabstrip , lineLength% )

Parameters

tabstrip

Boolean. If True, tabs are replaced by spaces in the resulting plain text. If False, tabs are retained.

lineLength%

Integer. Number of characters at which to wrap (carriage return and line feed) lines of text. Zero means 80 characters. Words without white space are not wrapped.

Return value

plainText$

String. The contents of the rich text item, as plain text.

Usage

This method omits non-text data, such as bitmaps and file attachments.

Use GetUnformattedText if you don't want to wrap or strip tabs.

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

getFormattedText method Java RichTextItem class

@Text function in formula language

@Abstract function in formula language

Example