Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 22 Next »

Unknown macro: {div}

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR

Unknown macro: {div}


Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Return Types

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

JSProgressMonitor


Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Server Property Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}


Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

appendToTXTFile(file, text)
Appends a string given in parameter to a file, using default platform encoding.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

appendToTXTFile(file, text, encoding)
Appends a string given in parameter to a file, using the specified encoding.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

appendToTXTFile(file, text)
Appends a string given in parameter to a file, using default platform encoding.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

appendToTXTFile(file, text, encoding)

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

convertToJSFile(file)
Returns a JSFile instance corresponding to an alternative representation of a file (for example a string).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

convertToRemoteJSFile(path)
Convenience return to get a JSFile representation of a server file based on its path.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

copyFile(source, destination)
Copies the source file to the destination file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

copyFolder(source, destination)
Copies the sourcefolder to the destination folder, recursively.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

createFile(targetFile)
Creates a JSFile instance.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

createFolder(destination)
Creates a folder on disk.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

createTempFile(prefix, suffix)
Creates a temporary file on disk.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

deleteFile(destination)
Removes a file from disk.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

deleteFolder(destination, showWarning)
Deletes a folder from disk recursively.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

getDefaultUploadLocation()
Returns the default upload location path of the server.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

getDesktopFolder()
Returns a JSFile instance that corresponds to the Desktop folder of the currently logged in user.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getDiskList()
Returns an Array of JSFile instances correponding to the file system root folders.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

getFileSize(path)
Returns the size of the specified file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getFolderContents(targetFolder)
Returns an array of JSFile instances corresponding to content of the specified folder.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getFolderContents(targetFolder, fileFilter)
Returns an array of JSFile instances corresponding to content of the specified folder.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getFolderContents(targetFolder, fileFilter, fileOption)
Returns an array of JSFile instances corresponding to content of the specified folder.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getFolderContents(targetFolder, fileFilter, fileOption, visibleOption)
Returns an array of JSFile instances corresponding to content of the specified folder.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getFolderContents(targetFolder, fileFilter, fileOption, visibleOption, lockedOption)
Returns an array of JSFile instances corresponding to content of the specified folder.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getFolderContents(targetFolder)
Returns an array of JSFile instances corresponding to content of the specified folder.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getFolderContents(targetFolder, fileFilter)
Returns an array of JSFile instances corresponding to content of the specified folder.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getFolderContents(targetFolder, fileFilter, fileOption)
Returns an array of JSFile instances corresponding to content of the specified folder.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getFolderContents(targetFolder, fileFilter, fileOption, visibleOption)
Returns an array of JSFile instances corresponding to content of the specified folder.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getFolderContents(targetFolder, fileFilter, fileOption, visibleOption, lockedOption)
Returns an array of JSFile instances corresponding to content of the specified folder.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

getHomeFolder()
Returns a JSFile instance corresponding to the home folder of the logged in used.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Date

Unknown macro: {td}

getModificationDate(path)
Returns the modification date of a file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getRemoteFolderContents(targetFolder)
Returns an array of JSFile instances corresponding to content of the specified folder on the server side.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getRemoteFolderContents(targetFolder, fileFilter)
Returns an array of JSFile instances corresponding to content of the specified folder on the server side.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getRemoteFolderContents(targetFolder, fileFilter, fileOption)
Returns an array of JSFile instances corresponding to content of the specified folder on the server side.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getRemoteFolderContents(targetFolder, fileFilter, fileOption, visibleOption)
Returns an array of JSFile instances corresponding to content of the specified folder on the server side.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getRemoteFolderContents(targetFolder, fileFilter, fileOption, visibleOption, lockedOption)
Returns an array of JSFile instances corresponding to content of the specified folder on the server side.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getRemoteFolderContents(targetFolder)
Returns an array of JSFile instances corresponding to content of the specified folder on the server side.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getRemoteFolderContents(targetFolder, fileFilter)
Returns an array of JSFile instances corresponding to content of the specified folder on the server side.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getRemoteFolderContents(targetFolder, fileFilter, fileOption)
Returns an array of JSFile instances corresponding to content of the specified folder on the server side.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getRemoteFolderContents(targetFolder, fileFilter, fileOption, visibleOption)
Returns an array of JSFile instances corresponding to content of the specified folder on the server side.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile[]

