Page History

Div

style	display:none

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.

Div

id	description

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());

HTML Table

id
class	servoy sReturnTypes

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Return Types

Table Row (tr)

Table Cell (td)

Span

class	sWordList

JSFile

Span

class	sWordList

JSProgressMonitor

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Server Property Summary

Table Row (tr)

Table Cell (td)

Table Cell (td)
servoy.FileServerService.defaultFolder

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
appendToTXTFile(file, text, encoding)

Table Row (tr)

Table Cell (td)
JSFile

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

Table Row (tr)

Table Cell (td)
JSFile

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
copyFile(source, destination) Copies the source file to the destination file.

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
createFile(targetFile) Creates a JSFile instance.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
createFolder(destination) Creates a folder on disk.

Table Row (tr)

Table Cell (td)
JSFile

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
deleteFile(destination) Removes a file from disk.

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
JSFile

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getFileSize(path) Returns the size of the specified file.

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile

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

Table Row (tr)

Table Cell (td)
Date

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
JSFile[]

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
openFile(file) Launches the associated application to open the file.

Table Row (tr)

Table Cell (td)
byte[]

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

Table Row (tr)

Table Cell (td)
byte[]

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

Table Row (tr)

Table Cell (td)
byte[]

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

Table Row (tr)

Table Cell (td)
byte[]

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

Table Row (tr)

Table Cell (td)
byte[]

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

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
readTXTFile() Read all content from a text file.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
readTXTFile(file) Read all content from a text file.

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
readTXTFile(file) Read all content from a text file.

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
showDirectorySelectDialog() Shows a directory selector dialog.

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
showDirectorySelectDialog(directory) Shows a directory selector dialog.

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
showDirectorySelectDialog(directory, title) Shows a directory selector dialog.

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
showDirectorySelectDialog(directory) Shows a directory selector dialog.

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
showDirectorySelectDialog(directory, title) Shows a directory selector dialog.

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
showFileOpenDialog() Shows a file open dialog.

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
showFileOpenDialog(selectionMode) Shows a file open dialog.

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
showFileOpenDialog(callbackfunction) Shows a file open dialog.

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
showFileSaveDialog() Shows a file save dialog.

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
showFileSaveDialog(fileNameDir) Shows a file save dialog.

Table Row (tr)

Table Cell (td)
JSFile

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

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
showFileSaveDialog(fileNameDir) Shows a file save dialog.

Table Row (tr)

Table Cell (td)
JSFile

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

Table Row (tr)

Table Cell (td)
JSProgressMonitor

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

Table Row (tr)

Table Cell (td)
JSProgressMonitor

Table Cell (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.

Table Row (tr)

Table Cell (td)
JSProgressMonitor

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

Table Row (tr)

Table Cell (td)
JSProgressMonitor

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

Table Row (tr)

Table Cell (td)
JSProgressMonitor

Table Cell (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

Table Row (tr)

Table Cell (td)
JSProgressMonitor

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
writeFile(file, data) Writes data into a binary file.

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
writeFile(file, data)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

HTML Table

id	serverProperty
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Server Property Details

Table Body (tbody)

id	servoy.FileServerService.defaultFolder

Table Row (tr)

id	name

Table Cell (td)
servoy.FileServerService.defaultFolder

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	appendToTXTFile-JSFile_String

Table Row (tr)

id	name

Table Cell (td)
appendToTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

appendToTXTFile

Span
(file, text)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

Servoy 5.2

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if appending worked

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// append some text to a text file:
	var ok = plugins.file.appendToTXTFile('myTextFile.txt', '\nMy fantastic new line of text\n');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	appendToTXTFile-JSFile_String_String

Table Row (tr)

id	name

Table Cell (td)
appendToTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

appendToTXTFile

Span
(file, text, encoding)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Appends a string given in parameter to a file, using the specified encoding.

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

Servoy 5.2

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if appending worked

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// append some text to a text file:
	var ok = plugins.file.appendToTXTFile('myTextFile.txt', '\nMy fantastic new line of text\n');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	appendToTXTFile-String_String

Table Row (tr)

id	name

Table Cell (td)
appendToTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

appendToTXTFile

Span
(file, text)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

Servoy 5.2

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if appending worked

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// append some text to a text file:
	var ok = plugins.file.appendToTXTFile('myTextFile.txt', '\nMy fantastic new line of text\n');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	appendToTXTFile-String_String_String

Table Row (tr)

id	name

Table Cell (td)
appendToTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

appendToTXTFile

Span
(file, text, encoding)

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// append some text to a text file:
	var ok = plugins.file.appendToTXTFile('myTextFile.txt', '\nMy fantastic new line of text\n');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	convertToJSFile-Object

Table Row (tr)

id	name

Table Cell (td)
convertToJSFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

convertToJSFile

Span
(file)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} file

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile - JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var f = plugins.file.convertToJSFile("story.txt");
if (f.canRead())
	application.output("File can be read.");

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	convertToRemoteJSFile-String

Table Row (tr)

id	name

Table Cell (td)
convertToRemoteJSFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

convertToRemoteJSFile

Span
(path)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

Servoy 5.2

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile - the JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var f = plugins.file.convertToRemoteJSFile('/story.txt');
if (f && f.canRead())
	application.output('File can be read.');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	copyFile-Object_Object

Table Row (tr)

id	name

Table Cell (td)
copyFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

copyFile

Span
(source, destination)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} source
{Object} destination

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Copy based on file names.
if (!plugins.file.copyFile("story.txt", "story.txt.copy"))
	application.output("Copy failed.");
