getElement (RichTextNavigator - Java)

Returns the element at the current position.

Defined in

RichTextNavigator

Syntax

public Base getElement()
    throws NotesException

Return value

Base

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

This method does not change the current position.

An exception occurs occurs if a valid position does not exist. You must precede this method with a valid find method.

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.

Example