Unknown macro: {td}

getRemoteFolderContents(targetFolder, fileFilter, fileOption, visibleOption, lockedOption)
Returns an array of JSFile instances corresponding to content of the specified folder on the server side.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

moveFile(source, destination)
Moves the file from the source to the destination place.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

byte[]

Unknown macro: {td}

readFile()
Reads all or part of the content from a binary file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

byte[]

Unknown macro: {td}

readFile(file)
Reads all or part of the content from a binary file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

byte[]

Unknown macro: {td}

readFile(file, size)
Reads all or part of the content from a binary file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

byte[]

Unknown macro: {td}

readFile(file)
Reads all or part of the content from a binary file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

byte[]

Unknown macro: {td}

readFile(file, size)
Reads all or part of the content from a binary file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

readTXTFile()
Read all content from a text file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

readTXTFile(file)
Read all content from a text file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

readTXTFile(file, charsetname)
Read all content from a text file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

readTXTFile(file)
Read all content from a text file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

readTXTFile(file, charsetname)
Read all content from a text file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

showDirectorySelectDialog()
Shows a directory selector dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

showDirectorySelectDialog(directory)
Shows a directory selector dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

showDirectorySelectDialog(directory, title)
Shows a directory selector dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

showDirectorySelectDialog(directory)
Shows a directory selector dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

showDirectorySelectDialog(directory, title)
Shows a directory selector dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog()
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory, multiselect)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory, multiselect, filter)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory, multiselect, filter, callbackfunction)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory, multiselect, filter, callbackfunction, title)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory, multiselect, callbackfunction)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory, callbackfunction)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory, multiselect)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory, multiselect, filter)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory, multiselect, filter, callbackfunction)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory, multiselect, filter, callbackfunction, title)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory, multiselect, callbackfunction)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, startDirectory, callbackfunction)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(selectionMode, callbackfunction)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

showFileOpenDialog(callbackfunction)
Shows a file open dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

showFileSaveDialog()
Shows a file save dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

showFileSaveDialog(fileNameDir)
Shows a file save dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

showFileSaveDialog(fileNameDir, title)
Shows a file save dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

showFileSaveDialog(fileNameDir)
Shows a file save dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFile

Unknown macro: {td}

showFileSaveDialog(fileNameDir, title)
Shows a file save dialog.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSProgressMonitor

Unknown macro: {td}

streamFilesFromServer(files, serverFiles)
Stream 1 or more files from the server to the client.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSProgressMonitor

Unknown macro: {td}

streamFilesFromServer(files, serverFiles, callback)
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.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSProgressMonitor

Unknown macro: {td}

streamFilesToServer(files)
Overloaded method, only defines file(s) to be streamed

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSProgressMonitor

Unknown macro: {td}

streamFilesToServer(files, serverFiles)
Overloaded method, defines file(s) to be streamed and a callback function

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSProgressMonitor

Unknown macro: {td}

streamFilesToServer(files, serverFiles, callback)
Overloaded method, defines file(s) to be streamed, a callback function and file name(s) to use on the server

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSProgressMonitor

Unknown macro: {td}

streamFilesToServer(files, callback)
Overloaded method, defines file(s) to be streamed and a callback function

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeFile(file, data)
Writes data into a binary file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeFile(file, data, mimeType)
Writes data into a binary file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeFile(file, data)

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeFile(file, data, mimeType)
Writes data into a binary file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeTXTFile(file, text_data)
Writes data into a text file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeTXTFile(file, text_data, charsetname)
Writes data into a text file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeTXTFile(file, text_data, charsetname, mimeType)
Writes data into a text file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeTXTFile(file, text_data)
Writes data into a text file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeTXTFile(file, text_data, charsetname)
Writes data into a text file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeTXTFile(file, text_data, charsetname, mimeType)
Writes data into a text file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeXMLFile(file, xml_data)
Writes data into an XML file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeXMLFile(file, xml_data, encoding)
Writes data into an XML file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeXMLFile(file, xml_data)
Writes data into an XML file.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

writeXMLFile(file, xml_data, encoding)
Writes data into an XML file.


Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}
Unknown macro: {th}

Server Property Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
servoy.FileServerService.defaultFolder
Unknown macro: {tr}
Unknown macro: {td}


Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
appendToTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