// Copy based on JSFile instances.
var f = plugins.file.createFile("story.txt");
var fcopy = plugins.file.createFile("story.txt.copy2");
if (!plugins.file.copyFile(f, fcopy))
	application.output("Copy failed.");

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	copyFolder-Object_Object

Table Row (tr)

id	name

Table Cell (td)
copyFolder

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

copyFolder

Span
(source, destination)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} source
{Object} destination

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - success boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Copy folder based on names.
if (!plugins.file.copyFolder("stories", "stories_copy"))
	application.output("Folder copy failed.");
// Copy folder based on JSFile instances.
var d = plugins.file.createFile("stories");
var dcopy = plugins.file.createFile("stories_copy_2");
if (!plugins.file.copyFolder(d, dcopy))
	application.output("Folder copy failed.");

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createFile-Object

Table Row (tr)

id	name

Table Cell (td)
createFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

createFile

Span
(targetFile)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} targetFile

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Create the JSFile instance based on the file name.
var f = plugins.file.createFile("newfile.txt");
// Create the file on disk.
if (!f.createNewFile())
	application.output("The file could not be created.");

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createFolder-Object

Table Row (tr)

id	name

Table Cell (td)
createFolder

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

createFolder

Span
(destination)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} destination

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var d = plugins.file.convertToJSFile("newfolder");
if (!plugins.file.createFolder(d))
	application.output("Folder could not be created.");

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createTempFile-String_String

Table Row (tr)

id	name

Table Cell (td)
createTempFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

createTempFile

Span
(prefix, suffix)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} prefix
{String} suffix

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var tempFile = plugins.file.createTempFile('myfile','.txt');
application.output('Temporary file created as: ' + tempFile.getAbsolutePath());
plugins.file.writeTXTFile(tempFile, 'abcdefg');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	deleteFile-Object

Table Row (tr)

id	name

Table Cell (td)
deleteFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

deleteFile

Span
(destination)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} destination

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

if (plugins.file.deleteFile('story.txt'))
	application.output('File deleted.');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	deleteFolder-Object_Boolean

Table Row (tr)

id	name

Table Cell (td)
deleteFolder

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

deleteFolder

Span
(destination, showWarning)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} destination
{Boolean} showWarning

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

if (plugins.file.deleteFolder('stories', true))
	application.output('Folder deleted.');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getDefaultUploadLocation

Table Row (tr)

id	name

Table Cell (td)
getDefaultUploadLocation

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getDefaultUploadLocation

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the default upload location path of the server.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the location as canonical path

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// get the (server-side) default upload location path:
var serverPath = plugins.file.getDefaultUploadLocation();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getDesktopFolder

Table Row (tr)

id	name

Table Cell (td)
getDesktopFolder

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

getDesktopFolder

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var d = plugins.file.getDesktopFolder();
application.output('desktop folder is: ' + d.getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getDiskList

Table Row (tr)

id	name

Table Cell (td)
getDiskList

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getDiskList

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var roots = plugins.file.getDiskList();
for (var i = 0; i < roots.length; i++)
	application.output(roots[i].getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFileSize-Object

Table Row (tr)

id	name

Table Cell (td)
getFileSize

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getFileSize

Span
(path)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the size of the specified file.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} path

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var f = plugins.file.convertToJSFile('story.txt');
application.output('file size: ' + plugins.file.getFileSize(f));

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFolderContents-JSFile

Table Row (tr)

id	name

Table Cell (td)
getFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getFolderContents

Span
(targetFolder)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSFile} targetFolder - JSFile object.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFolderContents-JSFile_Object

Table Row (tr)

id	name

Table Cell (td)
getFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getFolderContents

Span
(targetFolder, fileFilter)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFolderContents-JSFile_Object_Number

Table Row (tr)

id	name

Table Cell (td)
getFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getFolderContents

Span
(targetFolder, fileFilter, fileOption)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFolderContents-JSFile_Object_Number_Number

Table Row (tr)

id	name

Table Cell (td)
getFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getFolderContents

Span
(targetFolder, fileFilter, fileOption, visibleOption)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFolderContents-JSFile_Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
getFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getFolderContents

Span
(targetFolder, fileFilter, fileOption, visibleOption, lockedOption)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSFile} targetFolder - JSFile object.
{Object} fileFilter - Filter or array of filters for files in folder.
{Number} fileOption - 1=files, 2=dirs
{Number} visibleOption - 1=visible, 2=nonvisible
{Number} lockedOption - 1=locked, 2=nonlocked

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFolderContents-String

Table Row (tr)

id	name

Table Cell (td)
getFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getFolderContents

Span
(targetFolder)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} targetFolder - File path.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFolderContents-String_Object

Table Row (tr)

id	name

Table Cell (td)
getFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getFolderContents

Span
(targetFolder, fileFilter)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFolderContents-String_Object_Number

Table Row (tr)

id	name

Table Cell (td)
getFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getFolderContents

Span
(targetFolder, fileFilter, fileOption)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFolderContents-String_Object_Number_Number

Table Row (tr)

id	name

Table Cell (td)
getFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getFolderContents

Span
(targetFolder, fileFilter, fileOption, visibleOption)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFolderContents-String_Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
getFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getFolderContents

