GetNextElement (NotesRichTextNavigator - LotusScript®)

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

Defined in

NotesRichTextNavigator

Syntax

element = notesRichTextNavigator .GetNextElement( [ type% ] [, occurrence& ] )

Parameters

type%

Constant. The type of element:

  • 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 find method.

occurrence&

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

element

NotesEmbeddedObject, NotesRichTextDocLink, NotesRichTextSection, or NotesRichTextTable. The requested element.

Usage

A run-time error occurs if you try to get an element of type RTELEM_TYPE_TABLECELL, RTELEM_TYPE_TEXTPARAGRAPH, or RTELEM_TYPE_TEXTRUN. 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 FindFirstElement, FindNextElement, or FindNthElement.

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

Example