Represents a view navigator. A view navigator provides access to all or a subset of the entries in a view.

Note This class is new with Release 5.

Containment

Contained by: NotesView

Contains: NotesViewEntry

Properties

CacheSize

Count

MaxLevel

ParentView

Methods

GetChild

GetCurrent

GetEntry

GetFirst

GetFirstDocument

GetLast

GetLastDocument

GetNext

GetNextCategory

GetNextDocument

GetNextSibling

GetNth

GetParent

GetPos

GetPrev

GetPrevCategory

GetPrevDocument

GetPrevSibling

GotoChild

GotoEntry

GotoFirst

GotoFirstDocument

GotoLast

GotoLastDocument

GotoNext

GotoNextCategory

GotoNextDocument

GotoNextSibling

GotoParent

GotoPos

GotoPrev

GotoPrevCategory

GotoPrevDocument

GotoPrevSibling

MarkAllRead

MarkAllUnread

Creation

You create a view navigator through the following NotesView methods:

CreateViewNav

CreateViewNavFrom

CreateViewNavFromAllUnread

CreateViewNavFromCategory

CreateViewNavFromChildren

CreateViewNavFromDescendants

Returned is a NotesViewNavigator object that represents some or all of the entries in the view.

Usage

You can navigate through the documents in a view with the NotesView methods.

NotesViewNavigator differs from NotesView in the following ways:

• ViewNavigator returns a ViewEntry object instead of a document (ViewEntry contains information such as SiblingCount, view position, etc.)
• It lets you access categories and totals, as well as documents.
• Users can create navigators from subsets of views, for example, all children of an entry.

Automatic updates: avoid

Avoid automatically updating the parent view by explicitly setting AutoUpdate to False. Automatic updates degrade performance and may invalidate entries in the navigator ("Entry not found in index"). You can update the view as needed with Refresh.

Duplicate entries

Duplicate entries exist when a document is categorized under multiple categories. Navigating over duplicate entries works except in the following situations:

• GetEntry method returns the first ViewEntry instance for the document.
• Navigators constructed from an object that did not come from the current view return the first instance of the object.

LotusScript Classes A-Z
Accessing NotesViewNavigator properties
Accessing entries in a view navigator

Glossary