Span
(targetFolder, fileFilter, fileOption, visibleOption, lockedOption)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} targetFolder - File path.
{Object} fileFilter - Filter or array of filters for files in folder.
{Number} fileOption - 1=files, 2=dirs
{Number} visibleOption - 1=visible, 2=nonvisible
{Number} lockedOption - 1=locked, 2=nonlocked

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getHomeFolder

Table Row (tr)

id	name

Table Cell (td)
getHomeFolder

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

getHomeFolder

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var d = plugins.file.getHomeFolder();
application.output('home folder: ' + d.getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getModificationDate-Object

Table Row (tr)

id	name

Table Cell (td)
getModificationDate

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Date

Span

style	font-weight: bold;

getModificationDate

Span
(path)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the modification date of a file.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} path

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Date

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var f = plugins.file.convertToJSFile('story.txt');
application.output('last changed: ' + plugins.file.getModificationDate(f));

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRemoteFolderContents-JSFile

Table Row (tr)

id	name

Table Cell (td)
getRemoteFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getRemoteFolderContents

Span
(targetFolder)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

Servoy 5.2.1

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSFile} targetFolder

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[] - the array of file names

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRemoteFolderContents-JSFile_Object

Table Row (tr)

id	name

Table Cell (td)
getRemoteFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getRemoteFolderContents

Span
(targetFolder, fileFilter)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[] - the array of file names

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRemoteFolderContents-JSFile_Object_Number

Table Row (tr)

id	name

Table Cell (td)
getRemoteFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getRemoteFolderContents

Span
(targetFolder, fileFilter, fileOption)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[] - the array of file names

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRemoteFolderContents-JSFile_Object_Number_Number

Table Row (tr)

id	name

Table Cell (td)
getRemoteFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getRemoteFolderContents

Span
(targetFolder, fileFilter, fileOption, visibleOption)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[] - the array of file names

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRemoteFolderContents-JSFile_Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
getRemoteFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getRemoteFolderContents

Span
(targetFolder, fileFilter, fileOption, visibleOption, lockedOption)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSFile} targetFolder - Folder as JSFile object.
{Object} fileFilter - Filter or array of filters for files in folder.
{Number} fileOption - 1=files, 2=dirs
{Number} visibleOption - 1=visible, 2=nonvisible
{Number} lockedOption - 1=locked, 2=nonlocked

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[] - the array of file names

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRemoteFolderContents-String

Table Row (tr)

id	name

Table Cell (td)
getRemoteFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getRemoteFolderContents

Span
(targetFolder)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} targetFolder - Folder path.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[] - the array of file names

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRemoteFolderContents-String_Object

Table Row (tr)

id	name

Table Cell (td)
getRemoteFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getRemoteFolderContents

Span
(targetFolder, fileFilter)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[] - the array of file names

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRemoteFolderContents-String_Object_Number

Table Row (tr)

id	name

Table Cell (td)
getRemoteFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getRemoteFolderContents

Span
(targetFolder, fileFilter, fileOption)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[] - the array of file names

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRemoteFolderContents-String_Object_Number_Number

Table Row (tr)

id	name

Table Cell (td)
getRemoteFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getRemoteFolderContents

Span
(targetFolder, fileFilter, fileOption, visibleOption)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[] - the array of file names

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRemoteFolderContents-String_Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
getRemoteFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile[]

Span

style	font-weight: bold;

getRemoteFolderContents

Span
(targetFolder, fileFilter, fileOption, visibleOption, lockedOption)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} targetFolder - Folder path.
{Object} fileFilter - Filter or array of filters for files in folder.
{Number} fileOption - 1=files, 2=dirs
{Number} visibleOption - 1=visible, 2=nonvisible
{Number} lockedOption - 1=locked, 2=nonlocked

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile[] - the array of file names

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// retrieves an array of files located on the server side inside the default upload folder:
var files = plugins.file.getRemoteFolderContents('/', '.txt');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	moveFile-Object_Object

Table Row (tr)

id	name

Table Cell (td)
moveFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

moveFile

Span
(source, destination)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} source
{Object} destination

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Move file based on names.
if (!plugins.file.moveFile('story.txt','story.txt.new'))
	application.output('File move failed.');
// Move file based on JSFile instances.
var f = plugins.file.convertToJSFile('story.txt.new');
var fmoved = plugins.file.convertToJSFile('story.txt');
if (!plugins.file.moveFile(f, fmoved))
	application.output('File move back failed.');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	openFile-JSFile

Table Row (tr)

id	name

Table Cell (td)
openFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

openFile

Span
(file)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Launches the associated application to open the file.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSFile} file

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - success status of the open operation

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myPDF = plugins.file.createFile('my.pdf');
 myPDF.setBytes(data, true)
	plugins.file.openFile(myPDF);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	readFile

Table Row (tr)

id	name

Table Cell (td)
readFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

byte[]

Span

style	font-weight: bold;

readFile

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

byte[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Read all content from the file.
var bytes = plugins.file.readFile('big.jpg');
application.output('file size: ' + bytes.length);
// Read only the first 1KB from the file.
var bytesPartial = plugins.file.readFile('big.jpg', 1024);
application.output('partial file size: ' + bytesPartial.length);
// Read all content from a file selected from the file open dialog.
var bytesUnknownFile = plugins.file.readFile();
application.output('unknown file size: ' + bytesUnknownFile.length);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	readFile-JSFile

Table Row (tr)

id	name

Table Cell (td)
readFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

byte[]

Span

style	font-weight: bold;

readFile

Span
(file)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSFile} file - JSFile.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