appendToTXTFile

Unknown macro: {span}

(file, text)

Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {div}

Servoy 5.2

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} file – a local JSFile
{String} text – the text to append to the file

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if appending worked

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// append some text to a text file:
	var ok = plugins.file.appendToTXTFile('myTextFile.txt', '\nMy fantastic new line of text\n');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
appendToTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

appendToTXTFile

Unknown macro: {span}

(file, text, encoding)

Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {div}

Servoy 5.2

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} file – a local JSFile
{String} text – the text to append to the file
{String} encoding – the encoding to use

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if appending worked

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// append some text to a text file:
	var ok = plugins.file.appendToTXTFile('myTextFile.txt', '\nMy fantastic new line of text\n');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
appendToTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

appendToTXTFile

Unknown macro: {span}

(file, text)

Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {div}

Servoy 5.2

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} file – the file path as a String
{String} text – the text to append to the file

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if appending worked

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// append some text to a text file:
	var ok = plugins.file.appendToTXTFile('myTextFile.txt', '\nMy fantastic new line of text\n');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
appendToTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

appendToTXTFile

Unknown macro: {span}

(file, text, encoding)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} file – the file path as a String
{String} text – the text to append to the file
{String} encoding – the encoding to use

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// append some text to a text file:
	var ok = plugins.file.appendToTXTFile('myTextFile.txt', '\nMy fantastic new line of text\n');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
convertToJSFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

convertToJSFile

Unknown macro: {span}

(file)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Object} file

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile – JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var f = plugins.file.convertToJSFile("story.txt");
if (f.canRead())
	application.output("File can be read.");
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
convertToRemoteJSFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

convertToRemoteJSFile

Unknown macro: {span}

(path)

Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {div}

Servoy 5.2

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} path – the path representing a file on the server (should start with "/")

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile – the JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var f = plugins.file.convertToRemoteJSFile('/story.txt');
if (f && f.canRead())
	application.output('File can be read.');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
copyFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

copyFile

Unknown macro: {span}

(source, destination)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Object} source
{Object} destination

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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.");
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
copyFolder
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

copyFolder

Unknown macro: {span}

(source, destination)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Object} source
{Object} destination

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – success boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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.");
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

createFile

Unknown macro: {span}

(targetFile)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Object} targetFile

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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.");
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createFolder
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

createFolder

Unknown macro: {span}

(destination)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Object} destination

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var d = plugins.file.convertToJSFile("newfolder");
if (!plugins.file.createFolder(d))
	application.output("Folder could not be created.");
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createTempFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

createTempFile

Unknown macro: {span}

(prefix, suffix)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} prefix
{String} suffix

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var tempFile = plugins.file.createTempFile('myfile','.txt');
application.output('Temporary file created as: ' + tempFile.getAbsolutePath());
plugins.file.writeTXTFile(tempFile, 'abcdefg');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
deleteFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

deleteFile

Unknown macro: {span}

(destination)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Object} destination

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
if (plugins.file.deleteFile('story.txt'))
	application.output('File deleted.');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
deleteFolder
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

deleteFolder

Unknown macro: {span}

(destination, showWarning)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Object} destination
{Boolean} showWarning

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
if (plugins.file.deleteFolder('stories', true))
	application.output('Folder deleted.');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getDefaultUploadLocation
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getDefaultUploadLocation

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the location as canonical path

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// get the (server-side) default upload location path:
var serverPath = plugins.file.getDefaultUploadLocation();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getDesktopFolder
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

getDesktopFolder

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var d = plugins.file.getDesktopFolder();
application.output('desktop folder is: ' + d.getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getDiskList
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getDiskList

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var roots = plugins.file.getDiskList();
for (var i = 0; i < roots.length; i++)
	application.output(roots[i].getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFileSize
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

getFileSize

Unknown macro: {span}

(path)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Object} path

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var f = plugins.file.convertToJSFile('story.txt');
application.output('file size: ' + plugins.file.getFileSize(f));
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getFolderContents

Unknown macro: {span}

(targetFolder)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} targetFolder – JSFile object.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getFolderContents

Unknown macro: {span}

(targetFolder, fileFilter)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} targetFolder – JSFile object.
{Object} fileFilter – Filter or array of filters for files in folder.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getFolderContents

