Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

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

class	servoy sReturnTypes

Table Row (tr)

style	height: 30px;

Table Head (th)
Return Types

Table Row (tr)

Table Cell (td)

Span

class	sWordList

JSFile

Span

class	sWordList

JSProgressMonitor

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Server Property Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#servoy.FileServerService.defaultFolder

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#appendToTXTFile(file/fileName, text, [encoding]) Appends data into a text file.

Table Body (tbody)

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 Body (tbody)

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
#convertToRemoteJSFile(serverPath) Returns the JSFile object of a server file, given its path (relative the default server location).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#copyFolder(sourceFolder, destinationFolder) Copies the sourcefolder to the destination folder, recursively.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSFile

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
#createTempFile(filePrefix, fileSuffix) Creates a temporary file on disk.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

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 Body (tbody)

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 Body (tbody)

Table Row (tr)

Table Cell (td)
Number

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSFile[]

Table Cell (td)
#getFolderContents(targetFolder, [fileFilter], [fileOption(1=files,2=dirs)], [visibleOption(1=visible,2=nonvisible)], [lockedOption(1=locked,2=nonlocked)]) Returns an array of JSFile instances corresponding to content of the specified folder.

Table Body (tbody)

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 Body (tbody)

Table Row (tr)

Table Cell (td)
Date

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSFile[]

Table Cell (td)
#getRemoteFolderContents(targetFolder, [fileFilter], [fileOption(1=files,2=dirs)], [visibleOption(1=visible,2=nonvisible)], [lockedOption(1=locked,2=nonlocked)]) Returns an array of JSFile instances corresponding to content of the specified folder on the server side.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

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 Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
#showDirectorySelectDialog([directory suggestion], [dialog title text]) Shows a directory selector dialog.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
#showFileOpenDialog([selectionMode(0=both,1=Files,2=Dirs)], [startDirectory(null=default/previous)], [multiselect(true/false)], [filterarray], [callbackmethod], [dialog title text]) Shows a file open dialog.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSFile

Table Cell (td)
#showFileSaveDialog([fileName/dir suggestion], [dialog title text]) Shows a file save dialog.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSProgressMonitor

Table Cell (td)
#streamFilesFromServer(file/fileName\|fileArray/fileNameArray, serverFile/serverFileName\|serverFileArray/serverFileNameArray, [callbackFunction]) Streams a file or an array of files from the server in a background task to a file (or files) on the client.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSProgressMonitor

Table Cell (td)
#streamFilesToServer(file/fileName\|fileArray/fileNameArray, [serverFile/serverFileName\|serverFileArray/serverFileNameArray], [callbackFunction]) Streams a file or an array of files to the server in a background task - with optional relative path(s)/(new) name(s).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#writeFile(file, binary_data, [mimeType]) Writes data into a binary file.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

HTML Table

id	serverProperty
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Server Property Details

Table Body (tbody)

id	servoy.FileServerService.defaultFolder
class	node

Table Row (tr)

id	name

Table Cell (td)
servoy.FileServerService.defaultFolder

Table Row (tr)

id	des

Table Cell (td)
Set the default folder path (absolute path on the server) to save files sent by clients (will default to $ServoyInstallationDirectory$/server/webapps/ROOT/uploads/)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	appendToTXTFile
class	node

Table Row (tr)

id	name

Table Cell (td)
appendToTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

appendToTXTFile

Span

style	float: left;
id	iets

(file/fileName, text, [encoding])

Table Row (tr)

id	des

Table Cell (td)
Appends data into a text file.

Table Row (tr)

id	prs

Table Cell (td)
Parameters file/fileName text [encoding]

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
convertToJSFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile

Span

style	float: left; font-weight: bold;
id	iets

convertToJSFile

Span

style	float: left;
id	iets

(file)

Table Row (tr)

id	des

Table Cell (td)
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 file

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
convertToRemoteJSFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile

Span

style	float: left; font-weight: bold;
id	iets

convertToRemoteJSFile

Span

style	float: left;
id	iets

(serverPath)

Table Row (tr)

id	des

Table Cell (td)
Returns the JSFile object of a server file, given its path (relative the default server location).

Table Row (tr)

id	prs

Table Cell (td)
Parameters serverPath

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
copyFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

copyFile

Span

style	float: left;
id	iets

(sourceFile, destinationFile)

Table Row (tr)

id	des

Table Cell (td)
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 sourceFile destinationFile

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
copyFolder

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

copyFolder

Span

style	float: left;
id	iets

(sourceFolder, destinationFolder)

Table Row (tr)

id	des

Table Cell (td)
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 sourceFolder destinationFolder

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
createFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile

Span

style	float: left; font-weight: bold;
id	iets

createFile

Span

style	float: left;
id	iets

(targetFile)

