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 27 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.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Unknown macro: {div}

The File plugin provides functionality to work with files.

Main features are:

  • Creating temporary files
  • Reading from and writing to the filesystem
  • Retrieving information on files and directories on the file system
  • Streaming files between the Smart Client and the Server (and vise versa)
    The stream methods are not directly useful for the WebClient, because this is really streaming of files between a client and a server, and the client code of the WebClient is already running on the server, so you are the streaming data withing the same process. The streaming for the webclientis handled by the browser code.

When using the File plugin, it's important to take into account the differences and compatibility between different clients:

  • Interacting with the file system through the plugin in a Smart Client happens client-side, so on the machine where the Smart Client is launched. On all other clients (Web, Headless & Batchprocessor), the operations are performed on the Server.
  • All showXxxxDialog(...) functions interact with the user through a UI. These function can only be used in Clients that provide a UI, like the Smart and Web Client.
  • The showXxxxDialog(...) functions, when used in the Web Client, have certain limitations due to being operated in a browser. Browser security (currently) limits interaction with the local file system, except for single file select operations initiated by the user clicking a button.

Many functions work only in the smart client or only on the server in the Headless or WebClient, some work in the WebClient's browser and that is mentioned in the doc (WebClient enabled) most of the time an extra parameter or some certain state must be set like a callback function, because in the WebClient the function will not wait for a result and then return the result, but will go on, and then the callback is called when it is done. (like showFileOpenDialog)
You have no control directly of the real files in a a WebClient, so the files on the pc of the browser. You can't directly target them to load into the client, or with saving you can't specify the target directory where it is getting saved. This is all fully controlled by the browser.
When using the streaming features of the File plugin, make sure that you set the directory "servoy.FileServerService.defaultFolder" of the File server plugin settings in the admin page. Don't reply on the default behavior, specify your own writable directory.

Because the File plugin works with 3 different kind of files (LocalFiles on disk, RemoteFiles on the server when streaming is used and Uploaded files from the webclient when the browser uploads a file), not all things that you call on a JSFile object will give you data that you expect, for example a Uploaded file that you get back in the callback method of a showFileOpenDialog in the webclient does not represent an actual File object on the server. It is a binary data object (blob) that is only in memory, so getParentFile() or getPath() will return null in these cases, you don't get access or a reference to the file path or directory of the browsers pc. Also setBytes() will result in an exception. Best things to use is the getBytes() method if you want to get the bytes and store that, that will work for all 3 types. If you want to store the bytes that a webclient uploaded in another file the quickest way to do that is to use:

var fileOnServer = plugins.file.convertToJSFile('/path/to/file/on/server');

plugins.file.writeFile(fileOnServer,uploadedFile.getBytes());


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

Appends a string given in parameter to a file, using default platform 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

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

Appends a string given in parameter to a file, using the specified 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}
Unknown macro: {div}

Appends a string given in parameter to a file, using default platform encoding.

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

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

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

Convenience return to get a JSFile representation of a server file based on its 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}
Unknown macro: {div}

Copies the source file to the destination file. Returns true if the copy succeeds, false if any error occurs.

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

Copies the sourcefolder to the destination folder, recursively. Returns true if the copy succeeds, false if any error occurs.

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

Creates a JSFile instance. Does not create the file on disk.

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

Creates a folder on disk. Returns true if the folder is successfully created, false if any error occurs.

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

Creates a temporary file on disk. A prefix and an extension are specified and they will be part of the file name.

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

Removes a file from disk. Returns true on success, false otherwise.

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

Deletes a folder from disk recursively. Returns true on success, false otherwise. If the second parameter is set to true, then a warning will be issued to the user before actually removing the folder.

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

Returns the default upload location path of the server.

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

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

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

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

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

Returns the size of the specified file.

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

Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

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

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

Returns the modification date of a file.

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

Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Returns an array of JSFile instances corresponding to content of the specified folder on the server side. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.

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

Moves the file from the source to the destination place. Returns true on success, false otherwise.

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

Reads all or part of the content from a binary file. If a file name is not specified, then a file selection dialog pops up for selecting a file. (Web Enabled only for a JSFile argument)

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

Reads all or part of the content from a binary file. If a file name is not specified, then a file selection dialog pops up for selecting a file. (Web Enabled only for a JSFile argument)

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

