getNthElement (RichTextNavigator - Java™)

Returns the element of a specified type at a specified position in a rich text item.

Defined in

RichTextNavigator

Syntax

public Base getNthElement(int type, int occurrence)
    throws NotesException

Parameters

int type
  • RichTextItem.RTELEM_TYPE_DOCLINK
  • RichTextItem.RTELEM_TYPE_FILEATTACHMENT
  • RichTextItem.RTELEM_TYPE_OLE
  • RichTextItem.RTELEM_TYPE_SECTION
  • RichTextItem.RTELEM_TYPE_TABLE
int occurrence

The position of the element within elements of the same type in the rich text item.

Return value

element

EmbeddedObject, RichTextDocLink, RichTextSection, or RichTextTable. The requested element. You must cast the return value to the type required. Returns null if there is no element.

Usage

An exception occurs occurs if you try to get an element of type RTELEM_TYPE_TABLECELL, RTELEM_TYPE_TEXTPARAGRAPH, or RTELEM_TYPE_TEXTRUN. Access these elements through RichTextRange.

This method moves the current position to the position of the retrieved element.

Example