|
|
|
|
|
|
|
|
|
|
|
|
|
|
PROGRAMMING POWER
New Release 5.0 classes: NotesViewEntryCollection and NotesViewEntry
By Tony Patton
This month we continue the coverage of LotusScript enhancements in Domino 5.0. We focus on two new classes: NotesViewEntryCollection and NotesViewEntry. These classes allow you to work with individual elements in a view.
Using the NotesView class in Notes 4.x
In Notes 4.x, the NotesView class could be used to access documents in a view. The example below demonstrates using it to scroll through all documents in a view.
Dim session As New NotesSession
Dim db As NotesDatabase
Dim doc As NotesDocument
Dim view As NotesView
Set db = session.CurrentDatabase
Set view = db.GetView("viewName")
Set doc = view.GetFirstDocumetn
While Not (doc Is Nothing)
... code to work with document ...
Set doc = view.GetNextDocument(doc)
Wend
|
The NotesView class works well, but it only allows you to access documents in a view. In addition to documents, a view can contain categories and totals.
Using the Release 5.0 NotesViewCollection class
This is where the NotesViewCollection class comes into play. It lets you access all elements in a view, and it can tell you various characteristics of each element.
The next example demonstrates putting the NotesViewEntryCollection class to use.
Dim session As New NotesSession
Dim db As NotesDatabase
Dim view As NotesView
Dim vecoll As NotesViewEntryCollection
Dim entry As NotesViewEntry
Set db = session.CurrentDatabase
Set view = db.GetView("viewName")
Set vecoll = view.AllEntries
Set entry = vecoll.GetFirstEntry
While Not (entry Is Nothing)
... code to work with view entry object...
Set entry = vecoll.GetNextEntry(entry)
Wend
|
As you can see, the NotesViewEntryCollection works the same as a NotesDocumentCollection. You set the NotesViewEntryCollection using the AllEntries property of the NotesView object. Once the object is set, you can scroll through all entries using the GetFirstEntry and GetNextEntry properties of the NotesViewEntryCollection object. These methods return a NotesViewEntry object.
Using the NotesViewEntry class
The NotesViewEntry class contains numerous properties and methods that signal the characteristics of the entry.
Table A below shows the properties that exist for NotesViewEntry objects.
| Property |
Description |
| ChildCount |
Contains the number of children in the entry. |
| DescendantCount |
Contains the number of entries under the current entry. |
| IndentLevel |
Contains the number of levels the current entry is indented. |
| IsCategory |
Signals true or false whether the entry is a category or not. |
| IsDocument |
Signals true or false whether the entry is a NotesDocument object or not. |
| IsTotals |
Signals true or false whether the current entry contains totals or not. |
| SiblingCount |
Contains the number of entries at the same level of the current entry. |
| Document |
Contains the NotesDocument object of an entry, if it is a NotesDocument. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
-- Advertisement --
Learn Notes and Domino 8 at your place and pace!
Learn Notes and Domino in your office and/or home! TLCC's highly acclaimed distance learning courses for users, developers, and admins will enhance your career and your resume.
The many included activities and demos will make you a pro! Expert instructor help is a click away.
Click here to try a FREE demo course!! |
-- Advertisement --
Mark your calendar for in-depth Lotus training, May 12-14, Boston
Join experts and peers May 12-14 in Boston for educational and networking events that deliver real-world Lotus training so you can increase productivity and efficiency in your company, advance your skills, and squeeze the most from your current environment. One registration gets you into THE VIEW's Admin2010 and Lotus Developer2010.
Register by April 10 to save $200. |
|
|
|
|
|
|
|
|
|
|