Reads all or part of the content from a binary file. If a file name is not specified, then a file selection dialog pops up for selecting a file. (Web Enabled only for a JSFile argument)

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

Reads all or part of the content from a binary file. If a file name is not specified, then a file selection dialog pops up for selecting a file. (Web Enabled only for a JSFile argument)

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

Reads all or part of the content from a binary file. If a file name is not specified, then a file selection dialog pops up for selecting a file. (Web Enabled only for a JSFile argument)

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

Read all content from a text file. If a file name is not specified, then a file selection dialog pops up for selecting a file. The encoding can be also specified. (Web Enabled only for a JSFile argument)

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

Read all content from a text file. If a file name is not specified, then a file selection dialog pops up for selecting a file. The encoding can be also specified. (Web Enabled only for a JSFile argument)

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

Read all content from a text file. If a file name is not specified, then a file selection dialog pops up for selecting a file. The encoding can be also specified. (Web Enabled only for a JSFile argument)

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

Read all content from a text file. If a file name is not specified, then a file selection dialog pops up for selecting a file. The encoding can be also specified. (Web Enabled only for a JSFile argument)

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

Read all content from a text file. If a file name is not specified, then a file selection dialog pops up for selecting a file. The encoding can be also specified. (Web Enabled only for a JSFile argument)

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

Shows a directory selector dialog.

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

Shows a directory selector dialog.

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

Shows a directory selector dialog.

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

Shows a directory selector dialog.

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

Shows a directory selector dialog.

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled, you must set the callback method for this to work)

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

Shows a file save dialog.

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

Shows a file save dialog.

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

Shows a file save dialog.

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

Shows a file save dialog.

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

Shows a file save dialog.

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

Stream 1 or more files from the server to the client.

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

Stream 1 or more files from the server to the client, the callback method is invoked after every file, with as argument
the filename that was transfered. An extra second exception parameter can be given if an exception did occur.

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

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

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

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

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

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

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

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

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

Writes data into a binary file. (Web Enabled: file parameter can be a string 'mypdffile.pdf' to hint the browser what it is, if it is a JSFile instance it will be saved on the server)

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

Writes data into a binary file. (Web Enabled: file parameter can be a string 'mypdffile.pdf' to hint the browser what it is, if it is a JSFile instance it will be saved on the server)

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

Writes data into a binary file. (Web Enabled: file parameter can be a string 'mypdffile.pdf' to hint the browser what it is, if it is a JSFile instance it will be saved on the server)

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

Writes data into a text file. (Web Enabled: file parameter can be a string 'mytextfile.txt' to hint the browser what it is, if it is a JSFile instance it will be saved on the server)

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

Writes data into a text file. (Web Enabled: file parameter can be a string 'mytextfile.txt' to hint the browser what it is, if it is a JSFile instance it will be saved on the server)

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

Writes data into a text file. (Web Enabled: file parameter can be a string 'mytextfile.txt' to hint the browser what it is, if it is a JSFile instance it will be saved on the server)

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

Writes data into a text file. (Web Enabled: file parameter can be a string 'mytextfile.txt' to hint the browser what it is, if it is a JSFile instance it will be saved on the server)

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

Writes data into a text file. (Web Enabled: file parameter can be a string 'mytextfile.txt' to hint the browser what it is, if it is a JSFile instance it will be saved on the server)

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

Writes data into a text file. (Web Enabled: file parameter can be a string 'mytextfile.txt' to hint the browser what it is, if it is a JSFile instance it will be saved on the server)

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

Writes data into an XML file. The file is saved with the encoding specified by the XML itself. (Web Enabled: file parameter can be a string 'myxmlfile.xml' to hint the browser what it is, if it is a JSFile instance it will be saved on the server)

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

Writes data into an XML file. The file is saved with the encoding specified by the XML itself. (Web Enabled: file parameter can be a string 'myxmlfile.xml' to hint the browser what it is, if it is a JSFile instance it will be saved on the server)

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

Writes data into an XML file. The file is saved with the encoding specified by the XML itself. (Web Enabled: file parameter can be a string 'myxmlfile.xml' to hint the browser what it is, if it is a JSFile instance it will be saved on the server)

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

Writes data into an XML file. The file is saved with the encoding specified by the XML itself. (Web Enabled: file parameter can be a string 'myxmlfile.xml' to hint the browser what it is, if it is a JSFile instance it will be saved on the server)

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