Displays a modal window that contains either:

• A view you specify from which the user can select one or more documents. @PickList returns a column value from the selected document(s).
• A dialog box, displaying information from all available Domino Directories. The user can select one or more person, group, server, room, or resource names, and @PickList returns those names.

@PickList( [CUSTOM] : [SINGLE] ; server : file ; view ; title ; prompt ; column ; categoryname )

@PickList( [NAME] : [SINGLE] )

@PickList( [ROOM] )

@PickList( [RESOURCE] )

@PickList( [FOLDERS] : [SINGLE] ; server:database )

@PickList( [FOLDERS] : [SHARED] ; server:database )

@PickList( [FOLDERS] : [PRIVATE] ; server:database )

@PickList( [FOLDERS] : [NODESKTOP] ; server:database )

Parameters

[CUSTOM]

Keyword. Indicates that you want to display a view in a dialog box.

Keyword. Opens dialog box for selecting one or more names.

[SINGLE]

Keyword. Optional. Limits the selection to a single document.

Keyword. Opens dialog box for selecting room.

Keyword. Opens dialog box for selecting resources.

Keyword. Returns a multi-select, text list of all folder names both in the database and from the desktop. The following keywords can be combined with [Folders]:

[SINGLE]

Keyword. Optional. Limits selection to a single folder.

[SHARED]

Keyword. Optional. Limits selection to only shared folders.

[PRIVATE]

Keyword. Optional. Limits selection to only private folders (both in the database and on the desktop).

[SHARED]:[PRIVATE]

Keyword. Optional. Includes in selection all shared and private folders.

[NODESKTOP]

Keyword. Optional. Excludes folders in the desktop from selection.

Text list. The server is the name of the server where the database is. The file is the path and file name of the database you want to open. Specify the name and location of the database using the appropriate format for the operating system.

You can use a replica ID in place of a server and file name as the parameter following the [custom] keyword only. The replica ID must be text and must include the colon between the two sets of eight hex digits. For example:

@PickList([CUSTOM]; "852564A0:006B7872"; "By Category"; "Testing replica ID"; "Test prompt"; 3)

Use "" to specify the currently open database.

Text. The name of the view that you want to open in the database.

Text. The window title for the dialog box.

Text. The prompt that you want to appear inside the dialog box. Only one line of text is displayed. Longer lines are truncated.

Number. A number indicating which column value you want @PickList to return. Use 1 to indicate the first column, 2 to indicate the second column, and so on. Unlike @DbColumn and @DbLookup, @PickList counts all columns, regardless of the types of formula they contain.

Note This parameter is new with Release 5.

Text. Optional. Displays the specified category in the view. The view should be categorized in order to use this parameter.

columnValue

Text list. The value(s) in the specified column for the document(s) that the user selected.

This function is useful in button, manual agent, paste agent, form action, and view action formulas. It does not work in column, selection, mail agent, scheduled agent, hide-when, window title, or form formulas.

Although @PickList([CUSTOM]) operates similarly to @DbColumn and @DbLookup, @PickList is preferable because it:

• Stores more data
• Performs the lookup faster
• Allows you to quickly locate the desired document by typing the first few characters

For a calendar view, @PickList displays two days starting with today, without time slots. The user can click on the date picker button to navigate to other days.

You cannot use this function in Web applications.

@PickList can return no more than 64K bytes of data. Use the following equations to determine how much of your data can be returned using @PickList.

For lookups that return text:

2 + (2 * number of entries returned) + total text size of all entries

For lookups that return numbers or dates:

(10 * number of entries returned) + 6

However, @PickList can access a view of any size, so there are no limits to the number of choices it can present. Only the return value is limited in size.

Language cross-reference

PickListStrings method of LotusScript NotesUIWorkspace class

Example
See Also

@DbColumn (Domino data source)
@DbColumn (ODBC data source)
@DbLookup (Domino data source)
@DbLookup (ODBC data source)
@DialogBox
Getting user input with @Prompt and @PickList
@Prompt
R4 LotusScript picklist code example from the Sandbox on the Lotus Developer Domain
"Taking your Domino applications to the Web" on the Lotus Developer Domain

Glossary