The CopyToLocalFile client API allows you to pull a local copy of files attached to documents.
|
Argument |
Description |
|---|---|
|
Parameter 1 |
Show hidden files |
|
Parameter 1 default |
False |
|
Parameter 1 description |
When set to True, allows the selection of hidden (non-viewable and non-editable) files. Default set to False, those files do not appear on the form. |
|
Parameter 1 type |
Boolean |
|
Parameter 2 |
Copy Alternate |
|
Parameter 2 default |
False |
|
Parameter 2 description |
When set to True, only alternate renditions attached to the document are copied locally. Default is set to False, alternate renditions are not copied locally. |
|
Parameter 2 type |
Boolean |
|
Parameter 3 |
Alternate rendition files types to be copied |
|
Parameter 3 default |
None |
|
Parameter 3 description |
Specifies the file types of alternate renditions to be copied locally. File types must be separated by a semicolon. |
|
Parameter 3 type |
String |
|
Parameter 4 |
ColumnSet |
|
Parameter 4 default |
CS_CopyToLocalColumnSet |
|
Parameter 4 description |
Name of the column set to be used to display the files to be copied locally. When the Copy Alternate argument is set to False, then the default for the ColumnSet argument should be CS_CopyToLocalColumnSet. When the Copy Alternate argument is set to True, then this argument should be CS_CopyToLocalAlternateColumnSet. |
|
Parameter 4 type |
String |
|
Parameter 5 |
Filetype Filter |
|
Parameter 5 default |
None |
|
Parameter 5 description |
A comma-separated list of file extensions that is only visible to the user in the Web Client using Save Target As when selecting files to download that are attached to an object. If left blank, all available file extensions are visible to the user. |
|
Parameter 5 type |
String |
The following methods use the CopyToLocal client API to create local copies of the attached files and in some cases the related alternate renditions.
-
CopyToLocalFile
-
CopyToLocalAlternateFile
-
FIleDocRevCopyToLocal
-
FileDocRevCopyToLocalAlternateFile
-
SPFOpenXMLSaveReport