createViewNavFrom (NotesView - JavaScript™)

Creates a view navigator for all entries in a view starting at a specified entry.

Defined in

NotesView

Syntax

createViewNavFrom(entry:any) : NotesViewNavigator

createViewNavFrom(entry:any, cacheSize:int) : NotesViewNavigator

Parameter Description
entry A NotesDocument or NotesViewEntry object representing the starting entry. Cannot be null.
cacheSize The size of the navigator cache in view entries. Legal values are 0 (no cache) through 128 (default). Applies only to remote (IIOP) operations.
Return value Description
NotesViewNavigator The new view navigator.

Usage

The first entry in the navigator is the specified entry. The remaining entries are all the entries in the view that follow the first entry.

If the object is not found, the result is an empty navigator. All navigation methods return null.

The cache enhances performance for iterative processing of entries using the navigation methods that do not take a parameter.

Examples

This button gets all the entries in a view starting at the current document.
var v:NotesView = database.getView("main");
var nav:NotesViewNavigator = v.createViewNavFrom(currentDocument.getDocument());
var entry:NotesViewEntry = nav.getFirst();
while (entry != null) {
	requestScope.status += "\n" + 
		entry.getColumnValues().elementAt(0);
	var tmpentry = nav.getNext();
	entry.recycle();
	entry = tmpentry;
}