GetNthElement (NotesRichTextNavigator - LotusScript®)

Defined in

NotesRichTextNavigator

Syntax

element = notesRichTextNavigator .GetNthElement( 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)

occurrence&

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

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 moves the current position to the position of the retrieved element.

Language cross-reference

getNthElement method in Java™ RichTextNavigator class

Example