Represents a collection of documents from a database, selected according to specific criteria.

Containment

Contained by: NotesDatabase, NotesSession, NotesUIDatabase, NotesUIView, NotesUIWorkspace

Contains: NotesDocument

Properties

Count

IsSorted

Parent

Query

UntilTime

Methods

AddDocument

Clone

Contains

DeleteDocument

FTSearch

GetDocument

GetFirstDocument

GetLastDocument

GetNextDocument

GetNthDocument

GetPrevDocument

Intersect

MarkAllRead

MarkAllUnread

Merge

PutAllInFolder

RemoveAll

RemoveAllFromFolder

StampAll

StampAllMulti method

Subtract

UpdateAll

Access

A NotesDocumentCollection represents a subset of all the documents in a database. The documents in the subset are determined by the NotesDatabase method or property you use to search the database, which can be any of the following:

• AllDocuments property in NotesDatabase
• FTSearch method in NotesDatabase
• FTSearchRange method in NotesDatabase
• Search in NotesDatabase
• GetAllReadDocuments method in NotesDatabase
• GetAllUnreadDocuments method in NotesDatabase
• GetProfileDocCollection method in NotesDatabase
• GetModifiedDocuments method in NotesDatabase
• GetAllDocumentsByKey method in NotesView
• UnprocessedDocuments property in NotesDatabase
• UnprocessedFTSearch method in NotesDatabase
• UnprocessedFTSearchRange method in NotesDatabase
• UnprocessedSearch method in NotesDatabase
• Responses property in NotesDocument
• PickListCollection method in NotesUIWorkspace
• Documents property in NotesUIView
• Documents property in NotesUIDatabase

Both NotesDocumentCollection and NotesView objects provide access to documents within a database. Use a NotesDocumentCollection object if:

• You want to act on a specific set of documents that meet certain criteria.
• There is no view in the database that contains every document you need to search.
• You do not need to navigate the documents' response hierarchies.

Ordering of documents

The documents in a collection are ordered when the collection results from a full-text search; otherwise, the documents are unordered.

Current pointer

A current pointer is maintained for document collections. All navigation methods set the current pointer to the retrieved document with the following exceptions. Add and delete methods do not move the current pointer. The following methods set the current pointer to the first document: FTSearch, RemoveAll (remote IIOP only), PutAllInFolder, RemoveAllFromFolder, and StampAll.

Deletion stubs

A deletion stub is returned for a document deleted after creation of the collection or for a document to which you do not have read access. Use IsValid in NotesDocument to check whether a document is real (True) or a deletion stub (False).

Example
See Also

LotusScript Classes A-Z
Collecting all documents and unprocessed documents
Using the Domino classes

Glossary