GetNextSibling (NotesView - LotusScript®)
Given a document in a view, returns the document immediately following the given document at the same level. If you send the method a main document, the next main document in the view is returned. If you send a response document, the next response document with the same parent is returned.
If the view is categorized, the next sibling must be in the same category as the original document.
Defined in
Syntax
Set notesDocument = notesView .GetNextSibling( document )
Parameters
document
A NotesDocument. Any document in the view. If you specify Nothing, this method generates an error.
Return value
notesDocument
A NotesDocument. The document following the specified document, at the same level in the view. Returns Nothing if there are no more siblings.
Usage
You can use GetNextSibling to:
- Move from one main document to the next, skipping any response documents in between
- Visit the response documents of a particular parent document (use GetChild to find the first response)
- Visit the response-to-response documents of a particular parent document (use GetChild to find the first response-to-response)
If the specified view is different from the current view, the GetNextSibling method returns the following error: "Document not found in <view>." That is, you can only navigate using the Document parameters that are from the same view in which you are navigating.
If you have filtered the view with FTSearch, GetNextSibling returns the next document in the view, regardless of level.
Siblings
Two documents are siblings if:
- They are both main documents, or
- They are both responses or response-to-responses and they share the same parent document
The last sibling
GetNextSibling returns Nothing when the notesDocument parameter is:
- The last main document in a view
- The last main document in a particular category of a view
- The last response (or response-to-response) to a particular parent