FileExport @Command (Formula Language)

Exports a Notes/Domino document or view.

Syntax

@Command( [FileExport] )

or

@Command( [FileExport] ; fileType ; fileName )

Parameters

fileType

Text. The kind of file you want to export to. See the list of file types that follows.

fileName

Text. The name of the file you want to export to. Must be a complete path specification, including drive, directory, and file name.

If the fileType and fileName parameters are omitted, Notes/Domino displays the Export dialog box. If the parameters are included, Notes/Domino exports the view or currently opened document using the specified fileType and fileName.

Return value

Number. If the user clicks the Cancel button on the Export dialog box, the number 1 is returned.

Usage

FileExport can be used at the view level, and when a document is open in Read or Edit mode, according to what is being exported.

This command does not work on the Web.

The fileType must be one of those listed. You do not have to spell the name exactly as shown; you have to include enough characters to uniquely identify the file type. In case of ambiguity, Notes/Domino will use the first file type in the list that matches your entry.

Windows™ File Types

Document Level ASCII Text CGM Image Microsoft™ RTF* TIFF 5.0 Image vCard 3.0**

View Level Comma Separated Value*** Structured Text Tabular Text vCard 3.0**

Macintosh File Types

Document Level ASCII Text Microsoft™ RTF* TIFF 5.0 Image CGM Image vCard 3.0**

Note: The Macintosh does not support document level export of the XTND file format (MacWrite II and Text).

View Level Comma Separated Value*** Structured Text Tabular Text

*The formatting of the names of these file types changed with R5.0.5. If you installed (not upgraded to) R5.0.5 or later, pre-5.0.5 scripts that reference these file types using the old name formats may not work.

**New with Release 6.

***New with Release 6.5.

Note: With R4.0, Notes® does not support exporting ANSI Metafile file types.
Note: With Release 6, Notes® does not support exporting UNIX™ file types.
Note: With Release 7, Notes® does not support exporting Microsoft™ Word file types.

Examples

  1. This formula exports a view to c:\temp.txt as tabular text.
    @Command([FileExport]; "Tabular Text"; "c:\\temp.txt")
  2. This agent formula exports the current document to the testing.txt file on the C drive of the local machine when the user triggers the agent from the Action menu.
    @Command([FileExport];"ASCII";"C:\\testing.txt")

    This agent has an event trigger of "Action view selection" and has "None" selected as its target.