renderToRTItem (Document - Java™)

Creates a picture of a document and places it into a rich-text item that you specify.

Defined in

Document

Syntax

public boolean renderToRTItem(RichTextItem rtitem)
    throws NotesException

Parameters

RichTextItem rtitem

The destination for the picture. Cannot be null.

Return value

boolean

If true, the method is successful. If false, the method is not successful and the rich text item remains unchanged. This can happen if an input validation formula fails on the document form.

Usage

The picture is created using both the document and its form. Therefore, the input translation and validation formulas of the form are executed.

If the target rich text item is in a new document, you must save the document before calling renderToRTItem.

Example