Table Row (tr)

id	des

Table Cell (td)
Creates a JSFile instance. Does not create the file on disk.

Table Row (tr)

id	prs

Table Cell (td)
Parameters targetFile

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
createFolder

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

createFolder

Span

style	float: left;
id	iets

(targetFolder)

Table Row (tr)

id	des

Table Cell (td)
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 targetFolder

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
createTempFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile

Span

style	float: left; font-weight: bold;
id	iets

createTempFile

Span

style	float: left;
id	iets

(filePrefix, fileSuffix)

Table Row (tr)

id	des

Table Cell (td)
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 filePrefix fileSuffix

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
deleteFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

deleteFile

Span

style	float: left;
id	iets

(targetFile)

Table Row (tr)

id	des

Table Cell (td)
Removes a file from disk. Returns true on success, false otherwise.

Table Row (tr)

id	prs

Table Cell (td)
Parameters targetFile

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
deleteFolder

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

deleteFolder

Span

style	float: left;
id	iets

(targetFolder, showWarning)

Table Row (tr)

id	des

Table Cell (td)
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 targetFolder showWarning

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getDefaultUploadLocation

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getDefaultUploadLocation

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns String

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
class	node

Table Row (tr)

id	name

Table Cell (td)
getDesktopFolder

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile

Span

style	float: left; font-weight: bold;
id	iets

getDesktopFolder

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getDiskList

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile[]

Span

style	float: left; font-weight: bold;
id	iets

getDiskList

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getFileSize

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getFileSize

Span

style	float: left;
id	iets

(targetFile)

Table Row (tr)

id	des

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

Table Row (tr)

id	prs

Table Cell (td)
Parameters targetFile

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile[]

Span

style	float: left; font-weight: bold;
id	iets

getFolderContents

Span

style	float: left;
id	iets

(targetFolder, [fileFilter], [fileOption(1=files,2=dirs)], [visibleOption(1=visible,2=nonvisible)], [lockedOption(1=locked,2=nonlocked)])

Table Row (tr)

id	des

Table Cell (td)
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 targetFolder [fileFilter] [fileOption(1=files,2=dirs)] [visibleOption(1=visible,2=nonvisible)] [lockedOption(1=locked,2=nonlocked)]

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getHomeFolder

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile

Span

style	float: left; font-weight: bold;
id	iets

getHomeFolder

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getModificationDate

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Date

Span

style	float: left; font-weight: bold;
id	iets

getModificationDate

Span

style	float: left;
id	iets

(targetFile)

Table Row (tr)

id	des

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

Table Row (tr)

id	prs

Table Cell (td)
Parameters targetFile

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getRemoteFolderContents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile[]

Span

style	float: left; font-weight: bold;
id	iets

getRemoteFolderContents

Span

style	float: left;
id	iets

(targetFolder, [fileFilter], [fileOption(1=files,2=dirs)], [visibleOption(1=visible,2=nonvisible)], [lockedOption(1=locked,2=nonlocked)])

Table Row (tr)

id	des

Table Cell (td)
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 targetFolder [fileFilter] [fileOption(1=files,2=dirs)] [visibleOption(1=visible,2=nonvisible)] [lockedOption(1=locked,2=nonlocked)]

Table Row (tr)

id	ret

Table Cell (td)
Returns JSFile[]

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
class	node

Table Row (tr)

id	name

Table Cell (td)
moveFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

moveFile

Span

style	float: left;
id	iets

(sourceFile, destinationFile)

Table Row (tr)

id	des

Table Cell (td)
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 sourceFile destinationFile

Table Row (tr)

id	ret

Table Cell (td)
Returns 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	readFile
class	node

Table Row (tr)

id	name

Table Cell (td)
readFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

byte[]

Span

style	float: left; font-weight: bold;
id	iets

readFile

Span

style	float: left;
id	iets

([file], [size])

Table Row (tr)

id	des

Table Cell (td)
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 [file] [size]

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
readTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

readTXTFile

Span

style	float: left;
id	iets

([file], [charsetname])

Table Row (tr)

id	des

Table Cell (td)
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 [file] [charsetname]

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
showDirectorySelectDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile

Span

style	float: left; font-weight: bold;
id	iets

showDirectorySelectDialog

Span

style	float: left;
id	iets

([directory suggestion], [dialog title text])

Table Row (tr)

id	des

Table Cell (td)
Shows a directory selector dialog.

Table Row (tr)

id	prs

Table Cell (td)
Parameters [directory suggestion] [dialog title text]

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
showFileOpenDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Object

Span

style	float: left; font-weight: bold;
id	iets

showFileOpenDialog

Span

style	float: left;
id	iets

