Table Head (thead) |
---|
Table Row (tr) |
---|
| Table Head (th) |
---|
| Method Details |
|
|
Table Body (tbody) |
---|
id | appendToTXTFile-JSFile_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
appendToTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Appends a string given in parameter to a file, using default platform encoding. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} file - a local JSFile {String} text - the text to append to the file |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Boolean - true if appending worked |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // append some text to a text file:
var ok = plugins.file.appendToTXTFile('myTextFile.txt', '\nMy fantastic new line of text\n'); |
|
|
|
|
Table Body (tbody) |
---|
id | appendToTXTFile-JSFile_String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
appendToTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(file, text, encoding) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Appends a string given in parameter to a file, using the specified encoding. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} file - a local JSFile {String} text - the text to append to the file {String} encoding - the encoding to use |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Boolean - true if appending worked |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // append some text to a text file:
var ok = plugins.file.appendToTXTFile('myTextFile.txt', '\nMy fantastic new line of text\n'); |
|
|
|
|
Table Body (tbody) |
---|
id | appendToTXTFile-String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
appendToTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Appends a string given in parameter to a file, using default platform encoding. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} file - the file path as a String {String} text - the text to append to the file |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Boolean - true if appending worked |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // append some text to a text file:
var ok = plugins.file.appendToTXTFile('myTextFile.txt', '\nMy fantastic new line of text\n'); |
|
|
|
|
Table Body (tbody) |
---|
id | appendToTXTFile-String_String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
appendToTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(file, text, encoding) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} file - the file path as a String {String} text - the text to append to the file {String} encoding - the encoding to use |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // append some text to a text file:
var ok = plugins.file.appendToTXTFile('myTextFile.txt', '\nMy fantastic new line of text\n'); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
convertToJSFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns a JSFile instance corresponding to an alternative representation of a file (for example a string). |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var f = plugins.file.convertToJSFile("story.txt");
if (f.canRead())
application.output("File can be read."); |
|
|
|
|
Table Body (tbody) |
---|
id | convertToRemoteJSFile-String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
convertToRemoteJSFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| convertToRemoteJSFile |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Convenience return to get a JSFile representation of a server file based on its path. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} path - the path representing a file on the server (should start with "/") |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var f = plugins.file.convertToRemoteJSFile('/story.txt');
if (f && f.canRead())
application.output('File can be read.'); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(source, destination) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Copies the source file to the destination file. Returns true if the copy succeeds, false if any error occurs. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Copy based on file names.
if (!plugins.file.copyFile("story.txt", "story.txt.copy"))
application.output("Copy failed.");
// Copy based on JSFile instances.
var f = plugins.file.createFile("story.txt");
var fcopy = plugins.file.createFile("story.txt.copy2");
if (!plugins.file.copyFile(f, fcopy))
application.output("Copy failed."); |
|
|
|
|
Table Body (tbody) |
---|
id | copyFolder-Object_Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
copyFolder |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(source, destination) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Copies the sourcefolder to the destination folder, recursively. Returns true if the copy succeeds, false if any error occurs. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Copy folder based on names.
if (!plugins.file.copyFolder("stories", "stories_copy"))
application.output("Folder copy failed.");
// Copy folder based on JSFile instances.
var d = plugins.file.createFile("stories");
var dcopy = plugins.file.createFile("stories_copy_2");
if (!plugins.file.copyFolder(d, dcopy))
application.output("Folder copy failed."); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
createFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Creates a JSFile instance. Does not create the file on disk. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Create the JSFile instance based on the file name.
var f = plugins.file.createFile("newfile.txt");
// Create the file on disk.
if (!f.createNewFile())
application.output("The file could not be created."); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
createFolder |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Creates a folder on disk. Returns true if the folder is successfully created, false if any error occurs. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var d = plugins.file.convertToJSFile("newfolder");
if (!plugins.file.createFolder(d))
application.output("Folder could not be created."); |
|
|
|
|
Table Body (tbody) |
---|
id | createTempFile-String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
createTempFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Creates a temporary file on disk. A prefix and an extension are specified and they will be part of the file name. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var tempFile = plugins.file.createTempFile('myfile','.txt');
application.output('Temporary file created as: ' + tempFile.getAbsolutePath());
plugins.file.writeTXTFile(tempFile, 'abcdefg'); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
deleteFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Removes a file from disk. Returns true on success, false otherwise. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| if (plugins.file.deleteFile('story.txt'))
application.output('File deleted.'); |
|
|
|
|
Table Body (tbody) |
---|
id | deleteFolder-Object_Boolean |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
deleteFolder |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(destination, showWarning) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Deletes a folder from disk recursively. Returns true on success, false otherwise. If the second parameter is set to true, then a warning will be issued to the user before actually removing the folder. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| if (plugins.file.deleteFolder('stories', true))
application.output('Folder deleted.'); |
|
|
|
|
Table Body (tbody) |
---|
id | getDefaultUploadLocation |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getDefaultUploadLocation |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getDefaultUploadLocation |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the default upload location path of the server. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| String - the location as canonical path |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // get the (server-side) default upload location path:
var serverPath = plugins.file.getDefaultUploadLocation(); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getDesktopFolder |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns a JSFile instance that corresponds to the Desktop folder of the currently logged in user. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var d = plugins.file.getDesktopFolder();
application.output('desktop folder is: ' + d.getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getDiskList |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an Array of JSFile instances correponding to the file system root folders. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var roots = plugins.file.getDiskList();
for (var i = 0; i < roots.length; i++)
application.output(roots[i].getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getFileSize |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the size of the specified file. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var f = plugins.file.convertToJSFile('story.txt');
application.output('file size: ' + plugins.file.getFileSize(f)); |
|
|
|
|
Table Body (tbody) |
---|
id | getFolderContents-JSFile |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} targetFolder - JSFile object. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
application.output(files[i].getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | getFolderContents-JSFile_Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(targetFolder, fileFilter) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} targetFolder - JSFile object. {Object} fileFilter - Filter or array of filters for files in folder. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
application.output(files[i].getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | getFolderContents-JSFile_Object_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(targetFolder, fileFilter, fileOption) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} targetFolder - JSFile object. {Object} fileFilter - Filter or array of filters for files in folder. {Number} fileOption - 1=files, 2=dirs |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
application.output(files[i].getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | getFolderContents-JSFile_Object_Number_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(targetFolder, fileFilter, fileOption, visibleOption) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} targetFolder - JSFile object. {Object} fileFilter - Filter or array of filters for files in folder. {Number} fileOption - 1=files, 2=dirs {Number} visibleOption - 1=visible, 2=nonvisible |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
application.output(files[i].getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | getFolderContents-JSFile_Object_Number_Number_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(targetFolder, fileFilter, fileOption, visibleOption, lockedOption) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} targetFolder - JSFile object. {Object} fileFilter - Filter or array of filters for files in folder. {Number} fileOption - 1=files, 2=dirs {Number} visibleOption - 1=visible, 2=nonvisible {Number} lockedOption - 1=locked, 2=nonlocked |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
application.output(files[i].getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | getFolderContents-String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} targetFolder - File path. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
application.output(files[i].getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | getFolderContents-String_Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(targetFolder, fileFilter) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} targetFolder - File path. {Object} fileFilter - Filter or array of filters for files in folder. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
application.output(files[i].getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | getFolderContents-String_Object_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(targetFolder, fileFilter, fileOption) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} targetFolder - File path. {Object} fileFilter - Filter or array of filters for files in folder. {Number} fileOption - 1=files, 2=dirs |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
application.output(files[i].getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | getFolderContents-String_Object_Number_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(targetFolder, fileFilter, fileOption, visibleOption) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} targetFolder - File path. {Object} fileFilter - Filter or array of filters for files in folder. {Number} fileOption - 1=files, 2=dirs {Number} visibleOption - 1=visible, 2=nonvisible |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
application.output(files[i].getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | getFolderContents-String_Object_Number_Number_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(targetFolder, fileFilter, fileOption, visibleOption, lockedOption) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} targetFolder - File path. {Object} fileFilter - Filter or array of filters for files in folder. {Number} fileOption - 1=files, 2=dirs {Number} visibleOption - 1=visible, 2=nonvisible {Number} lockedOption - 1=locked, 2=nonlocked |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
application.output(files[i].getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getHomeFolder |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns a JSFile instance corresponding to the home folder of the logged in used. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var d = plugins.file.getHomeFolder();
application.output('home folder: ' + d.getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | getModificationDate-Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getModificationDate |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the modification date of a file. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var f = plugins.file.convertToJSFile('story.txt');
application.output('last changed: ' + plugins.file.getModificationDate(f)); |
|
|
|
|
Table Body (tbody) |
---|
id | getRemoteFolderContents-JSFile |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getRemoteFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getRemoteFolderContents |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSFile[] - the array of file names |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt'); |
|
|
|
|
Table Body (tbody) |
---|
id | getRemoteFolderContents-JSFile_Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getRemoteFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getRemoteFolderContents |
Span |
---|
(targetFolder, fileFilter) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} targetFolder - Folder as JSFile object. {Object} fileFilter - Filter or array of filters for files in folder. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSFile[] - the array of file names |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt'); |
|
|
|
|
Table Body (tbody) |
---|
id | getRemoteFolderContents-JSFile_Object_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getRemoteFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getRemoteFolderContents |
Span |
---|
(targetFolder, fileFilter, fileOption) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} targetFolder - Folder as JSFile object. {Object} fileFilter - Filter or array of filters for files in folder. {Number} fileOption - 1=files, 2=dirs |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSFile[] - the array of file names |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt'); |
|
|
|
|
Table Body (tbody) |
---|
id | getRemoteFolderContents-JSFile_Object_Number_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getRemoteFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getRemoteFolderContents |
Span |
---|
(targetFolder, fileFilter, fileOption, visibleOption) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} targetFolder - Folder as JSFile object. {Object} fileFilter - Filter or array of filters for files in folder. {Number} fileOption - 1=files, 2=dirs {Number} visibleOption - 1=visible, 2=nonvisible |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSFile[] - the array of file names |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt'); |
|
|
|
|
Table Body (tbody) |
---|
id | getRemoteFolderContents-JSFile_Object_Number_Number_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getRemoteFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getRemoteFolderContents |
Span |
---|
(targetFolder, fileFilter, fileOption, visibleOption, lockedOption) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} targetFolder - Folder as JSFile object. {Object} fileFilter - Filter or array of filters for files in folder. {Number} fileOption - 1=files, 2=dirs {Number} visibleOption - 1=visible, 2=nonvisible {Number} lockedOption - 1=locked, 2=nonlocked |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSFile[] - the array of file names |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt'); |
|
|
|
|
Table Body (tbody) |
---|
id | getRemoteFolderContents-String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getRemoteFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getRemoteFolderContents |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} targetFolder - Folder path. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSFile[] - the array of file names |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt'); |
|
|
|
|
Table Body (tbody) |
---|
id | getRemoteFolderContents-String_Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getRemoteFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getRemoteFolderContents |
Span |
---|
(targetFolder, fileFilter) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} targetFolder - Folder path. {Object} fileFilter - Filter or array of filters for files in folder. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSFile[] - the array of file names |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt'); |
|
|
|
|
Table Body (tbody) |
---|
id | getRemoteFolderContents-String_Object_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getRemoteFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getRemoteFolderContents |
Span |
---|
(targetFolder, fileFilter, fileOption) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} targetFolder - Folder path. {Object} fileFilter - Filter or array of filters for files in folder. {Number} fileOption - 1=files, 2=dirs |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSFile[] - the array of file names |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt'); |
|
|
|
|
Table Body (tbody) |
---|
id | getRemoteFolderContents-String_Object_Number_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getRemoteFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getRemoteFolderContents |
Span |
---|
(targetFolder, fileFilter, fileOption, visibleOption) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} targetFolder - Folder path. {Object} fileFilter - Filter or array of filters for files in folder. {Number} fileOption - 1=files, 2=dirs {Number} visibleOption - 1=visible, 2=nonvisible |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSFile[] - the array of file names |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt'); |
|
|
|
|
Table Body (tbody) |
---|
id | getRemoteFolderContents-String_Object_Number_Number_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getRemoteFolderContents |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getRemoteFolderContents |
Span |
---|
(targetFolder, fileFilter, fileOption, visibleOption, lockedOption) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} targetFolder - Folder path. {Object} fileFilter - Filter or array of filters for files in folder. {Number} fileOption - 1=files, 2=dirs {Number} visibleOption - 1=visible, 2=nonvisible {Number} lockedOption - 1=locked, 2=nonlocked |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSFile[] - the array of file names |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt'); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(source, destination) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Moves the file from the source to the destination place. Returns true on success, false otherwise. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Move file based on names.
if (!plugins.file.moveFile('story.txt','story.txt.new'))
application.output('File move failed.');
// Move file based on JSFile instances.
var f = plugins.file.convertToJSFile('story.txt.new');
var fmoved = plugins.file.convertToJSFile('story.txt');
if (!plugins.file.moveFile(f, fmoved))
application.output('File move back failed.'); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Launches the associated application to open the file. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Boolean - success status of the open operation |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var myPDF = plugins.file.createFile('my.pdf');
myPDF.setBytes(data, true)
plugins.file.openFile(myPDF); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Reads all or part of the content from a binary file. If a file name is not specified, then a file selection dialog pops up for selecting a file. (Web Enabled only for a JSFile argument) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Read all content from the file.
var bytes = plugins.file.readFile('big.jpg');
application.output('file size: ' + bytes.length);
// Read only the first 1KB from the file.
var bytesPartial = plugins.file.readFile('big.jpg', 1024);
application.output('partial file size: ' + bytesPartial.length);
// Read all content from a file selected from the file open dialog.
var bytesUnknownFile = plugins.file.readFile();
application.output('unknown file size: ' + bytesUnknownFile.length); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Reads all or part of the content from a binary file. If a file name is not specified, then a file selection dialog pops up for selecting a file. (Web Enabled only for a JSFile argument) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Read all content from the file.
var bytes = plugins.file.readFile('big.jpg');
application.output('file size: ' + bytes.length);
// Read only the first 1KB from the file.
var bytesPartial = plugins.file.readFile('big.jpg', 1024);
application.output('partial file size: ' + bytesPartial.length);
// Read all content from a file selected from the file open dialog.
var bytesUnknownFile = plugins.file.readFile();
application.output('unknown file size: ' + bytesUnknownFile.length); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Reads all or part of the content from a binary file. If a file name is not specified, then a file selection dialog pops up for selecting a file. (Web Enabled only for a JSFile argument) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} file - JSFile. {Number} size - Number of bytes to read. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Read all content from the file.
var bytes = plugins.file.readFile('big.jpg');
application.output('file size: ' + bytes.length);
// Read only the first 1KB from the file.
var bytesPartial = plugins.file.readFile('big.jpg', 1024);
application.output('partial file size: ' + bytesPartial.length);
// Read all content from a file selected from the file open dialog.
var bytesUnknownFile = plugins.file.readFile();
application.output('unknown file size: ' + bytesUnknownFile.length); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Reads all or part of the content from a binary file. If a file name is not specified, then a file selection dialog pops up for selecting a file. (Web Enabled only for a JSFile argument) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} file - the file path. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Read all content from the file.
var bytes = plugins.file.readFile('big.jpg');
application.output('file size: ' + bytes.length);
// Read only the first 1KB from the file.
var bytesPartial = plugins.file.readFile('big.jpg', 1024);
application.output('partial file size: ' + bytesPartial.length);
// Read all content from a file selected from the file open dialog.
var bytesUnknownFile = plugins.file.readFile();
application.output('unknown file size: ' + bytesUnknownFile.length); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Reads all or part of the content from a binary file. If a file name is not specified, then a file selection dialog pops up for selecting a file. (Web Enabled only for a JSFile argument) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} file - the file path. {Number} size - Number of bytes to read. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Read all content from the file.
var bytes = plugins.file.readFile('big.jpg');
application.output('file size: ' + bytes.length);
// Read only the first 1KB from the file.
var bytesPartial = plugins.file.readFile('big.jpg', 1024);
application.output('partial file size: ' + bytesPartial.length);
// Read all content from a file selected from the file open dialog.
var bytesUnknownFile = plugins.file.readFile();
application.output('unknown file size: ' + bytesUnknownFile.length); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
readTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Read all content from a text file. If a file name is not specified, then a file selection dialog pops up for selecting a file. The encoding can be also specified. (Web Enabled only for a JSFile argument) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Read content from a known text file.
var txt = plugins.file.readTXTFile('story.txt');
application.output(txt);
// Read content from a text file selected from the file open dialog.
var txtUnknown = plugins.file.readTXTFile();
application.output(txtUnknown); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
readTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Read all content from a text file. If a file name is not specified, then a file selection dialog pops up for selecting a file. The encoding can be also specified. (Web Enabled only for a JSFile argument) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Read content from a known text file.
var txt = plugins.file.readTXTFile('story.txt');
application.output(txt);
// Read content from a text file selected from the file open dialog.
var txtUnknown = plugins.file.readTXTFile();
application.output(txtUnknown); |
|
|
|
|
Table Body (tbody) |
---|
id | readTXTFile-JSFile_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
readTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Read all content from a text file. If a file name is not specified, then a file selection dialog pops up for selecting a file. The encoding can be also specified. (Web Enabled only for a JSFile argument) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} file - JSFile. {String} charsetname - Charset name. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Read content from a known text file.
var txt = plugins.file.readTXTFile('story.txt');
application.output(txt);
// Read content from a text file selected from the file open dialog.
var txtUnknown = plugins.file.readTXTFile();
application.output(txtUnknown); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
readTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Read all content from a text file. If a file name is not specified, then a file selection dialog pops up for selecting a file. The encoding can be also specified. (Web Enabled only for a JSFile argument) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} file - the file path. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Read content from a known text file.
var txt = plugins.file.readTXTFile('story.txt');
application.output(txt);
// Read content from a text file selected from the file open dialog.
var txtUnknown = plugins.file.readTXTFile();
application.output(txtUnknown); |
|
|
|
|
Table Body (tbody) |
---|
id | readTXTFile-String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
readTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Read all content from a text file. If a file name is not specified, then a file selection dialog pops up for selecting a file. The encoding can be also specified. (Web Enabled only for a JSFile argument) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} file - the file path. {String} charsetname - Charset name. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // Read content from a known text file.
var txt = plugins.file.readTXTFile('story.txt');
application.output(txt);
// Read content from a text file selected from the file open dialog.
var txtUnknown = plugins.file.readTXTFile();
application.output(txtUnknown); |
|
|
|
|
Table Body (tbody) |
---|
id | showDirectorySelectDialog |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showDirectorySelectDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| showDirectorySelectDialog |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a directory selector dialog. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | showDirectorySelectDialog-JSFile |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showDirectorySelectDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| showDirectorySelectDialog |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a directory selector dialog. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} directory - Default directory as JSFile. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | showDirectorySelectDialog-JSFile_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showDirectorySelectDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| showDirectorySelectDialog |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a directory selector dialog. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} directory - Default directory as JSFile. {String} title - Dialog title. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | showDirectorySelectDialog-String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showDirectorySelectDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| showDirectorySelectDialog |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a directory selector dialog. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} directory - Default directory as file path. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | showDirectorySelectDialog-String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showDirectorySelectDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| showDirectorySelectDialog |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a directory selector dialog. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} directory - Default directory as file path. {String} title - Dialog title. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_JSFile |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {JSFile} startDirectory - JSFile instance of default folder; null=default/previous |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_JSFile_Boolean |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory, multiselect) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {JSFile} startDirectory - JSFile instance of default folder, null=default/previous {Boolean} multiselect - true/false |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_JSFile_Boolean_Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory, multiselect, filter) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {JSFile} startDirectory - JSFile instance of default folder,null=default/previous {Boolean} multiselect - true/false {Object} filter - A filter or array of filters on the folder files. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_JSFile_Boolean_Object_Function |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory, multiselect, filter, callbackfunction) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {JSFile} startDirectory - JSFile instance of default folder,null=default/previous {Boolean} multiselect - true/false {Object} filter - A filter or array of filters on the folder files. {Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_JSFile_Boolean_Object_Function_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory, multiselect, filter, callbackfunction, title) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {JSFile} startDirectory - JSFile instance of default folder, null=default/previous {Boolean} multiselect - true/false {Object} filter - A filter or array of filters on the folder files. {Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument {String} title - The tile of the dialog |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_JSFile_Boolean_Function |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory, multiselect, callbackfunction) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {JSFile} startDirectory - JSFile instance of default folder,null=default/previous {Boolean} multiselect - true/false {Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_JSFile_Function |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory, callbackfunction) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {JSFile} startDirectory - JSFile instance of default folder,null=default/previous {Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {String} startDirectory - Path to default folder; null=default/previous |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_String_Boolean |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory, multiselect) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {String} startDirectory - Path to default folder, null=default/previous {Boolean} multiselect - true/false |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_String_Boolean_Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory, multiselect, filter) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {String} startDirectory - Path to default folder,null=default/previous {Boolean} multiselect - true/false {Object} filter - A filter or array of filters on the folder files. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_String_Boolean_Object_Function |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory, multiselect, filter, callbackfunction) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {String} startDirectory - Path to default folder,null=default/previous {Boolean} multiselect - true/false {Object} filter - A filter or array of filters on the folder files. {Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_String_Boolean_Object_Function_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory, multiselect, filter, callbackfunction, title) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {String} startDirectory - Path to default folder, null=default/previous {Boolean} multiselect - true/false {Object} filter - A filter or array of filters on the folder files. {Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument {String} title - The tile of the dialog |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_String_Boolean_Function |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory, multiselect, callbackfunction) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {String} startDirectory - Path to default folder,null=default/previous {Boolean} multiselect - true/false {Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_String_Function |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, startDirectory, callbackfunction) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {String} startDirectory - Path to default folder,null=default/previous {Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Number_Function |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(selectionMode, callbackfunction) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} selectionMode - 0=both,1=Files,2=Dirs {Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
id | showFileOpenDialog-Function |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileOpenDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());
// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
application.output('File: ' + files[i].getName());
application.output('content type: ' + files[i].getContentType());
application.output('last modified: ' + files[i].lastModified());
application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files') |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileSaveDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file save dialog. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | showFileSaveDialog-JSFile |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileSaveDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file save dialog. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} fileNameDir - JSFile to save. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | showFileSaveDialog-JSFile_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileSaveDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file save dialog. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} fileNameDir - JSFile to save {String} title - Dialog title. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | showFileSaveDialog-String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileSaveDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file save dialog. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} fileNameDir - File (give as file path) to save. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | showFileSaveDialog-String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
showFileSaveDialog |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Shows a file save dialog. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} fileNameDir - File to save (specified as file path) {String} title - Dialog title. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath()); |
|
|
|
|
Table Body (tbody) |
---|
id | streamFilesFromServer-Object_Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
streamFilesFromServer |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| streamFilesFromServer |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Stream 1 or more files from the server to the client. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Object} files - file(s) to be streamed into (can be a String path a JSFile) or an Array of these {Object} serverFiles - the files on the server that will be transfered to the client, can be a String or a String[] |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSProgressMonitor - a JSProgressMonitor object to allow client to subscribe to progress notifications |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // transfer all the files of a chosen server folder to a directory on the client
var dir = plugins.file.showDirectorySelectDialog();
if (dir) {
var list = plugins.file.getRemoteFolderContents('/images/user1/', null, 1);
if (list) {
var monitor = plugins.file.streamFilesFromServer(dir, list, callbackFunction);
}
}
// transfer one file on the client
var monitor = plugins.file.streamFilesFromServer('/path/to/file', 'path/to/serverFile', callbackFunction);
// transfer an array of serverFiles to an array of files on the client
var files = new Array();
files[0] = '/path/to/file1';
files[1] = '/path/to/file2';
var serverFiles = new Array();
serverFiles[0] = '/path/to/serverFile1';
serverFiles[1] = '/path/to/serverFile2';
var monitor = plugins.file.streamFilesFromServer(files, serverFiles, callbackFunction); |
|
|
|
|
Table Body (tbody) |
---|
id | streamFilesFromServer-Object_Object_Function |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
streamFilesFromServer |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| streamFilesFromServer |
Span |
---|
(files, serverFiles, callback) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Stream 1 or more files from the server to the client, the callback method is invoked after every file, with as argument the filename that was transfered. An extra second exception parameter can be given if an exception did occur. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Object} files - file(s) to be streamed into (can be a String path or a JSFile) or an Array of these {Object} serverFiles - the files on the server that will be transfered to the client, can be a JSFile or JSFile[], a String or String[] {Function} callback - the Function to be called back at the end of the process (for every file); the callback function is invoked with argument the filename that was transfered; an extra second exception parameter can be given if an exception occured |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSProgressMonitor - a JSProgressMonitor object to allow client to subscribe to progress notifications |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // transfer all the files of a chosen server folder to a directory on the client
var dir = plugins.file.showDirectorySelectDialog();
if (dir) {
var list = plugins.file.getRemoteFolderContents('/images/user1/', null, 1);
if (list) {
var monitor = plugins.file.streamFilesFromServer(dir, list, callbackFunction);
}
}
// transfer one file on the client
var monitor = plugins.file.streamFilesFromServer('/path/to/file', 'path/to/serverFile', callbackFunction);
// transfer an array of serverFiles to an array of files on the client
var files = new Array();
files[0] = '/path/to/file1';
files[1] = '/path/to/file2';
var serverFiles = new Array();
serverFiles[0] = '/path/to/serverFile1';
serverFiles[1] = '/path/to/serverFile2';
var monitor = plugins.file.streamFilesFromServer(files, serverFiles, callbackFunction); |
|
|
|
|
Table Body (tbody) |
---|
id | streamFilesToServer-Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
streamFilesToServer |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Overloaded method, only defines file(s) to be streamed |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Object} files - file(s) to be streamed (can be a String path or a JSFile) or an Array of these |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSProgressMonitor - a JSProgressMonitor object to allow client to subscribe to progress notifications |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // send one file:
var file = plugins.file.showFileOpenDialog( 1, null, false, null, null, 'Choose a file to transfer' );
if (file) {
plugins.file.streamFilesToServer( file, callbackFunction );
}
//plugins.file.streamFilesToServer( 'servoy.txt', callbackFunction );
// send an array of files:
var folder = plugins.file.showDirectorySelectDialog();
if (folder) {
var files = plugins.file.getFolderContents(folder);
if (files) {
var monitor = plugins.file.streamFilesToServer( files, callbackFunction );
}
}
// var files = new Array()
// files[0] = 'file1.txt';
// files[1] = 'file2.txt';
// var monitor = plugins.file.streamFilesToServer( files, callbackFunction ); |
|
|
|
|
Table Body (tbody) |
---|
id | streamFilesToServer-Object_Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
streamFilesToServer |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Overloaded method, defines file(s) to be streamed and a callback function |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Object} files - file(s) to be streamed (can be a String path or a JSFile) or an Array of these {Object} serverFiles - can be a JSFile or JSFile[], a String or String[], representing the file name(s) to use on the server |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSProgressMonitor - a JSProgressMonitor object to allow client to subscribe to progress notifications |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // send one file:
var file = plugins.file.showFileOpenDialog( 1, null, false, null, null, 'Choose a file to transfer' );
if (file) {
plugins.file.streamFilesToServer( file, callbackFunction );
}
//plugins.file.streamFilesToServer( 'servoy.txt', callbackFunction );
// send an array of files:
var folder = plugins.file.showDirectorySelectDialog();
if (folder) {
var files = plugins.file.getFolderContents(folder);
if (files) {
var monitor = plugins.file.streamFilesToServer( files, callbackFunction );
}
}
// var files = new Array()
// files[0] = 'file1.txt';
// files[1] = 'file2.txt';
// var monitor = plugins.file.streamFilesToServer( files, callbackFunction ); |
|
|
|
|
Table Body (tbody) |
---|
id | streamFilesToServer-Object_Object_Function |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
streamFilesToServer |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(files, serverFiles, callback) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Overloaded method, defines file(s) to be streamed, a callback function and file name(s) to use on the server |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Object} files - file(s) to be streamed (can be a String path or a JSFile) or an Array of these) {Object} serverFiles - can be a JSFile or JSFile[], a String or String[], representing the file name(s) to use on the server {Function} callback - the Function to be called back at the end of the process (for every file); the callback function is invoked with argument the filename that was transfered; an extra second exception parameter can be given if an exception occured |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSProgressMonitor - a JSProgressMonitor object to allow client to subscribe to progress notifications |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // send one file:
var file = plugins.file.showFileOpenDialog( 1, null, false, null, null, 'Choose a file to transfer' );
if (file) {
plugins.file.streamFilesToServer( file, callbackFunction );
}
//plugins.file.streamFilesToServer( 'servoy.txt', callbackFunction );
// send an array of files:
var folder = plugins.file.showDirectorySelectDialog();
if (folder) {
var files = plugins.file.getFolderContents(folder);
if (files) {
var monitor = plugins.file.streamFilesToServer( files, callbackFunction );
}
}
// var files = new Array()
// files[0] = 'file1.txt';
// files[1] = 'file2.txt';
// var monitor = plugins.file.streamFilesToServer( files, callbackFunction ); |
|
|
|
|
Table Body (tbody) |
---|
id | streamFilesToServer-Object_Function |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
streamFilesToServer |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Overloaded method, defines file(s) to be streamed and a callback function |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Object} files - file(s) to be streamed (can be a String path or a JSFile) or an Array of these {Function} callback - the Function to be called back at the end of the process (for every file); the callback function is invoked with argument the filename that was transfered; an extra second exception parameter can be given if an exception occured |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSProgressMonitor - a JSProgressMonitor object to allow client to subscribe to progress notifications |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // send one file:
var file = plugins.file.showFileOpenDialog( 1, null, false, null, null, 'Choose a file to transfer' );
if (file) {
plugins.file.streamFilesToServer( file, callbackFunction );
}
//plugins.file.streamFilesToServer( 'servoy.txt', callbackFunction );
// send an array of files:
var folder = plugins.file.showDirectorySelectDialog();
if (folder) {
var files = plugins.file.getFolderContents(folder);
if (files) {
var monitor = plugins.file.streamFilesToServer( files, callbackFunction );
}
}
// var files = new Array()
// files[0] = 'file1.txt';
// files[1] = 'file2.txt';
// var monitor = plugins.file.streamFilesToServer( files, callbackFunction ); |
|
|
|
|
Table Body (tbody) |
---|
id | writeFile-JSFile_byteArray |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Writes data into a binary file. (Web Enabled: file parameter can be a string 'mypdffile.pdf' to hint the browser what it is, if it is a JSFile instance it will be saved on the server) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} file - a local JSFile {byte[]} data - the data to be written |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| /**@type {Array<byte>}*/
var bytes = new Array();
for (var i=0; i<1024; i++)
bytes[i] = i % 100;
var f = plugins.file.convertToJSFile('bin.dat');
if (!plugins.file.writeFile(f, bytes))
application.output('Failed to write the file.');
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'
var mimeType = 'application/vnd.ms-excel'
if (!plugins.file.writeFile(f, bytes, mimeType))
application.output('Failed to write the file.'); |
|
|
|
|
Table Body (tbody) |
---|
id | writeFile-JSFile_byteArray_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(file, data, mimeType) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Writes data into a binary file. (Web Enabled: file parameter can be a string 'mypdffile.pdf' to hint the browser what it is, if it is a JSFile instance it will be saved on the server) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} file - a local JSFile {byte[]} data - the data to be written {String} mimeType - the mime type |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| /**@type {Array<byte>}*/
var bytes = new Array();
for (var i=0; i<1024; i++)
bytes[i] = i % 100;
var f = plugins.file.convertToJSFile('bin.dat');
if (!plugins.file.writeFile(f, bytes))
application.output('Failed to write the file.');
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'
var mimeType = 'application/vnd.ms-excel'
if (!plugins.file.writeFile(f, bytes, mimeType))
application.output('Failed to write the file.'); |
|
|
|
|
Table Body (tbody) |
---|
id | writeFile-String_byteArray |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} file - the file path as a String {byte[]} data - the data to be written |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| /**@type {Array<byte>}*/
var bytes = new Array();
for (var i=0; i<1024; i++)
bytes[i] = i % 100;
var f = plugins.file.convertToJSFile('bin.dat');
if (!plugins.file.writeFile(f, bytes))
application.output('Failed to write the file.');
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'
var mimeType = 'application/vnd.ms-excel'
if (!plugins.file.writeFile(f, bytes, mimeType))
application.output('Failed to write the file.'); |
|
|
|
|
Table Body (tbody) |
---|
id | writeFile-String_byteArray_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(file, data, mimeType) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Writes data into a binary file. (Web Enabled: file parameter can be a string 'mypdffile.pdf' to hint the browser what it is, if it is a JSFile instance it will be saved on the server) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} file - the file path as a String {byte[]} data - the data to be written {String} mimeType - the mime type |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| /**@type {Array<byte>}*/
var bytes = new Array();
for (var i=0; i<1024; i++)
bytes[i] = i % 100;
var f = plugins.file.convertToJSFile('bin.dat');
if (!plugins.file.writeFile(f, bytes))
application.output('Failed to write the file.');
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'
var mimeType = 'application/vnd.ms-excel'
if (!plugins.file.writeFile(f, bytes, mimeType))
application.output('Failed to write the file.'); |
|
|
|
|
Table Body (tbody) |
---|
id | writeTXTFile-JSFile_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
writeTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Writes data into a text file. (Web Enabled: file parameter can be a string 'mytextfile.txt' to hint the browser what it is, if it is a JSFile instance it will be saved on the server) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} file - JSFile {String} text_data - Text to be written. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var fileNameSuggestion = 'myspecialexport.tab'
var textData = 'load of data...'
var success = plugins.file.writeTXTFile(fileNameSuggestion, textData);
if (!success) application.output('Could not write file.');
// For file-encoding parameter options (default OS encoding is used), http://download.oracle.com/javase/1.4.2/docs/guide/intl/encoding.doc.html
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp' |
|
|
|
|
Table Body (tbody) |
---|
id | writeTXTFile-JSFile_String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
writeTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(file, text_data, charsetname) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Writes data into a text file. (Web Enabled: file parameter can be a string 'mytextfile.txt' to hint the browser what it is, if it is a JSFile instance it will be saved on the server) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} file - JSFile {String} text_data - Text to be written. {String} charsetname - Charset name. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var fileNameSuggestion = 'myspecialexport.tab'
var textData = 'load of data...'
var success = plugins.file.writeTXTFile(fileNameSuggestion, textData);
if (!success) application.output('Could not write file.');
// For file-encoding parameter options (default OS encoding is used), http://download.oracle.com/javase/1.4.2/docs/guide/intl/encoding.doc.html
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp' |
|
|
|
|
Table Body (tbody) |
---|
id | writeTXTFile-JSFile_String_String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
writeTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(file, text_data, charsetname, mimeType) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Writes data into a text file. (Web Enabled: file parameter can be a string 'mytextfile.txt' to hint the browser what it is, if it is a JSFile instance it will be saved on the server) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} file - JSFile {String} text_data - Text to be written. {String} charsetname - Charset name. {String} mimeType - Content type (used only on web). |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var fileNameSuggestion = 'myspecialexport.tab'
var textData = 'load of data...'
var success = plugins.file.writeTXTFile(fileNameSuggestion, textData);
if (!success) application.output('Could not write file.');
// For file-encoding parameter options (default OS encoding is used), http://download.oracle.com/javase/1.4.2/docs/guide/intl/encoding.doc.html
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp' |
|
|
|
|
Table Body (tbody) |
---|
id | writeTXTFile-String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
writeTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Writes data into a text file. (Web Enabled: file parameter can be a string 'mytextfile.txt' to hint the browser what it is, if it is a JSFile instance it will be saved on the server) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} file - The file path. {String} text_data - Text to be written. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var fileNameSuggestion = 'myspecialexport.tab'
var textData = 'load of data...'
var success = plugins.file.writeTXTFile(fileNameSuggestion, textData);
if (!success) application.output('Could not write file.');
// For file-encoding parameter options (default OS encoding is used), http://download.oracle.com/javase/1.4.2/docs/guide/intl/encoding.doc.html
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp' |
|
|
|
|
Table Body (tbody) |
---|
id | writeTXTFile-String_String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
writeTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(file, text_data, charsetname) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Writes data into a text file. (Web Enabled: file parameter can be a string 'mytextfile.txt' to hint the browser what it is, if it is a JSFile instance it will be saved on the server) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} file - The file path. {String} text_data - Text to be written. {String} charsetname - Charset name. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var fileNameSuggestion = 'myspecialexport.tab'
var textData = 'load of data...'
var success = plugins.file.writeTXTFile(fileNameSuggestion, textData);
if (!success) application.output('Could not write file.');
// For file-encoding parameter options (default OS encoding is used), http://download.oracle.com/javase/1.4.2/docs/guide/intl/encoding.doc.html
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp' |
|
|
|
|
Table Body (tbody) |
---|
id | writeTXTFile-String_String_String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
writeTXTFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(file, text_data, charsetname, mimeType) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Writes data into a text file. (Web Enabled: file parameter can be a string 'mytextfile.txt' to hint the browser what it is, if it is a JSFile instance it will be saved on the server) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} file - The file path. {String} text_data - Text to be written. {String} charsetname - Charset name. {String} mimeType - Content type (used only on web). |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var fileNameSuggestion = 'myspecialexport.tab'
var textData = 'load of data...'
var success = plugins.file.writeTXTFile(fileNameSuggestion, textData);
if (!success) application.output('Could not write file.');
// For file-encoding parameter options (default OS encoding is used), http://download.oracle.com/javase/1.4.2/docs/guide/intl/encoding.doc.html
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp' |
|
|
|
|
Table Body (tbody) |
---|
id | writeXMLFile-JSFile_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
writeXMLFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Writes data into an XML file. The file is saved with the encoding specified by the XML itself. (Web Enabled: file parameter can be a string 'myxmlfile.xml' to hint the browser what it is, if it is a JSFile instance it will be saved on the server) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} file - a local JSFile {String} xml_data - the xml data to write |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var fileName = 'form.xml'
var xml = controller.printXML()
var success = plugins.file.writeXMLFile(fileName, xml);
if (!success) application.output('Could not write file.'); |
|
|
|
|
Table Body (tbody) |
---|
id | writeXMLFile-JSFile_String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
writeXMLFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(file, xml_data, encoding) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Writes data into an XML file. The file is saved with the encoding specified by the XML itself. (Web Enabled: file parameter can be a string 'myxmlfile.xml' to hint the browser what it is, if it is a JSFile instance it will be saved on the server) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {JSFile} file - a local JSFile {String} xml_data - the xml data to write {String} encoding - the specified encoding |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var fileName = 'form.xml'
var xml = controller.printXML()
var success = plugins.file.writeXMLFile(fileName, xml);
if (!success) application.output('Could not write file.'); |
|
|
|
|
Table Body (tbody) |
---|
id | writeXMLFile-String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
writeXMLFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Writes data into an XML file. The file is saved with the encoding specified by the XML itself. (Web Enabled: file parameter can be a string 'myxmlfile.xml' to hint the browser what it is, if it is a JSFile instance it will be saved on the server) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} file - the file path as a String {String} xml_data - the xml data to write |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var fileName = 'form.xml'
var xml = controller.printXML()
var success = plugins.file.writeXMLFile(fileName, xml);
if (!success) application.output('Could not write file.'); |
|
|
|
|
Table Body (tbody) |
---|
id | writeXMLFile-String_String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
writeXMLFile |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(file, xml_data, encoding) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Writes data into an XML file. The file is saved with the encoding specified by the XML itself. (Web Enabled: file parameter can be a string 'myxmlfile.xml' to hint the browser what it is, if it is a JSFile instance it will be saved on the server) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} file - the file path as a String {String} xml_data - the xml data to write {String} encoding - the specified encoding |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var fileName = 'form.xml'
var xml = controller.printXML()
var success = plugins.file.writeXMLFile(fileName, xml);
if (!success) application.output('Could not write file.'); |
|
|
|
|
|