getFirstDocument (NotesViewNavigator - JavaScript)

Returns the first document entry in a view navigator, skipping any category entries.

Defined in

NotesViewNavigator

Syntax

getFirstDocument() : NotesViewEntry
Return value Description
NotesViewEntry The first document entry. Returns null if there are no entries.

Usage

This method moves the current pointer to the retrieved entry unless the return value is null.

Examples

This button gets all the document entries in a view.
var v:NotesView = database.getView("By category");
var nav:NotesViewNavigator = v.createViewNav();
var entry:NotesViewEntry = nav.getFirstDocument();
while (entry != null) {
	requestScope.status += "\n" +
		entry.getColumnValues().elementAt(1).toString();
	var tmpentry:NotesViewEntry = nav.getNextDocument();
	entry.recycle();
	entry = tmpentry;
}