byte[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Read all content from the file.
var bytes = plugins.file.readFile('big.jpg');
application.output('file size: ' + bytes.length);
// Read only the first 1KB from the file.
var bytesPartial = plugins.file.readFile('big.jpg', 1024);
application.output('partial file size: ' + bytesPartial.length);
// Read all content from a file selected from the file open dialog.
var bytesUnknownFile = plugins.file.readFile();
application.output('unknown file size: ' + bytesUnknownFile.length);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	readFile-JSFile_Number

Table Row (tr)

id	name

Table Cell (td)
readFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

byte[]

Span

style	font-weight: bold;

readFile

Span
(file, size)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

byte[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Read all content from the file.
var bytes = plugins.file.readFile('big.jpg');
application.output('file size: ' + bytes.length);
// Read only the first 1KB from the file.
var bytesPartial = plugins.file.readFile('big.jpg', 1024);
application.output('partial file size: ' + bytesPartial.length);
// Read all content from a file selected from the file open dialog.
var bytesUnknownFile = plugins.file.readFile();
application.output('unknown file size: ' + bytesUnknownFile.length);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	readFile-String

Table Row (tr)

id	name

Table Cell (td)
readFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

byte[]

Span

style	font-weight: bold;

readFile

Span
(file)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} file - the file path.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

byte[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Read all content from the file.
var bytes = plugins.file.readFile('big.jpg');
application.output('file size: ' + bytes.length);
// Read only the first 1KB from the file.
var bytesPartial = plugins.file.readFile('big.jpg', 1024);
application.output('partial file size: ' + bytesPartial.length);
// Read all content from a file selected from the file open dialog.
var bytesUnknownFile = plugins.file.readFile();
application.output('unknown file size: ' + bytesUnknownFile.length);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	readFile-String_Number

Table Row (tr)

id	name

Table Cell (td)
readFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

byte[]

Span

style	font-weight: bold;

readFile

Span
(file, size)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

byte[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Read all content from the file.
var bytes = plugins.file.readFile('big.jpg');
application.output('file size: ' + bytes.length);
// Read only the first 1KB from the file.
var bytesPartial = plugins.file.readFile('big.jpg', 1024);
application.output('partial file size: ' + bytesPartial.length);
// Read all content from a file selected from the file open dialog.
var bytesUnknownFile = plugins.file.readFile();
application.output('unknown file size: ' + bytesUnknownFile.length);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	readTXTFile

Table Row (tr)

id	name

Table Cell (td)
readTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

readTXTFile

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Read content from a known text file.
var txt = plugins.file.readTXTFile('story.txt');
application.output(txt);
// Read content from a text file selected from the file open dialog.
var txtUnknown = plugins.file.readTXTFile();
application.output(txtUnknown);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	readTXTFile-JSFile

Table Row (tr)

id	name

Table Cell (td)
readTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

readTXTFile

Span
(file)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSFile} file - JSFile.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Read content from a known text file.
var txt = plugins.file.readTXTFile('story.txt');
application.output(txt);
// Read content from a text file selected from the file open dialog.
var txtUnknown = plugins.file.readTXTFile();
application.output(txtUnknown);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	readTXTFile-JSFile_String

Table Row (tr)

id	name

Table Cell (td)
readTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

readTXTFile

Span
(file, charsetname)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Read content from a known text file.
var txt = plugins.file.readTXTFile('story.txt');
application.output(txt);
// Read content from a text file selected from the file open dialog.
var txtUnknown = plugins.file.readTXTFile();
application.output(txtUnknown);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	readTXTFile-String

Table Row (tr)

id	name

Table Cell (td)
readTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

readTXTFile

Span
(file)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} file - the file path.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Read content from a known text file.
var txt = plugins.file.readTXTFile('story.txt');
application.output(txt);
// Read content from a text file selected from the file open dialog.
var txtUnknown = plugins.file.readTXTFile();
application.output(txtUnknown);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	readTXTFile-String_String

Table Row (tr)

id	name

Table Cell (td)
readTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

readTXTFile

Span
(file, charsetname)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Read content from a known text file.
var txt = plugins.file.readTXTFile('story.txt');
application.output(txt);
// Read content from a text file selected from the file open dialog.
var txtUnknown = plugins.file.readTXTFile();
application.output(txtUnknown);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showDirectorySelectDialog

Table Row (tr)

id	name

Table Cell (td)
showDirectorySelectDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

showDirectorySelectDialog

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Shows a directory selector dialog.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showDirectorySelectDialog-JSFile

Table Row (tr)

id	name

Table Cell (td)
showDirectorySelectDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

showDirectorySelectDialog

Span
(directory)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Shows a directory selector dialog.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSFile} directory - Default directory as JSFile.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showDirectorySelectDialog-JSFile_String

Table Row (tr)

id	name

Table Cell (td)
showDirectorySelectDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

showDirectorySelectDialog

Span
(directory, title)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Shows a directory selector dialog.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showDirectorySelectDialog-String

Table Row (tr)

id	name

Table Cell (td)
showDirectorySelectDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

showDirectorySelectDialog

