04 Documentation updates
Designer
NotesUIWorkspace PickListCollection method
NotesUIWorkspace PickListCollection method return value has been clarified.
PickListCollection method
Creates a NotesDocumentCollection object from a list selected by the user. You specify a view within a database from which the user can select one or more documents.
Note This method is new with Release 5.
Defined in
NotesUIWorkspace
Syntax
Set notesDocumentCollection = notesUIWorkspace.PickListCollection( type% [, multipleSelection ], server$, databaseFileName$, viewName$, title$, prompt$ [, Singlecategory$ ] )
Parameters
type%
Integer. This parameter is restricted to PICKLIST_CUSTOM (3).
multipleSelection
Boolean. Optional. Specify True if you want to select multiple documents. Defaults to False.
server$
String. Name of the server where the database resides.
databaseFileName$
String. The filename of the database that contains the view.
viewName$
String. Name of the view you want displayed in the dialog box.
title$
String. Title for the dialog box.
prompt$
String. The prompt that you want to appear inside the dialog box.
Singlecategory$
String. Optional. Displays the specified category in the view. The view should be categorized in order to use this parameter.
Return value
This method returns a NotesDocumentCollection object if you click OK. If you click Cancel the Count property is set to 0 and it returns an empty document.
Topics