GetFirstElement (NotesRichTextNavigator - LotusScript®)

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

Defined in

NotesRichTextNavigator

Syntax

element = notesRichTextNavigator .GetFirstElement( type% )

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)

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.

Example