Span
(directory)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Shows a directory selector dialog.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} directory - Default directory as file path.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showDirectorySelectDialog-String_String

Table Row (tr)

id	name

Table Cell (td)
showDirectorySelectDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

showDirectorySelectDialog

Span
(directory, title)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Shows a directory selector dialog.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
(selectionMode)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_JSFile

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
(selectionMode, startDirectory)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_JSFile_Boolean

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
(selectionMode, startDirectory, multiselect)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_JSFile_Boolean_Object

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
(selectionMode, startDirectory, multiselect, filter)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} selectionMode - 0=both,1=Files,2=Dirs
{JSFile} startDirectory - JSFile instance of default folder,null=default/previous
{Boolean} multiselect - true/false
{Object} filter - A filter or array of filters on the folder files.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_JSFile_Boolean_Object_Function

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} selectionMode - 0=both,1=Files,2=Dirs
{JSFile} startDirectory - JSFile instance of default folder,null=default/previous
{Boolean} multiselect - true/false
{Object} filter - A filter or array of filters on the folder files.
{Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_JSFile_Boolean_Object_Function_String

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} selectionMode - 0=both,1=Files,2=Dirs
{JSFile} startDirectory - JSFile instance of default folder, null=default/previous
{Boolean} multiselect - true/false
{Object} filter - A filter or array of filters on the folder files.
{Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument
{String} title - The tile of the dialog

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_JSFile_Boolean_Function

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
(selectionMode, startDirectory, multiselect, callbackfunction)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} selectionMode - 0=both,1=Files,2=Dirs
{JSFile} startDirectory - JSFile instance of default folder,null=default/previous
{Boolean} multiselect - true/false
{Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_JSFile_Function

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
(selectionMode, startDirectory, callbackfunction)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} selectionMode - 0=both,1=Files,2=Dirs
{JSFile} startDirectory - JSFile instance of default folder,null=default/previous
{Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_String

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
(selectionMode, startDirectory)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_String_Boolean

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
(selectionMode, startDirectory, multiselect)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_String_Boolean_Object

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
(selectionMode, startDirectory, multiselect, filter)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} selectionMode - 0=both,1=Files,2=Dirs
{String} startDirectory - Path to default folder,null=default/previous
{Boolean} multiselect - true/false
{Object} filter - A filter or array of filters on the folder files.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_String_Boolean_Object_Function

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} selectionMode - 0=both,1=Files,2=Dirs
{String} startDirectory - Path to default folder,null=default/previous
{Boolean} multiselect - true/false
{Object} filter - A filter or array of filters on the folder files.
{Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_String_Boolean_Object_Function_String

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} selectionMode - 0=both,1=Files,2=Dirs
{String} startDirectory - Path to default folder, null=default/previous
{Boolean} multiselect - true/false
{Object} filter - A filter or array of filters on the folder files.
{Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument
{String} title - The tile of the dialog

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_String_Boolean_Function

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
(selectionMode, startDirectory, multiselect, callbackfunction)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} selectionMode - 0=both,1=Files,2=Dirs
{String} startDirectory - Path to default folder,null=default/previous
{Boolean} multiselect - true/false
{Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_String_Function

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
(selectionMode, startDirectory, callbackfunction)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} selectionMode - 0=both,1=Files,2=Dirs
{String} startDirectory - Path to default folder,null=default/previous
{Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Number_Function

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
(selectionMode, callbackfunction)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} selectionMode - 0=both,1=Files,2=Dirs
{Function} callbackfunction - A function that takes the (JSFile) array of the selected files as first argument

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileOpenDialog-Function

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

showFileOpenDialog

Span
(callbackfunction)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
/** @type {JSFile} */
var f = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF", "jpg", "gif"));
application.output('File: ' + f.getName());
application.output('is dir: ' + f.isDirectory());
application.output('is file: ' + f.isFile());
application.output('path: ' + f.getAbsolutePath());

// This allows mutliple selection of files, using previous dir and the same filter as above. This also casts the result to the JSFile type using JSDoc.
// if filters are specified, "all file" filter will not show up unless "*" filter is present
/** @type {JSFile[]} */
var files = plugins.file.showFileOpenDialog(1, null, true, new Array("JPG and GIF", "jpg", "gif", "*"));
for (var i = 0; i < files.length; i++)
{
	 application.output('File: ' + files[i].getName());
	 application.output('content type: ' + files[i].getContentType());
	 application.output('last modified: ' + files[i].lastModified());
	 application.output('size: ' + files[i].size());
}
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), only multi select and the title are used in the webclient, others are ignored
plugins.file.showFileOpenDialog(null,null,false,new Array("JPG and GIF", "jpg", "gif"),mycallbackfunction,'Select some nice files')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileSaveDialog

Table Row (tr)

id	name

Table Cell (td)
showFileSaveDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

showFileSaveDialog

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Shows a file save dialog.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileSaveDialog-JSFile

Table Row (tr)

id	name

Table Cell (td)
showFileSaveDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

showFileSaveDialog

Span
(fileNameDir)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Shows a file save dialog.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSFile} fileNameDir - JSFile to save.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileSaveDialog-JSFile_String

Table Row (tr)

id	name

Table Cell (td)
showFileSaveDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

showFileSaveDialog

Span
(fileNameDir, title)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Shows a file save dialog.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileSaveDialog-String

Table Row (tr)

id	name

Table Cell (td)
showFileSaveDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

showFileSaveDialog

