Home
IBM Domino Designer Basic User Guide and Reference
Basic product usage information and programming language reference information.
Java/CORBA Classes
This section documents the Java/CORBA classes.
Java™ Classes A-Z
RichTextNavigator (Java™)
findNthElement (RichTextNavigator - Java™)
Moves the current position to the element at a specified position within elements of the same type.

IBM Domino Designer Basic User Guide and Reference
Basic product usage information and programming language reference information.
- Accessibility and keyboard shortcuts
  Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- Domino® Query Language
  Domino Query Language (DQL) is a facility running in Domino core allowing for a terse shorthand syntax for finding documents according to a wide variety of complexity of terms. It leverages existing design elements without the need to write detailed code to access them.
- Composite Applications - Design and Management
  Composite applications are a key element in a service-oriented architecture (SOA) and contextual collaboration strategy. The ability to create and edit composite applications lets you easily integrate different types of components and technologies.
- DB2® Access views
  Domino® Designer includes two types of design elements to assist you in managing data contained in DB2® enabled Notes® databases:
- Programming Overview and User Interface
  This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
- Formula Language
  This section documents the formula language.
- LotusScript® Language
  Welcome to the LotusScript® Language section of Domino® Designer Help.
- LotusScript/COM/OLE Classes
- Java/CORBA Classes
  This section documents the Java/CORBA classes.
  - Java™ Classes Coding Guidelines
  - Java™ Classes A-Z
    - Properties and methods with ECL security using Java™
      The following tables list the properties and methods affected by an execute control list (ECL). These properties cannot be accessed or set, and these methods do not execute on the workstation unless the marked ECL priveleges are granted to the signer of the formula.
    - Java™ constants
      The following sections provide contextual information for the constants used by the Java™ classes. Listed are the constant names, their integer values (in parentheses), and the properties and methods in which they are used.
    - Supporting components
      The following classes support the use of Java™ with Notes/Domino and the Domino® Objects:
    - ACL (Java™)
      Represents the access control list (ACL) of a database.
    - ACLEntry (Java™)
      Represents a single entry in an access control list. An entry may be for a person, a group, or a server.
    - AdministrationProcess (Java™)
    - Agent (Java™)
      Represents an agent.
    - AgentContext (Java™)
      Represents the agent environment of the current program, if an agent is running it.
    - ColorObject (Java™)
    - Database (Java™)
      Represents a Notes® database.
    - DateRange (Java™)
      Represents a range of dates and times.
    - DateTime (Java™)
      Represents a date and time.
    - DbDirectory (Java™)
      Represents the Domino® databases on a server or the local computer.
    - Directory (Java™)
      Represents the Notes® directories on a specific server or local computer, each of which is associated with one or more directory navigators to allow directory lookups.
    - DirectoryNavigator (Java™)
      Allows lookups of a specific associated Notes® directory on a specific server or local computer.
    - Document (Java™)
      Represents a document in a database.
    - DocumentCollection (Java™)
      Represents a collection of documents from a database, selected according to specific criteria.
    - DominoQuery (Java)
      Java class to compile, tune, and run Domino Query Language (DQL) queries.
    - DxlExporter (Java™)
    - DxlImporter (Java™)
    - EmbeddedObject (Java™)
      Represents any one of the following:
    - Form (Java™)
      Represents a form in a database.
    - IDVault (Java™)
      The IDVault class is a representation of the secure storage facility for UserIDs that may be configured for Domino by policy. IDs are stored there to allow for easier management by administrators and users. IDs from more than one server may be stored within an IDVault. The IDVault class provides methods to access UserID files, UserID objects, query the presence of an ID in the vault, sycnronise copies of IDs, and reset passwords. The IDVault class can be used to access UserID objects or files. These can be used to accomplish the encryption or decryption of Documents while running on the server.
    - International (Java™)
      Represents the international settings in the operating environment, for example, the Regional Settings in the Windows™ Control Panel. When settings change in the operating environment, Notes® recognizes the new settings immediately. For remote (IIOP) operations, these settings represent the session's server.
    - Item (Java™)
      Represents a discrete value or set of values in a document.
    - Log (Java™)
      Enables you to record actions and errors that take place during a program's execution. You can record actions and errors in:
    - MIMEEntity (Java™)
      Represents an item of type MIME (Multipurpose Internet Mail Extensions).
    - MIMEHeader (Java™)
      Represents a header in a MIME (Multipurpose Internet Mail Extensions) document.
    - Name (Java™)
      Represents a user or server name.
    - Newsletter (Java™)
      Document or set of documents that contains information from, or links to, several other documents.
    - NoteCollection (Java™)
    - NotesCalendar (Java)
      Represents a Domino® calendar.
    - NotesCalendarEntry (Java)
      Represents a Domino® calendar entry.
    - NotesCalendarNotice (Java)
      Represents a Domino® calendar notice.
    - Outline (Java™)
      Represents an outline in a database.
    - OutlineEntry (Java™)
      Represents an entry in an outline.
    - NotesProperty (Java™)
      Represents a single property in the Composite Applications properties of a Domino® application. Properties are data transmitted to or from the Property Broker, which routes your application's communication with other components in a composite application. Properties are defined in a Wiring Properties design element.
    - PropertyBroker (Java™)
      Mediates communication between components of a composite application, allowing communication between multiple Java™ components, or between Notes® and Java components.
    - Registration (Java™)
      Represents the creation or administration of an ID file.
    - Replication (Java™)
      Represents the replication settings of a database.
    - ReplicationEntry (Java™)
    - RichTextDoclink (Java™)
    - RichTextItem (Java™)
      Represents an item of type rich text.
    - RichTextNavigator (Java™)
      - Examples: RichTextNavigator class
        This agent displays the number of elements of each type in the Body item of the current or first selected document.
      - Clone (RichTextNavigator - Java™)
        Creates another RichTextNavigator object with the same position as the current one.
      - findFirstElement (RichTextNavigator - Java™)
        Moves the current position to the first element of a specified type in a rich text item.
      - findFirstString (RichTextNavigator - Java™)
        Moves the current position to the beginning of the first occurrence of a string in a rich text item.
      - findLastElement (RichTextNavigator - Java™)
        Moves the current position to the last element of a specified type in a rich text item.
      - findNextElement (RichTextNavigator - Java™)
        Moves the current position to the next element of a specified type in a rich text item after the current position.
      - findNextString (RichTextNavigator - Java™)
        Moves the current position to the beginning of the next occurrence of a string in a rich text item after the current position.
      - findNthElement (RichTextNavigator - Java™)
        Moves the current position to the element at a specified position within elements of the same type.
        Examples: findNthElement method
        This agent displays each paragraph in the Body item of the current or first selected document in reverse order.
      - getElement (RichTextNavigator - Java™)
        Returns the element at the current position.
      - getFirstElement (RichTextNavigator - Java™)
        Returns the first element of a specified type in a rich text item.
      - getLastElement (RichTextNavigator - Java™)
        Returns the last element of a specified type in a rich text item.
      - getNextElement (RichTextNavigator - Java™)
        Returns the element of a specified type at a position in a rich text item after the current position.
      - getNthElement (RichTextNavigator - Java™)
        Returns the element of a specified type at a specified position in a rich text item.
      - setCharOffset (RichTextNavigator - Java™)
        Sets the current position to an offset from the current position.
      - setPosition (RichTextNavigator - Java™)
        Sets the current position to a specified element in a rich text item.
      - setPositionAtEnd (RichTextNavigator - Java™)
        Sets the current position at the end of a specified element in a rich text item.
    - RichTextParagraphStyle (Java™)
      Represents rich text paragraph attributes.
    - RichTextRange (Java™)
    - RichTextSection (Java™)
    - RichTextStyle (Java™)
      Represents rich-text attributes.
    - RichTextTab (Java™)
      Represents a tab in a rich text paragraph style.
    - RichTextTable (Java™)
    - Session (Java™)
    - Stream (Java™)
      Represents a stream of binary or character data.
    - UserID (Java™)
      The UserID class represents the Notes ID file or a Notes ID when it resides within the Domino IDVault. This object is primarily used to obtain the names of the private encryption keys which are available for use within the UserID object.
    - View (Java™)
      Represents a view or folder of a database and provides access to documents within it.
    - ViewColumn (Java™)
      Represents a column in a view or folder.
    - ViewEntry (Java™)
      Represents a view entry. A view entry describes a row in a view.
    - ViewEntryCollection (Java™)
      Represents a collection of view entries of type document sorted in view order.
    - ViewNavigator (Java™)
      Represents a view navigator. A view navigator provides access to all or a subset of the entries in a view.
