getFormattedText (NotesRichTextItem - JavaScript)

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

Defined in

NotesRichTextItem

Syntax

getFormattedText(tabstrip:boolean, linelen:int, maxlen:int) : string
Parameter Description
tabstrip If true, tabs are replaced by spaces in the resulting plain text. If false, tabs are retained.
linelen 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.
maxlen Maximum number of characters to return. Set to 0 for the default.
Return value Description
string The contents of the rich text item, as plain text.

Usage

This method strips out non-text data, such as bit maps and file attachments.