Span
(fileNameDir)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Shows a file save dialog.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileSaveDialog-String_String

Table Row (tr)

id	name

Table Cell (td)
showFileSaveDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSFile

Span

style	font-weight: bold;

showFileSaveDialog

Span
(fileNameDir, title)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Shows a file save dialog.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSFile

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	streamFilesFromServer-Object_Object

Table Row (tr)

id	name

Table Cell (td)
streamFilesFromServer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSProgressMonitor

Span

style	font-weight: bold;

streamFilesFromServer

Span
(files, serverFiles)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

Servoy 5.2

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} files - file(s) to be streamed into (can be a String path a JSFile) or an Array of these
{Object} serverFiles - the files on the server that will be transfered to the client, can be a String or a String[]

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// transfer all the files of a chosen server folder to a directory on the client
var dir = plugins.file.showDirectorySelectDialog();
if (dir) {
	var list = plugins.file.getRemoteFolderContents('/images/user1/', null, 1);
	if (list) {
		var monitor = plugins.file.streamFilesFromServer(dir, list, callbackFunction);
	}
}

// transfer one file on the client
var monitor = plugins.file.streamFilesFromServer('/path/to/file', 'path/to/serverFile', callbackFunction);

// transfer an array of serverFiles to an array of files on the client
var files = new Array();
files[0] = '/path/to/file1';
files[1] = '/path/to/file2';
var serverFiles = new Array();
serverFiles[0] = '/path/to/serverFile1';
serverFiles[1] = '/path/to/serverFile2';
var monitor = plugins.file.streamFilesFromServer(files, serverFiles, callbackFunction);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	streamFilesFromServer-Object_Object_Function

Table Row (tr)

id	name

Table Cell (td)
streamFilesFromServer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSProgressMonitor

Span

style	font-weight: bold;

streamFilesFromServer

Span
(files, serverFiles, callback)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

Servoy 5.2

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} files - file(s) to be streamed into (can be a String path or a JSFile) or an Array of these
{Object} serverFiles - the files on the server that will be transfered to the client, can be a JSFile or JSFile[], a String or String[]
{Function} callback - the Function to be called back at the end of the process (for every file); the callback function is invoked with argument the filename that was transfered; an extra second exception parameter can be given if an exception occured

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// transfer all the files of a chosen server folder to a directory on the client
var dir = plugins.file.showDirectorySelectDialog();
if (dir) {
	var list = plugins.file.getRemoteFolderContents('/images/user1/', null, 1);
	if (list) {
		var monitor = plugins.file.streamFilesFromServer(dir, list, callbackFunction);
	}
}

// transfer one file on the client
var monitor = plugins.file.streamFilesFromServer('/path/to/file', 'path/to/serverFile', callbackFunction);

// transfer an array of serverFiles to an array of files on the client
var files = new Array();
files[0] = '/path/to/file1';
files[1] = '/path/to/file2';
var serverFiles = new Array();
serverFiles[0] = '/path/to/serverFile1';
serverFiles[1] = '/path/to/serverFile2';
var monitor = plugins.file.streamFilesFromServer(files, serverFiles, callbackFunction);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	streamFilesToServer-Object

Table Row (tr)

id	name

Table Cell (td)
streamFilesToServer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSProgressMonitor

Span

style	font-weight: bold;

streamFilesToServer

Span
(files)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

Servoy 5.2

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// send one file:
var file = plugins.file.showFileOpenDialog( 1, null, false, null, null, 'Choose a file to transfer' );
if (file) {
	plugins.file.streamFilesToServer( file, callbackFunction );
}
//plugins.file.streamFilesToServer( 'servoy.txt', callbackFunction );

// send an array of files:
var folder = plugins.file.showDirectorySelectDialog();
if (folder) {
	var files = plugins.file.getFolderContents(folder);
	if (files) {
		var monitor = plugins.file.streamFilesToServer( files, callbackFunction );
	}
}
// var files = new Array()
// files[0] = 'file1.txt';
// files[1] = 'file2.txt';
// var monitor = plugins.file.streamFilesToServer( files, callbackFunction );

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	streamFilesToServer-Object_Object

Table Row (tr)

id	name

Table Cell (td)
streamFilesToServer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSProgressMonitor

Span

style	font-weight: bold;

streamFilesToServer

Span
(files, serverFiles)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

Servoy 5.2

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} files - file(s) to be streamed (can be a String path or a JSFile) or an Array of these
{Object} serverFiles - can be a JSFile or JSFile[], a String or String[], representing the file name(s) to use on the server

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// send one file:
var file = plugins.file.showFileOpenDialog( 1, null, false, null, null, 'Choose a file to transfer' );
if (file) {
	plugins.file.streamFilesToServer( file, callbackFunction );
}
//plugins.file.streamFilesToServer( 'servoy.txt', callbackFunction );

// send an array of files:
var folder = plugins.file.showDirectorySelectDialog();
if (folder) {
	var files = plugins.file.getFolderContents(folder);
	if (files) {
		var monitor = plugins.file.streamFilesToServer( files, callbackFunction );
	}
}
// var files = new Array()
// files[0] = 'file1.txt';
// files[1] = 'file2.txt';
// var monitor = plugins.file.streamFilesToServer( files, callbackFunction );

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	streamFilesToServer-Object_Object_Function

Table Row (tr)

id	name

