Accesses view and folder information from a Domino database in Web applications.

Note This @function is new with Release 6.

Syntax

@DbCommand( "Domino" ; "ViewNextPage" )

@DbCommand( "Domino" ; "ViewPreviousPage" )

@DbCommand( "Domino" ; "FolderList" ; promptString ; foldersToExclude )

Parameters

"Domino"

String argument. Indicates that you want to access a Domino data source.

String argument. Displays the next chunk of documents in an embedded view.

String argument. Displays the previous chunk of documents in an embedded view.

String argument. Indicates that you want to display a list of the names of folders in the database that are accessible from the Web.

String. Optional. Use only if including "FolderList" string argument. String to display as the first choice in a Listbox field. If you want the first choice in the list to be "Select a folder," specify:

@DbCommand("Domino" ; "FolderList" ; "Select a folder")

Textlist. Optional. Use only if including "FolderList" string argument. Names of the folders you do not want to display in the listbox field. If you do not want the "MyStuff" and "Problems" folders to be included in the list, specify:

@DbCommand("Domino" ; "FolderList" ; "Select a folder" ; "MyStuff" : "Problems")

You cannot use this function to access a Domino data source in the Notes client.

Use the FolderList string argument with the @DbCommand in a selection formula for a Listbox field that is set to Use formula for choices to display a list of available folders in a Web application. If no folders exist, the Listbox field is empty when it displays and the promptString does not display in it either.

You can use the FolderDocuments @command with the FolderList string argument to copy or move a selected document in an embedded view that has HTML selection enabled into the folder selected from the Listbox field. To do so, complete these steps:

1. Give the Listbox field that uses the @DbCommand the reserved name $$SelectDestFolder.

2. Set the view that is being embedded into the form to Allow selection of documents on the Advanced tab of its View Properties box.

3. Edit the EmbeddedView Properties box by setting the Display property on the Info tab to Using HTML and selecting Show Selection Margin on the Display tab.

4. Add an action button to the form with the following formula: @Command([FolderDocuments];"";"0"). When clicked, the document currently selected in the embedded view is copied to the folder currently selected in the $$SelectDestFolder Listbox field. Replace "0" with "1" to move the selected document instead of copying it.

The "ViewNextPage" and "ViewPreviousPage" string arguments are useful when your form has an embedded view that contains several documents. By adding Next and Previous actions to the form that contains @DbCommand functions with these keywords, you can display the documents in manageable chunks. Set the Embedded View Properties box options as follows:

5. Set the Web access Display setting to Using HTML.

6. Deselect Use default.

7. Select a number in the Lines to display field.

Example
See Also

Creating fields to display lists of choices
"Creating an alphabetical navigation bar" on Tips from the Lotus Developer Domain
"Designing a secure Domino app" on the Lotus Developer Domain
"Cleaning up categorized views with @SoundEx" on the Lotus Developer Domain
"Simplifying your LotusScript with the Evaluate statement" on the Lotus Developer Domain
"Displaying marquees on your applications" on the Lotus Developer Domain
"Adding a friendly ad-hoc query tool to Domino applications" on the Lotus Developer Domain
Sequential numbering code example from the Sandbox on the Lotus Developer Domain

Glossary