createViewNav (View - Java™)

Creates a view navigator for all entries in a view.

Defined in

Syntax

public ViewNavigator createViewNav()
    throws NotesException
public ViewNavigator createViewNav(int cacheSize)
    throws NotesException

Parameters

int 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

ViewNavigator

The new view navigator.

Usage

The navigator contains all entries even if the view is filtered for a full-text search. Use a ViewEntryCollection object to navigate a view filtered by a full-text search.

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.

Language cross-reference

CreateViewNav method in LotusScript® NotesView class

CreateNavigator @command in formula language

Example