Unknown macro: {span}

(targetFolder, fileFilter, fileOption)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} targetFolder – JSFile object.
{Object} fileFilter – Filter or array of filters for files in folder.
{Number} fileOption – 1=files, 2=dirs

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getFolderContents

Unknown macro: {span}

(targetFolder, fileFilter, fileOption, visibleOption)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getFolderContents

Unknown macro: {span}

(targetFolder, fileFilter, fileOption, visibleOption, lockedOption)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getFolderContents

Unknown macro: {span}

(targetFolder)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} targetFolder – File path.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getFolderContents

Unknown macro: {span}

(targetFolder, fileFilter)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} targetFolder – File path.
{Object} fileFilter – Filter or array of filters for files in folder.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getFolderContents

Unknown macro: {span}

(targetFolder, fileFilter, fileOption)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} targetFolder – File path.
{Object} fileFilter – Filter or array of filters for files in folder.
{Number} fileOption – 1=files, 2=dirs

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getFolderContents

Unknown macro: {span}

(targetFolder, fileFilter, fileOption, visibleOption)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getFolderContents

Unknown macro: {span}

(targetFolder, fileFilter, fileOption, visibleOption, lockedOption)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getHomeFolder
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

getHomeFolder

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var d = plugins.file.getHomeFolder();
application.output('home folder: ' + d.getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getModificationDate
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Date

Unknown macro: {span}

getModificationDate

Unknown macro: {span}

(path)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Object} path

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Date

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var f = plugins.file.convertToJSFile('story.txt');
application.output('last changed: ' + plugins.file.getModificationDate(f));
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRemoteFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getRemoteFolderContents

Unknown macro: {span}

(targetFolder)

Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {div}

Servoy 5.2.1

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} targetFolder

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[] – the array of file names

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRemoteFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getRemoteFolderContents

Unknown macro: {span}

(targetFolder, fileFilter)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} targetFolder – Folder as JSFile object.
{Object} fileFilter – Filter or array of filters for files in folder.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[] – the array of file names

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRemoteFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getRemoteFolderContents

Unknown macro: {span}

(targetFolder, fileFilter, fileOption)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} targetFolder – Folder as JSFile object.
{Object} fileFilter – Filter or array of filters for files in folder.
{Number} fileOption – 1=files, 2=dirs

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[] – the array of file names

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRemoteFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getRemoteFolderContents

Unknown macro: {span}

(targetFolder, fileFilter, fileOption, visibleOption)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[] – the array of file names

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRemoteFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getRemoteFolderContents

Unknown macro: {span}

(targetFolder, fileFilter, fileOption, visibleOption, lockedOption)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[] – the array of file names

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRemoteFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getRemoteFolderContents

Unknown macro: {span}

(targetFolder)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} targetFolder – Folder path.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[] – the array of file names

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRemoteFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getRemoteFolderContents

Unknown macro: {span}

(targetFolder, fileFilter)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} targetFolder – Folder path.
{Object} fileFilter – Filter or array of filters for files in folder.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[] – the array of file names

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRemoteFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getRemoteFolderContents

Unknown macro: {span}

(targetFolder, fileFilter, fileOption)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} targetFolder – Folder path.
{Object} fileFilter – Filter or array of filters for files in folder.
{Number} fileOption – 1=files, 2=dirs

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[] – the array of file names

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRemoteFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getRemoteFolderContents

Unknown macro: {span}

(targetFolder, fileFilter, fileOption, visibleOption)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[] – the array of file names

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRemoteFolderContents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile[]

Unknown macro: {span}

getRemoteFolderContents

Unknown macro: {span}

(targetFolder, fileFilter, fileOption, visibleOption, lockedOption)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile[] – the array of file names

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
moveFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

moveFile

Unknown macro: {span}

(source, destination)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Object} source
{Object} destination

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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.');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
readFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

byte[]

Unknown macro: {span}

readFile

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

byte[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
readFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

byte[]

Unknown macro: {span}

readFile

Unknown macro: {span}

(file)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} file – JSFile.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

byte[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
readFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

byte[]

Unknown macro: {span}

readFile

Unknown macro: {span}

(file, size)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} file – JSFile.
{Number} size – Number of bytes to read.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

