Page History

...

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.

HTML Table

id	class	servoy sReturnTypes

Table Row (tr)

style	height: 30px;

Table Head (th)
Return Types

Table Row (tr)

Table Cell (td)

Span

class	sWordList

JSFile

id

HTML Table

class	servoy sSummery

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Server Property Summery

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#servoy.FileServerService.defaultFolder

id

HTML Table

class	servoy sSummery

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summery

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 sourcefile 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)
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)
#getHomeDirectory() 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)
#getRemoteList(serverFolder/serverFolderPath, [filesOnly]) Retrieves a list of files existing in a folder on the server side (in the path provided, relative to the default server location)

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)
void

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)
void

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.

...

Child pages

Versions Compared

Old Version 8

New Version 9

Key