Table Cell (td)
streamFilesToServer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSProgressMonitor

Span

style	font-weight: bold;

streamFilesToServer

Span
(files, serverFiles, callback)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

Servoy 5.2

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} files - file(s) to be streamed (can be a String path or a JSFile) or an Array of these)
{Object} serverFiles - can be a JSFile or JSFile[], a String or String[], representing the file name(s) to use on the server
{Function} callback - the Function to be called back at the end of the process (for every file); the callback function is invoked with argument the filename that was transfered; an extra second exception parameter can be given if an exception occured

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// send one file:
var file = plugins.file.showFileOpenDialog( 1, null, false, null, null, 'Choose a file to transfer' );
if (file) {
	plugins.file.streamFilesToServer( file, callbackFunction );
}
//plugins.file.streamFilesToServer( 'servoy.txt', callbackFunction );

// send an array of files:
var folder = plugins.file.showDirectorySelectDialog();
if (folder) {
	var files = plugins.file.getFolderContents(folder);
	if (files) {
		var monitor = plugins.file.streamFilesToServer( files, callbackFunction );
	}
}
// var files = new Array()
// files[0] = 'file1.txt';
// files[1] = 'file2.txt';
// var monitor = plugins.file.streamFilesToServer( files, callbackFunction );

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	streamFilesToServer-Object_Function

Table Row (tr)

id	name

Table Cell (td)
streamFilesToServer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSProgressMonitor

Span

style	font-weight: bold;

streamFilesToServer

Span
(files, callback)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

Servoy 5.2

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} files - file(s) to be streamed (can be a String path or a JSFile) or an Array of these
{Function} callback - the Function to be called back at the end of the process (for every file); the callback function is invoked with argument the filename that was transfered; an extra second exception parameter can be given if an exception occured

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// send one file:
var file = plugins.file.showFileOpenDialog( 1, null, false, null, null, 'Choose a file to transfer' );
if (file) {
	plugins.file.streamFilesToServer( file, callbackFunction );
}
//plugins.file.streamFilesToServer( 'servoy.txt', callbackFunction );

// send an array of files:
var folder = plugins.file.showDirectorySelectDialog();
if (folder) {
	var files = plugins.file.getFolderContents(folder);
	if (files) {
		var monitor = plugins.file.streamFilesToServer( files, callbackFunction );
	}
}
// var files = new Array()
// files[0] = 'file1.txt';
// files[1] = 'file2.txt';
// var monitor = plugins.file.streamFilesToServer( files, callbackFunction );

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeFile-JSFile_byteArray

Table Row (tr)

id	name

Table Cell (td)
writeFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeFile

Span
(file, data)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

/**@type {Array<byte>}*/
var bytes = new Array();
for (var i=0; i<1024; i++)
	bytes[i] = i % 100;
var f = plugins.file.convertToJSFile('bin.dat');
if (!plugins.file.writeFile(f, bytes))
	application.output('Failed to write the file.');
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'
var mimeType = 'application/vnd.ms-excel'
if (!plugins.file.writeFile(f, bytes, mimeType))
	application.output('Failed to write the file.');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeFile-JSFile_byteArray_String

Table Row (tr)

id	name

Table Cell (td)
writeFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeFile

Span
(file, data, mimeType)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

/**@type {Array<byte>}*/
var bytes = new Array();
for (var i=0; i<1024; i++)
	bytes[i] = i % 100;
var f = plugins.file.convertToJSFile('bin.dat');
if (!plugins.file.writeFile(f, bytes))
	application.output('Failed to write the file.');
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'
var mimeType = 'application/vnd.ms-excel'
if (!plugins.file.writeFile(f, bytes, mimeType))
	application.output('Failed to write the file.');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeFile-String_byteArray

Table Row (tr)

id	name

Table Cell (td)
writeFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeFile

Span
(file, data)

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

/**@type {Array<byte>}*/
var bytes = new Array();
for (var i=0; i<1024; i++)
	bytes[i] = i % 100;
var f = plugins.file.convertToJSFile('bin.dat');
if (!plugins.file.writeFile(f, bytes))
	application.output('Failed to write the file.');
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'
var mimeType = 'application/vnd.ms-excel'
if (!plugins.file.writeFile(f, bytes, mimeType))
	application.output('Failed to write the file.');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeFile-String_byteArray_String

Table Row (tr)

id	name

Table Cell (td)
writeFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeFile

Span
(file, data, mimeType)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

/**@type {Array<byte>}*/
var bytes = new Array();
for (var i=0; i<1024; i++)
	bytes[i] = i % 100;
var f = plugins.file.convertToJSFile('bin.dat');
if (!plugins.file.writeFile(f, bytes))
	application.output('Failed to write the file.');
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'
var mimeType = 'application/vnd.ms-excel'
if (!plugins.file.writeFile(f, bytes, mimeType))
	application.output('Failed to write the file.');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeTXTFile-JSFile_String

Table Row (tr)

id	name

Table Cell (td)
writeTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeTXTFile

Span
(file, text_data)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - Success boolean.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var fileNameSuggestion = 'myspecialexport.tab'
var textData = 'load of data...'
var success = plugins.file.writeTXTFile(fileNameSuggestion, textData);
if (!success) application.output('Could not write file.');
// For file-encoding parameter options (default OS encoding is used), http://download.oracle.com/javase/1.4.2/docs/guide/intl/encoding.doc.html
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeTXTFile-JSFile_String_String