byte[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
readFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

byte[]

Unknown macro: {span}

readFile

Unknown macro: {span}

(file)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} file – the file path.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

byte[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
readFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

byte[]

Unknown macro: {span}

readFile

Unknown macro: {span}

(file, size)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} file – the file path.
{Number} size – Number of bytes to read.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

byte[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
readTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

readTXTFile

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
readTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

readTXTFile

Unknown macro: {span}

(file)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} file – JSFile.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
readTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

readTXTFile

Unknown macro: {span}

(file, charsetname)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} file – JSFile.
{String} charsetname – Charset name.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
readTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

readTXTFile

Unknown macro: {span}

(file)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} file – the file path.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
readTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

readTXTFile

Unknown macro: {span}

(file, charsetname)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} file – the file path.
{String} charsetname – Charset name.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showDirectorySelectDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

showDirectorySelectDialog

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showDirectorySelectDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

showDirectorySelectDialog

Unknown macro: {span}

(directory)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} directory – Default directory as JSFile.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showDirectorySelectDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

showDirectorySelectDialog

Unknown macro: {span}

(directory, title)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} directory – Default directory as JSFile.
{String} title – Dialog title.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showDirectorySelectDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

showDirectorySelectDialog

Unknown macro: {span}

(directory)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} directory – Default directory as file path.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showDirectorySelectDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

showDirectorySelectDialog

Unknown macro: {span}

(directory, title)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} directory – Default directory as file path.
{String} title – Dialog title.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} selectionMode – 0=both,1=Files,2=Dirs

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} selectionMode – 0=both,1=Files,2=Dirs
{JSFile} startDirectory – JSFile instance of default folder; null=default/previous

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory, multiselect)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} selectionMode – 0=both,1=Files,2=Dirs
{JSFile} startDirectory – JSFile instance of default folder, null=default/previous
{Boolean} multiselect – true/false

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory, multiselect, filter)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory, multiselect, filter, callbackfunction)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory, multiselect, filter, callbackfunction, title)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory, multiselect, callbackfunction)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory, callbackfunction)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} selectionMode – 0=both,1=Files,2=Dirs
{String} startDirectory – Path to default folder; null=default/previous

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory, multiselect)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} selectionMode – 0=both,1=Files,2=Dirs
{String} startDirectory – Path to default folder, null=default/previous
{Boolean} multiselect – true/false

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory, multiselect, filter)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory, multiselect, filter, callbackfunction)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory, multiselect, filter, callbackfunction, title)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory, multiselect, callbackfunction)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, startDirectory, callbackfunction)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(selectionMode, callbackfunction)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileOpenDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

showFileOpenDialog

Unknown macro: {span}

(callbackfunction)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Function} callbackfunction – A function that takes the (JSFile) array of the selected files as first argument

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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,mycallbackfunction,'Select some nice files')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileSaveDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

showFileSaveDialog

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileSaveDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

showFileSaveDialog

Unknown macro: {span}

(fileNameDir)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} fileNameDir – JSFile to save.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileSaveDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

showFileSaveDialog

Unknown macro: {span}

(fileNameDir, title)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} fileNameDir – JSFile to save
{String} title – Dialog title.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileSaveDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

showFileSaveDialog

Unknown macro: {span}

(fileNameDir)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} fileNameDir – File (give as file path) to save.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showFileSaveDialog
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFile

Unknown macro: {span}

showFileSaveDialog

Unknown macro: {span}

(fileNameDir, title)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} fileNameDir – File to save (specified as file path)
{String} title – Dialog title.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFile

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
streamFilesFromServer
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSProgressMonitor

Unknown macro: {span}

streamFilesFromServer

Unknown macro: {span}

(files, serverFiles)

Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {div}

Servoy 5.2

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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[]

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSProgressMonitor – a JSProgressMonitor object to allow client to subscribe to progress notifications

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
streamFilesFromServer
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSProgressMonitor

Unknown macro: {span}

streamFilesFromServer

Unknown macro: {span}

(files, serverFiles, callback)

Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {div}

Servoy 5.2

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSProgressMonitor – a JSProgressMonitor object to allow client to subscribe to progress notifications

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
streamFilesToServer
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSProgressMonitor

Unknown macro: {span}

streamFilesToServer

Unknown macro: {span}