- Lotus® Connectors
  Lotus® Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
- Javadoc™ for Domino® Designer related APIs
  As part of providing additional Java™ reference documentation, Domino® Designer ships with a help plugin that contains Javadoc™ for additional Domino Designer related APIs.

findNthElement (RichTextNavigator - Java™)

Moves the current position to the element at a specified position within elements of the same type.

Defined in

RichTextNavigator

Syntax

public boolean findNthElement(int type)
    throws NotesException
public boolean findNthElement(int type, int occurrence)
    throws NotesException

Parameters

int type

RichTextItem.RTELEM_TYPE_DOCLINK
RichTextItem.RTELEM_TYPE_FILEATTACHMENT
RichTextItem.RTELEM_TYPE_OLE
RichTextItem.RTELEM_TYPE_SECTION
RichTextItem.RTELEM_TYPE_TABLE
RichTextItem.RTELEM_TYPE_TABLECELL
RichTextItem.RTELEM_TYPE_TEXTPARAGRAPH
RichTextItem.RTELEM_TYPE_TEXTRUN

int occurrence

The position of the element within elements of the same type in the rich text item. Must be a positive integer. Defaults to 1.

Return value

boolean

true if the element exists and the current pointer is reset
false if the element does not exist and the current pointer is not reset

Usage

This method returns false if the specified position does not exist.

You can use this method as a basis for future navigation, for example, with findNextElement if the occurrence is explicitly specified.