Lotus Software logo
IBM Lotus Domino Designer 8.5
  Versions 8.5 and 8.5.1






getFormattedText method

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

Defined in

RichTextItem

Syntax

public String getFormattedText(boolean tabstrip, int linelen, int maxlen)

throws NotesException

Parameters

boolean tabstrip

If true, tabs are replaced by spaces in the resulting plain text. If false, tabs are retained.

int 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.

int maxlen

Maximum number of characters to return. Set to 0 for the default.

Return value

String

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

Usage

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

Language cross-reference

GetFormattedText method in LotusScript NotesRichTextItem class

@Text function in formula language

@Abstract function in formula language

See examples

Examples: getFormattedText method
Related topics
Getting text renditions of rich text items in Java classes




Library | Support | Terms of use |

Last updated: Monday, October 5, 2009