(files)

Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {div}

Servoy 5.2

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Object} files – file(s) to be streamed (can be a String path or a JSFile) or an Array of these

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSProgressMonitor – a JSProgressMonitor object to allow client to subscribe to progress notifications

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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 );
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
streamFilesToServer
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSProgressMonitor

Unknown macro: {span}

streamFilesToServer

Unknown macro: {span}

(files, serverFiles)

Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {div}

Servoy 5.2

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSProgressMonitor – a JSProgressMonitor object to allow client to subscribe to progress notifications

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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 );
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
streamFilesToServer
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSProgressMonitor

Unknown macro: {span}

streamFilesToServer

Unknown macro: {span}

(files, serverFiles, callback)

Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {div}

Servoy 5.2

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSProgressMonitor – a JSProgressMonitor object to allow client to subscribe to progress notifications

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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 );
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
streamFilesToServer
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSProgressMonitor

Unknown macro: {span}

streamFilesToServer

Unknown macro: {span}

(files, callback)

Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {div}

Servoy 5.2

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSProgressMonitor – a JSProgressMonitor object to allow client to subscribe to progress notifications

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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 );
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeFile

Unknown macro: {span}

(file, data)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} file – a local JSFile
{byte[]} data – the data to be written

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
/**@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.');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeFile

Unknown macro: {span}

(file, data, mimeType)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} file – a local JSFile
{byte[]} data – the data to be written
{String} mimeType – the mime type

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
/**@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.');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeFile

Unknown macro: {span}

(file, data)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} file – the file path as a String
{byte[]} data – the data to be written

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
/**@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.');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeFile

Unknown macro: {span}

(file, data, mimeType)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} file – the file path as a String
{byte[]} data – the data to be written
{String} mimeType – the mime type

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
/**@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.');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeTXTFile

Unknown macro: {span}

(file, text_data)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} file – JSFile
{String} text_data – Text to be written.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – Success boolean.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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'
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeTXTFile

Unknown macro: {span}

(file, text_data, charsetname)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} file – JSFile
{String} text_data – Text to be written.
{String} charsetname – Charset name.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – Success boolean.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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'
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeTXTFile

Unknown macro: {span}

(file, text_data, charsetname, mimeType)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} file – JSFile
{String} text_data – Text to be written.
{String} charsetname – Charset name.
{String} mimeType – Content type (used only on web).

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – Success boolean.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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'
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeTXTFile

Unknown macro: {span}

(file, text_data)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} file – The file path.
{String} text_data – Text to be written.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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'
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeTXTFile

Unknown macro: {span}

(file, text_data, charsetname)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} file – The file path.
{String} text_data – Text to be written.
{String} charsetname – Charset name.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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'
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeTXTFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeTXTFile

Unknown macro: {span}

(file, text_data, charsetname, mimeType)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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).

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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'
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeXMLFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeXMLFile

Unknown macro: {span}

(file, xml_data)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} file – a local JSFile
{String} xml_data – the xml data to write

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var fileName = 'form.xml'
var xml = controller.printXML()
var success = plugins.file.writeXMLFile(fileName, xml);
if (!success) application.output('Could not write file.');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeXMLFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeXMLFile

Unknown macro: {span}

(file, xml_data, encoding)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFile} file – a local JSFile
{String} xml_data – the xml data to write
{String} encoding – the specified encoding

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var fileName = 'form.xml'
var xml = controller.printXML()
var success = plugins.file.writeXMLFile(fileName, xml);
if (!success) application.output('Could not write file.');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeXMLFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeXMLFile

Unknown macro: {span}

(file, xml_data)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} file – the file path as a String
{String} xml_data – the xml data to write

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var fileName = 'form.xml'
var xml = controller.printXML()
var success = plugins.file.writeXMLFile(fileName, xml);
if (!success) application.output('Could not write file.');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
writeXMLFile
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

writeXMLFile

Unknown macro: {span}

(file, xml_data, encoding)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} file – the file path as a String
{String} xml_data – the xml data to write
{String} encoding – the specified encoding

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var fileName = 'form.xml'
var xml = controller.printXML()
var success = plugins.file.writeXMLFile(fileName, xml);
if (!success) application.output('Could not write file.');
Unknown macro: {tr}
Unknown macro: {td}
  • No labels