getNextElement (NotesRichTextNavigator - JavaScript™)

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

Defined in

NotesRichTextNavigator

Syntax

getNextElement() : NotesBase

getNextElement(type:int) : NotesBase

getNextElement(type:int, occurrence:int) : NotesBase

Parameter Description
int type
  • RTELEM_TYPE_DOCLINK (5)
  • RTELEM_TYPE_FILEATTACHMENT (8)
  • RTELEM_TYPE_OLE (9)
  • RTELEM_TYPE_SECTION (6)
  • RTELEM_TYPE_TABLE (1)
Defaults to the type last specified by a get method.
int occurrence The position of the element, within elements of the specified type, relative to the current position; 1 means the next element, 2 means the element after the next element, and so on. Must be a positive integer; you cannot use this method to find preceding elements. Defaults to 1.
Return value Description
Base EmbeddedObject, RichTextDocLink, RichTextSection, or RichTextTable. The requested element. Returns null if there is no element.

Usage

An exception occurs if you try to get an element of type RTELEM_TYPE_TABLECELL (7), RTELEM_TYPE_TEXTPARAGRAPH (4), or RTELEM_TYPE_TEXTRUN (3). Access these elements through NotesRichTextRange.

This method fails if a current position does not exist, for example, if you use this method without first calling getFirstElement, getNextElement, or getNthElement.

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