createViewNavMaxLevel (NotesView - JavaScript)

Creates a view navigator for all entries in a view down to a specified level.

Defined in

NotesView

Syntax

createViewNavMaxLevel(level:int) : NotesViewNavigator

createViewNavMaxLevel(level:int, cacheSize:int) : NotesViewNavigator

Parameter Description
level The maximum level of navigation 0 (top level) through 30 (default).
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 entries in the navigator are all the entries in the view at levels 0 through the specified level.

An empty view results in 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 top-level entries in a view.
var v:NotesView = database.getView("main");
var nav:NotesViewNavigator = v.createViewNavMaxLevel(0);
var entry:NotesViewEntry = nav.getFirst();
while (entry != null) {
	requestScope.status += "\n" + 
		entry.getColumnValues().elementAt(0);
	var tmpentry = nav.getNext();
	entry.recycle();
	entry = tmpentry;
}