Table Row (tr)

id	name

Table Cell (td)
writeTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeTXTFile

Span
(file, text_data, charsetname)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - Success boolean.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var fileNameSuggestion = 'myspecialexport.tab'
var textData = 'load of data...'
var success = plugins.file.writeTXTFile(fileNameSuggestion, textData);
if (!success) application.output('Could not write file.');
// For file-encoding parameter options (default OS encoding is used), http://download.oracle.com/javase/1.4.2/docs/guide/intl/encoding.doc.html
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeTXTFile-JSFile_String_String_String

Table Row (tr)

id	name

Table Cell (td)
writeTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeTXTFile

Span
(file, text_data, charsetname, mimeType)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - Success boolean.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var fileNameSuggestion = 'myspecialexport.tab'
var textData = 'load of data...'
var success = plugins.file.writeTXTFile(fileNameSuggestion, textData);
if (!success) application.output('Could not write file.');
// For file-encoding parameter options (default OS encoding is used), http://download.oracle.com/javase/1.4.2/docs/guide/intl/encoding.doc.html
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeTXTFile-String_String

Table Row (tr)

id	name

Table Cell (td)
writeTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeTXTFile

Span
(file, text_data)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var fileNameSuggestion = 'myspecialexport.tab'
var textData = 'load of data...'
var success = plugins.file.writeTXTFile(fileNameSuggestion, textData);
if (!success) application.output('Could not write file.');
// For file-encoding parameter options (default OS encoding is used), http://download.oracle.com/javase/1.4.2/docs/guide/intl/encoding.doc.html
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeTXTFile-String_String_String

Table Row (tr)

id	name

Table Cell (td)
writeTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeTXTFile

Span
(file, text_data, charsetname)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var fileNameSuggestion = 'myspecialexport.tab'
var textData = 'load of data...'
var success = plugins.file.writeTXTFile(fileNameSuggestion, textData);
if (!success) application.output('Could not write file.');
// For file-encoding parameter options (default OS encoding is used), http://download.oracle.com/javase/1.4.2/docs/guide/intl/encoding.doc.html
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeTXTFile-String_String_String_String

Table Row (tr)

id	name

Table Cell (td)
writeTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeTXTFile

Span
(file, text_data, charsetname, mimeType)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var fileNameSuggestion = 'myspecialexport.tab'
var textData = 'load of data...'
var success = plugins.file.writeTXTFile(fileNameSuggestion, textData);
if (!success) application.output('Could not write file.');
// For file-encoding parameter options (default OS encoding is used), http://download.oracle.com/javase/1.4.2/docs/guide/intl/encoding.doc.html
// mimeType variable can be left null, and is used for webclient only. Specify one of any valid mime types as referenced here: http://www.w3schools.com/media/media_mimeref.asp'

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeXMLFile-JSFile_String

Table Row (tr)

id	name

Table Cell (td)
writeXMLFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeXMLFile

Span
(file, xml_data)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var fileName = 'form.xml'
var xml = controller.printXML()
var success = plugins.file.writeXMLFile(fileName, xml);
if (!success) application.output('Could not write file.');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeXMLFile-JSFile_String_String

Table Row (tr)

id	name

Table Cell (td)
writeXMLFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeXMLFile

Span
(file, xml_data, encoding)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var fileName = 'form.xml'
var xml = controller.printXML()
var success = plugins.file.writeXMLFile(fileName, xml);
if (!success) application.output('Could not write file.');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeXMLFile-String_String

Table Row (tr)

id	name

Table Cell (td)
writeXMLFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeXMLFile

Span
(file, xml_data)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var fileName = 'form.xml'
var xml = controller.printXML()
var success = plugins.file.writeXMLFile(fileName, xml);
if (!success) application.output('Could not write file.');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeXMLFile-String_String_String

Table Row (tr)

id	name

Table Cell (td)
writeXMLFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

writeXMLFile

Span
(file, xml_data, encoding)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var fileName = 'form.xml'
var xml = controller.printXML()
var success = plugins.file.writeXMLFile(fileName, xml);
if (!success) application.output('Could not write file.');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Page History

Versions Compared

Old Version 31

New Version Current

Key

servoy.FileServerService.defaultFolder

appendToTXTFile

appendToTXTFile

appendToTXTFile

appendToTXTFile

convertToJSFile

convertToRemoteJSFile

copyFile

copyFolder

createFile

createFolder

createTempFile

deleteFile

deleteFolder

getDefaultUploadLocation

getDesktopFolder

getDiskList

getFileSize

getFolderContents

getFolderContents

getFolderContents

getFolderContents

getFolderContents

getFolderContents

getFolderContents

getFolderContents

getFolderContents

getFolderContents

getHomeFolder

getModificationDate

getRemoteFolderContents

getRemoteFolderContents

getRemoteFolderContents

getRemoteFolderContents

getRemoteFolderContents

getRemoteFolderContents

getRemoteFolderContents

getRemoteFolderContents

getRemoteFolderContents

getRemoteFolderContents

moveFile

openFile

readFile

readFile

readFile

readFile

readFile

readTXTFile

readTXTFile

readTXTFile

readTXTFile

readTXTFile

showDirectorySelectDialog

showDirectorySelectDialog

showDirectorySelectDialog

showDirectorySelectDialog

showDirectorySelectDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog

showFileOpenDialog