([selectionMode(0=both,1=Files,2=Dirs)], [startDirectory(null=default/previous)], [multiselect(true/false)], [filterarray], [callbackmethod], [dialog title text])

Table Row (tr)

id	des

Table Cell (td)
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 [selectionMode(0=both,1=Files,2=Dirs)] [startDirectory(null=default/previous)] [multiselect(true/false)] [filterarray] [callbackmethod] [dialog title text]

Table Row (tr)

id	ret

Table Cell (td)
Returns 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.
/** @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), other options can be set but are not used in the webclient (yet)
var file = plugins.file.showFileOpenDialog(myCallbackMethod)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFileSaveDialog
class	node

Table Row (tr)

id	name

Table Cell (td)
showFileSaveDialog

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSFile

Span

style	float: left; font-weight: bold;
id	iets

showFileSaveDialog

Span

style	float: left;
id	iets

([fileName/dir suggestion], [dialog title text])

Table Row (tr)

id	des

Table Cell (td)
Shows a file save dialog.

Table Row (tr)

id	prs

Table Cell (td)
Parameters [fileName/dir suggestion] [dialog title text]

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
streamFilesFromServer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSProgressMonitor

Span

style	float: left; font-weight: bold;
id	iets

streamFilesFromServer

Span

style	float: left;
id	iets

(file/fileName|fileArray/fileNameArray, serverFile/serverFileName|serverFileArray/serverFileNameArray, [callbackFunction])

Table Row (tr)

id	des

Table Cell (td)

Streams a file or an array of files from the server in a background task to a file (or files) on the client. If provided, calls back a Servoy function when done for each file received with a JSFile and an exception if anything went wrong, returns a JSProgressMonitor object. Note: This only streams files for the smart client, in the webclient the streaming from the server to the browser is done by the browser

Table Row (tr)

id	prs

Table Cell (td)
Parameters file/fileName\|fileArray/fileNameArray serverFile/serverFileName\|serverFileArray/serverFileNameArray [callbackFunction]

Table Row (tr)

id	ret

Table Cell (td)
Returns JSProgressMonitor

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	streamFilesToServer
class	node

Table Row (tr)

id	name

Table Cell (td)
streamFilesToServer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSProgressMonitor

Span

style	float: left; font-weight: bold;
id	iets

streamFilesToServer

Span

style	float: left;
id	iets

(file/fileName|fileArray/fileNameArray, [serverFile/serverFileName|serverFileArray/serverFileNameArray], [callbackFunction])

Table Row (tr)

id	des

Table Cell (td)

Streams a file or an array of files to the server in a background task - with optional relative path(s)/(new) name(s). If provided, calls back a Servoy function when done for each file received with a JSFile and an exception if anything went wrong, returns a JSProgressMonitor object. Note: This only streams files for the smart client, in the webclient the streaming from the browser to the server is done by the browser

Table Row (tr)

id	prs

Table Cell (td)
Parameters file/fileName\|fileArray/fileNameArray [serverFile/serverFileName\|serverFileArray/serverFileNameArray] [callbackFunction]

Table Row (tr)

id	ret

Table Cell (td)
Returns JSProgressMonitor

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 );
	}
	// 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 );
		}
	}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	writeFile
class	node

Table Row (tr)

id	name

Table Cell (td)
writeFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

writeFile

Span

style	float: left;
id	iets

(file, binary_data, [mimeType])

Table Row (tr)

id	des

Table Cell (td)
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 file binary_data [mimeType]

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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
class	node

Table Row (tr)

id	name

Table Cell (td)
writeTXTFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

writeTXTFile

Span

style	float: left;
id	iets

(file, text_data, [charsetname], [mimeType])

Table Row (tr)

id	des

Table Cell (td)
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 file text_data [charsetname] [mimeType]

Table Row (tr)

id	ret

Table Cell (td)
Returns 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://java.sun.com/j2se/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
class	node

Table Row (tr)

id	name

Table Cell (td)
writeXMLFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

writeXMLFile

Span

style	float: left;
id	iets

(file, xml_data)

Table Row (tr)

id	des

Table Cell (td)
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 file xml_data

Table Row (tr)

id	ret

Table Cell (td)
Returns 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

Versions Compared

Old Version 15

New Version Current

Key

servoy.FileServerService.defaultFolder

appendToTXTFile

convertToJSFile

convertToRemoteJSFile

copyFile

copyFolder

createFile

createFolder

createTempFile

deleteFile

deleteFolder

getDefaultUploadLocation

getDesktopFolder

getDiskList

getFileSize

getFolderContents

getHomeFolder

getModificationDate

getRemoteFolderContents

moveFile

readFile

readTXTFile

showDirectorySelectDialog

showFileOpenDialog

showFileSaveDialog

streamFilesFromServer

streamFilesToServer

writeFile

writeTXTFile

writeXMLFile