NotesDocumentCollection
Properties
| Name | Description |
|---|---|
| Count (NotesDocumentCollection) | Read-only. The number of documents in a collection. |
| IsSorted (NotesDocumentCollection) | Read-only. Indicates whether the documents in a collection are sorted. A collection is sorted only when it results from a full-text search of a database. |
| Parent (NotesDocumentCollection) | Read-only. The database that contains a document collection. |
| Query (NotesDocumentCollection) | Read-only. The text of the query that produced a document collection, if the collection results from a full-text or other search. |
| UntilTime (NotesDocumentCollection) | Read-only. The database end time for a collection obtained through GetModifiedDocuments in NotesDatabase. |
Methods
| Name | Description |
|---|---|
| AddDocument | Adds a document to a document collection. |
| Clone (NotesDocumentCollection) | Returns a NotesDocumentCollection object which is a copy of the original collection. |
| Contains (NotesDocumentCollection) | Indicates whether or not a NotesDocumentCollection contains all of the given NotesDocuments or all of the NotesDocuments associated with the given… |
| DeleteDocument (NotesDocumentCollection) | Deletes a document from a collection (not from the disk). |
| FTSearch (NotesDocumentCollection) | Conducts a full-text search of all the documents in a Notes® document collection, and reduces the collection to those documents that match. |
| GetDocument | Returns the entry in the collection that corresponds to the specified document. |
| GetFirstDocument (NotesDocumentCollection) | Gets the first document in a collection. |
| GetLastDocument (NotesDocumentCollection) | Gets the last document in a collection. |
| GetNextDocument (NotesDocumentCollection) | Given a document, finds the document immediately following it in a collection. |
| GetNthDocument (NotesDocumentCollection) | Given a position number, returns the document at that position in a collection. |
| GetPrevDocument (NotesDocumentCollection) | Given a document, finds the document immediately preceding it in a collection. |
| Intersect (NotesDocumentCollection) | Removes from a document collection any documents not also contained in a second collection. |
| Merge (NotesDocumentCollection) | Adds to a document collection any documents not already in the collection that are contained in a second collection. |
| PutAllInFolder (NotesDocumentCollection) | Adds all the documents in the collection to the specified folder. If the folder does not exist in the document's database, it is created. |
| RemoveAll (NotesDocumentCollection) | Deletes all documents in a collection from a database. |
| RemoveAllFromFolder (NotesDocumentCollection) | Removes all documents in the collection from the specified folder. |
| StampAll (NotesDocumentCollection) | Replaces the value of a specified name in all documents in a collection. |
| StampAllMulti (NotesDocumentCollection) | Replaces the values of specified items in all documents in a document collection. |
| Subtract (NotesDocumentCollection) | Removes from a document collection any documents contained in a second collection. |
| UpdateAll (NotesDocumentCollection) | Marks all documents in a collection as processed by an agent. |
Examples
| Name | Description |
|---|---|
| Examples: Clone method (NotesDocumentCollection) | This example searches the current database for all active followup forms with a followup date of tomorrow, assigns the low priority documents a followup… |
| Examples: Contains method (NotesDocumentCollection) | This example prohibts deletion from a view unless the caret document is among those being deleted. |
| Examples: Count property (NotesDocumentCollection) | 1. This script displays the total number of documents in the collection containing the word "Business." |
| Examples: DeleteDocument method (NotesDocumentCollection) | This example deletes the first document in the collection and puts the remaining documents in a folder called "My Favorites." |
| Examples: FTSearch method (NotesDocumentCollection) | This script collects all of the documents in the Business category of a database that contain the word "Presentations" and mails the document links to… |
| Examples: GetFirstDocument method (NotesDocumentCollection) | This script gets the first document in a collection and copies it to another database. |
| Examples: GetLastDocument method (NotesDocumentCollection) | This script gets the last document in a collection, and copies it to another database. |
| Examples: GetNextDocument method (NotesDocumentCollection) | This script displays the authors of the second document in a collection. |
| Examples: GetNthDocument method (NotesDocumentCollection) | This script gets the third document in a collection and sends it to Jen Smith. |
| Examples: GetPrevDocument method (NotesDocumentCollection) | This script gets the second-to-last document in a collection, and assigns it to the secondToLastDoc object. |
| Examples: Intersect method (NotesDocumentCollection) | This example tests a payroll database for a multi-state company to locate all the employees who need special handling because they worked in two… |
| Examples: IsSorted property (NotesDocumentCollection) | This script checks if a collection is sorted. Since the collection is produced using the FTSearch method, the IsSorted property is True and the script… |
| Examples: MarkAllRead method (NotesDocumentCollection) | This example marks all the documents returned by a full-text search as read. |
| Examples: MarkAllUnread method (NotesDocumentCollection) | This example marks all the documents returned by a full-text search as unread. |
| Examples: Merge method (NotesDocumentCollection) | This example searches a customer support database for all customers that have either bought a product or called for support within the past month, then… |
| Examples: Parent property (NotesDocumentCollection) | This script gets the parent database of a collection. Since db and parentDb represent the same database, this script prints the title of MOTHER.NSF twice. |
| Examples: Query property (NotesDocumentCollection) | 1. This script gets a collection of documents that match a full-text search query. The Query property returns "white wine." |
Reference
| Name | Description |
|---|---|
| MarkAllRead (NotesDocumentCollection) | Marks all the documents in a collection read. |
| MarkAllUnread (NotesDocumentCollection) | Marks all the documents in a collection unread. |