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{hidden}
{sub-section:description|text=}{sub-section}\\ 

{table:id=|class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Return Types Details{th}{tr}{tr}{td}{span:class=sWordList}[JSFile]{span}{td}{tr}{table}\\ 

{table:id=|class=servoy sSummery}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}MethodServer Property SummarySummery{th}{tr}{tbody}{tr}{td}[JSFile]{td}{td}[#convertToJSFile]\(file)
Returns a JSFile instance corresponding to an alternative representation of a file (for example a string).{td}{tr}{tbody#servoy.FileServerService.defaultFolder]
{td}{tr}{tbody}{table}\\ 

{table:id=|class=servoy sSummery}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summery{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#copyFile#appendToTXTFile]\(sourceFilefile/fileName, text, destinationFile\[encoding])
CopiesAppends thedata sourcefileinto toa thetext destination file.{td}{tr}{tbody}{tbody}{tr}{td}[BooleanJSFile]{td}{td}[#copyFolder#convertToJSFile]\(sourceFolder, destinationFolder)
Copies the sourcefolder to the destination folder, recursivelyfile)
Returns a JSFile instance corresponding to an alternative representation of a file (for example a string).{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#createFile#convertToRemoteJSFile]\(targetFile)
Creates a JSFile instance.serverPath)
Returns the JSFile object of a server file, given its path (relative the default server location){td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#createFolder#copyFile]\(targetFolder)
Creates a folder on disksourceFile, destinationFile)
Copies the sourcefile to the destination file.{td}{tr}{tbody}{tbody}{tr}{td}[JSFileBoolean]{td}{td}[#createTempFile#copyFolder]\(filePrefixsourceFolder, fileSuffixdestinationFolder)
Copies the Createssourcefolder ato temporarythe filedestination onfolder, diskrecursively.{td}{tr}{tbody}{tbody}{tr}{td}[BooleanJSFile]{td}{td}[#deleteFile#createFile]\(targetFile)
RemovesCreates a fileJSFile from diskinstance.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#deleteFolder#createFolder]\(targetFolder, showWarning)
)
Creates a folder on disk.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#createTempFile]\(filePrefix, fileSuffix)
Creates a temporary file on disk.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#deleteFile]\(targetFile)
Removes a file from disk.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#deleteFolder]\(targetFolder, showWarning)
Deletes a folder from disk recursively.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#getDesktopFolder]\()
Returns a JSFile instance that corresponds to the Desktop folder of the currently logged in user.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]\[]{td}{td}[#getDiskList]\()
Returns an Array of JSFile instances correponding to the file system root folders.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getFileSize]\(targetFile)
Returns the size of the specified file.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]\[]{td}{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.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#getHomeDirectory]\()
Returns a JSFile instance corresponding to the home folder of the logged in used.{td}{tr}{tbody}{tbody}{tr}{td}[Date]{td}{td}[#getModificationDate]\(targetFile)
Returns the modification date of a file.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]\[]{td}{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){td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#moveFile]\(sourceFile, destinationFile)
Moves the file from the source to the destination place.{td}{tr}{tbody}{tbody}{tr}{td}byte[]{td}{td}[#readFile]\(\[file], \[size])
Reads all or part of the content from a binary file.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#readTXTFile]\(\[file], \[charsetname])
Read all content from a text file.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#showDirectorySelectDialog]\(\[directory suggestion], \[dialog title text])
Shows a directory selector dialog.{td}{tr}{tbody}{tbody}{tr}{td}[Object]{td}{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.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#showFileSaveDialog]\(\[fileName/dir suggestion], \[dialog title text])
Shows a file save dialog.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]void{td}{td}[#writeFile#streamFilesFromServer]\(file, binary_data)
Writes data into a binary 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.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]void{td}{td}[#writeTXTFile#streamFilesToServer]\(file, text_data, charsetname)
Writes data into a text 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).{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#writeXMLFile#writeFile]\(file, xmlbinary_data, \[mimeType])
Writes data into a binary file.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#writeTXTFile]\(file, text_data, \[charsetname], \[mimeType])
Writes data into a text file.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#writeXMLFile]\(file, xml_data)
Writes data into an XML file.{td}{tr}{tbody}{table}\\ 

{table:id=serverProperty|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}MethodServer Property Details{th}{tr}{tbody:id=DCD3BC00-15AD-423D-ADE4-A880FFDB72F1=servoy.FileServerService.defaultFolder|class=node}{tr:id=name}{td}h6.convertToJSFileservoy.FileServerService.defaultFolder{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}convertToJSFile{span}{span:id=iets|style=float: left;}\(file){span}{td}{tr}{tr:id=des}{td}{sub-section:DCD3BC00-15AD-423D-ADE4-A880FFDB72F1des}{td}{sub-section:servoy.FileServerService.defaultFolder_des|text=|trigger=button}{sub-section}{sub-section:DCD3BC00-15AD-423D-ADE4-A880FFDB72F1servoy.FileServerService.defaultFolder_des|trigger=none|class=sIndent}ReturnsSet athe JSFiledefault instancefolder correspondingpath to ansave alternativefiles representationsent ofby aclient file (forwill exampledefault ato string/uploads/).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:DCD3BC00-15AD-423D-ADE4-A880FFDB72F1_prsservoy.FileServerService.defaultFolder_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DCD3BC00-15AD-423D-ADE4-A880FFDB72F1_prsservoy.FileServerService.defaultFolder_snc|trigger=none}file
|class=sIndent} Replace with version info{sub-section}{divtd}{tr}{tdbuilder-show}{trbuilder-show:permission=edit}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:DCD3BC00-15AD-423D-ADE4-A880FFDB72F1_retservoy.FileServerService.defaultFolder_prs|text=|trigger=button}{sub-section}{sub-section:DCD3BC00-15AD-423D-ADE4-A880FFDB72F1_retservoy.FileServerService.defaultFolder_prs|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:DCD3BC00-15AD-423D-ADE4-A880FFDB72F1_seeservoy.FileServerService.defaultFolder_ret|text=|trigger=button}{sub-section}{sub-section:DCD3BC00-15AD-423D-ADE4-A880FFDB72F1_seeservoy.FileServerService.defaultFolder_ret|trigger=none|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:DCD3BC00-15AD-423D-ADE4-A880FFDB72F1servoy.FileServerService.defaultFolder_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DCD3BC00-15AD-423D-ADE4-A880FFDB72F1_link|class=sIndent|servoy.FileServerService.defaultFolder_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:DCD3BC00-15AD-423D-ADE4-A880FFDB72F1_samservoy.FileServerService.defaultFolder_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DCD3BC00-15AD-423D-ADE4-A880FFDB72F1_sam|class=sIndent|trigger=none}{code:language=javascript}
var f = plugins.file.convertToJSFile("story.txt");
if (f.canRead())
	application.output("File can be read.");
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{tdservoy.FileServerService.defaultFolder_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:servoy.FileServerService.defaultFolder_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:servoy.FileServerService.defaultFolder_sam|trigger=none}{sub-section}{div}{td}{tr}{tbody}{tbody:id=621134E9-532C-4DCC-B67C-74767680F449builder-show}{tr:idclass=namelastDetailRow}{td}h6.copyFile{td}{tr}{tr:id=sigtbody}{tdtable}\\ 

{spantable:style=id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=appendToTXTFile|class=node}{tr:id=name}{td}h6.appendToTXTFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}copyFileappendToTXTFile{span}{span:id=iets|style=float: left;}\(sourceFilefile/fileName, text, destinationFile\[encoding]){span}{td}{tr}{tr:id=des}{td}{sub-section:621134E9-532C-4DCC-B67C-74767680F449appendToTXTFile_des|text=|trigger=button}{sub-section}{sub-section:621134E9-532C-4DCC-B67C-74767680F449appendToTXTFile_des|trigger=none|class=sIndent}CopiesAppends thedata sourcefileinto toa thetext destination file. Returns true if the copy succeeds, false if any error occurs.{sub-file.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:621134E9-532C-4DCC-B67C-74767680F449_prsappendToTXTFile_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:621134E9-532C-4DCC-B67C-74767680F449_prsappendToTXTFile_snc|trigger=none}sourceFile
destinationFile
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:621134E9-532C-4DCC-B67C-74767680F449_retappendToTXTFile_prs|text=|trigger=button}{sub-section}{sub-section:621134E9-532C-4DCC-B67C-74767680F449_retappendToTXTFile_prs|trigger=none|class=sIndent}[Boolean]file/fileName
text
\[encoding]
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:621134E9-532C-4DCC-B67C-74767680F449_seeappendToTXTFile_ret|text=|trigger=button}{sub-section}{sub-section:621134E9-532C-4DCC-B67C-74767680F449_see|class=sIndentappendToTXTFile_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:appendToTXTFile_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:appendToTXTFile_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:621134E9-532C-4DCC-B67C-74767680F449_seeappendToTXTFile_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:621134E9-532C-4DCC-B67C-74767680F449appendToTXTFile_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:621134E9-532C-4DCC-B67C-74767680F449appendToTXTFile_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:621134E9-532C-4DCC-B67C-74767680F449appendToTXTFile_sam|class=sIndent|trigger=none}{code:language=javascript}
// Copyappend basedsome ontext fileto names.a iftext (!plugins.file.copyFile("story.txt", "story.txt.copy"))
	application.output("Copy failed.");
// Copy based on JSFile instances.
var ffile:
	var ok = plugins.file.createFileappendToTXTFile("story'myTextFile.txt");
var fcopy = plugins.file.createFile("story.txt.copy2");
if (!plugins.file.copyFile(f, fcopy))
	application.output("Copy failed."', '\nMy fantastic new line of text\n');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=C05E28FA-23C3-4D7E-8F94-AEAE44DBF082}convertToJSFile|class=node}{tr:id=name}{td}h6.copyFolderconvertToJSFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[BooleanJSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}copyFolderconvertToJSFile{span}{span:id=iets|style=float: left;}\(sourceFolder, destinationFolderfile){span}{td}{tr}{tr:id=des}{td}{sub-section:C05E28FA-23C3-4D7E-8F94-AEAE44DBF082convertToJSFile_des|text=|trigger=button}{sub-section}{sub-section:C05E28FA-23C3-4D7E-8F94-AEAE44DBF082convertToJSFile_des|trigger=none|class=sIndent}CopiesReturns thea sourcefolderJSFile toinstance thecorresponding destinationto folder,an recursively.alternative Returnsrepresentation trueof ifa thefile copy(for succeeds,example false if any error occursa string).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:C05E28FA-23C3-4D7E-8F94-AEAE44DBF082_prsconvertToJSFile_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C05E28FA-23C3-4D7E-8F94-AEAE44DBF082_prsconvertToJSFile_snc|trigger=none}sourceFolder
destinationFolder
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:C05E28FA-23C3-4D7E-8F94-AEAE44DBF082convertToJSFile_prs|text=|trigger=button}{sub-section}{sub-section:convertToJSFile_prs|trigger=none|class=sIndent}file
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:convertToJSFile_ret|text=|trigger=button}{sub-section}{sub-section:C05E28FA-23C3-4D7E-8F94-AEAE44DBF082convertToJSFile_ret|trigger=none|class=sIndent}[BooleanJSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C05E28FA-23C3-4D7E-8F94-AEAE44DBF082convertToJSFile_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C05E28FA-23C3-4D7E-8F94-AEAE44DBF082convertToJSFile_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C05E28FA-23C3-4D7E-8F94-AEAE44DBF082_seeconvertToJSFile_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C05E28FA-23C3-4D7E-8F94-AEAE44DBF082convertToJSFile_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C05E28FA-23C3-4D7E-8F94-AEAE44DBF082_samconvertToJSFile_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C05E28FA-23C3-4D7E-8F94-AEAE44DBF082convertToJSFile_sam|class=sIndent|trigger=none}{code: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 df = plugins.file.createFileconvertToJSFile("stories");
var dcopy = plugins.file.createFile("stories_copy_2"story.txt");
if (!plugins.file.copyFolder(d, dcopyf.canRead())
	application.output("FolderFile can copybe failedread.");
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=92E77024-CC2C-4DD0-9F95-4D571A7C97F5convertToRemoteJSFile|class=node}{tr:id=name}{td}h6.createFileconvertToRemoteJSFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}createFileconvertToRemoteJSFile{span}{span:id=iets|style=float: left;}\(targetFileserverPath){span}{td}{tr}{tr:id=des}{td}{sub-section:92E77024-CC2C-4DD0-9F95-4D571A7C97F5convertToRemoteJSFile_des|text=|trigger=button}{sub-section}{sub-section:92E77024-CC2C-4DD0-9F95-4D571A7C97F5convertToRemoteJSFile_des|trigger=none|class=sIndent}CreatesReturns the JSFile object of a JSFile instance. Does not createserver file, given its path (relative the filedefault onserver disk.location){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:92E77024-CC2C-4DD0-9F95-4D571A7C97F5_prsconvertToRemoteJSFile_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:92E77024-CC2C-4DD0-9F95-4D571A7C97F5_prsconvertToRemoteJSFile_snc|trigger=none}targetFile
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:92E77024-CC2C-4DD0-9F95-4D571A7C97F5_retconvertToRemoteJSFile_prs|text=|trigger=button}{sub-section}{sub-section:92E77024-CC2C-4DD0-9F95-4D571A7C97F5convertToRemoteJSFile_prs|trigger=none|class=sIndent}serverPath
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:convertToRemoteJSFile_ret|text=|trigger=button}{sub-section}{sub-section:convertToRemoteJSFile_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:92E77024-CC2C-4DD0-9F95-4D571A7C97F5convertToRemoteJSFile_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:92E77024-CC2C-4DD0-9F95-4D571A7C97F5convertToRemoteJSFile_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:92E77024-CC2C-4DD0-9F95-4D571A7C97F5_seeconvertToRemoteJSFile_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:92E77024-CC2C-4DD0-9F95-4D571A7C97F5convertToRemoteJSFile_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:92E77024-CC2C-4DD0-9F95-4D571A7C97F5convertToRemoteJSFile_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:92E77024-CC2C-4DD0-9F95-4D571A7C97F5convertToRemoteJSFile_sam|class=sIndent|trigger=none}{code:language=javascript}
// Create the JSFile instance
based on the file name.
var f = plugins.file.createFile("newfileconvertToRemoteJSFile('/story.txt"');
//if Create the file on disk.
if (!f.createNewFile(f && f.canRead())
	application.output("The file could not'File can be createdread."');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=2B131F75-7D26-49C9-8654-468089DC9776copyFile|class=node}{tr:id=name}{td}h6.createFoldercopyFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}createFoldercopyFile{span}{span:id=iets|style=float: left;}\(targetFoldersourceFile, destinationFile){span}{td}{tr}{tr:id=des}{td}{sub-section:2B131F75-7D26-49C9-8654-468089DC9776copyFile_des|text=|trigger=button}{sub-section}{sub-section:2B131F75-7D26-49C9-8654-468089DC9776copyFile_des|trigger=none|class=sIndent}Creates a folder on diskCopies the sourcefile to the destination file. Returns true if the folder is successfully createdcopy succeeds, false if any error occurs.{sub-section}{td}{tr}{trbuilder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:2B131F75-7D26-49C9-8654-468089DC9776_prscopyFile_snc|text=|trigger=button}{sub-section}{div:sub-section:copyFile_snc|trigger=none|class=sIndent} Replace with version info{sub-section:2B131F75-7D26-49C9-8654-468089DC9776}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:copyFile_prs|text=|trigger=button}{sub-section}{sub-section:copyFile_prs|trigger=none}targetFolder|class=sIndent}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:2B131F75-7D26-49C9-8654-468089DC9776copyFile_ret|text=|trigger=button}{sub-section}{sub-section:2B131F75-7D26-49C9-8654-468089DC9776copyFile_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:2B131F75-7D26-49C9-8654-468089DC9776copyFile_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2B131F75-7D26-49C9-8654-468089DC9776_copyFile_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2B131F75-7D26-49C9-8654-468089DC9776_seecopyFile_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2B131F75-7D26-49C9-8654-468089DC9776copyFile_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2B131F75-7D26-49C9-8654-468089DC9776copyFile_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2B131F75-7D26-49C9-8654-468089DC9776copyFile_sam|class=sIndent|trigger=none}{code:language=javascript}
var d = plugins.file.convertToJSFile("newfolder");// Copy based on file names.
if (!plugins.file.createFolder(dcopyFile("story.txt", "story.txt.copy"))
	application.output("Folder could not be createdCopy failed.");
{code}{sub-section}{td}{
// 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.");
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=14068D80-3482-476E-A5A8-A708FCA496EFcopyFolder|class=node}{tr:id=name}{td}h6.createTempFilecopyFolder{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFileBoolean]{span}{span:id=iets|style=float: left; font-weight: bold;}createTempFilecopyFolder{span}{span:id=iets|style=float: left;}\(filePrefixsourceFolder, fileSuffixdestinationFolder){span}{td}{tr}{tr:id=des}{td}{sub-section:14068D80-3482-476E-A5A8-A708FCA496EFcopyFolder_des|text=|trigger=button}{sub-section}{sub-section:14068D80-3482-476E-A5A8-A708FCA496EFcopyFolder_des|trigger=none|class=sIndent}Creates a temporary file on disk. A prefix and an extension are specified and they will be part of the file nameCopies the sourcefolder to the destination folder, recursively. Returns true if the copy succeeds, false if any error occurs.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:14068D80-3482-476E-A5A8-A708FCA496EF_prscopyFolder_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:14068D80-3482-476E-A5A8-A708FCA496EF_prscopyFolder_snc|trigger=none}filePrefix
fileSuffix
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:14068D80-3482-476E-A5A8-A708FCA496EF_retcopyFolder_prs|text=|trigger=button}{sub-section}{sub-section:14068D80-3482-476E-A5A8-A708FCA496EF_retcopyFolder_prs|trigger=none|class=sIndent}[JSFile]sourceFolder
destinationFolder
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:14068D80-3482-476E-A5A8-A708FCA496EF_see|copyFolder_ret|text=|trigger=button}{sub-section}{sub-section:14068D80-3482-476E-A5A8-A708FCA496EF_see|class=sIndentcopyFolder_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:copyFolder_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:copyFolder_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:14068D80-3482-476E-A5A8-A708FCA496EF_seecopyFolder_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:14068D80-3482-476E-A5A8-A708FCA496EFcopyFolder_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:14068D80-3482-476E-A5A8-A708FCA496EFcopyFolder_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:14068D80-3482-476E-A5A8-A708FCA496EFcopyFolder_sam|class=sIndent|trigger=none}{code:language=javascript}
var tempFile = 
// Copy folder based on names.
if (!plugins.file.createTempFile('myfile','.txt');
application.output('Temporary file created as: ' + tempFile.getAbsolutePath());
plugins.file.writeTXTFile(tempFile, 'abcdefg'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.");
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=BA4D2870-37A9-4B11-B6B9-B78269328F0DcreateFile|class=node}{tr:id=name}{td}h6.deleteFilecreateFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[BooleanJSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}deleteFilecreateFile{span}{span:id=iets|style=float: left;}\(targetFile){span}{td}{tr}{tr:id=des}{td}{sub-section:BA4D2870-37A9-4B11-B6B9-B78269328F0DcreateFile_des|text=|trigger=button}{sub-section}{sub-section:BA4D2870-37A9-4B11-B6B9-B78269328F0DcreateFile_des|trigger=none|class=sIndent}RemovesCreates a fileJSFile frominstance. disk.Does Returnsnot truecreate onthe success,file falseon otherwisedisk.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:BA4D2870-37A9-4B11-B6B9-B78269328F0D_prscreateFile_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BA4D2870-37A9-4B11-B6B9-B78269328F0D_prscreateFile_snc|trigger=none}targetFile
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:BA4D2870-37A9-4B11-B6B9-B78269328F0D_retcreateFile_prs|text=|trigger=button}{sub-section}{sub-section:BA4D2870-37A9-4B11-B6B9-B78269328F0D_retcreateFile_prs|trigger=none|class=sIndent}[BooleantargetFile
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:createFile_ret|text=|trigger=button}{sub-section}{sub-section:createFile_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BA4D2870-37A9-4B11-B6B9-B78269328F0DcreateFile_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BA4D2870-37A9-4B11-B6B9-B78269328F0DcreateFile_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BA4D2870-37A9-4B11-B6B9-B78269328F0D_seecreateFile_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BA4D2870-37A9-4B11-B6B9-B78269328F0DcreateFile_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BA4D2870-37A9-4B11-B6B9-B78269328F0DcreateFile_sam|text=|trigger=button}{sub-section}{sub-section:BA4D2870-37A9-4B11-B6B9-B78269328F0D_sam|class=sIndentdiv:class=sIndent}{sub-section:createFile_sam|trigger=none}{code:language=javascript}
if (
// Create the JSFile instance based on the file name.
var f = plugins.file.deleteFilecreateFile('story.txt'"newfile.txt");
// Create the file on disk.
if (!f.createNewFile())
	application.output('File deleted.'"The file could not be created.");
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=EAEC4528-CFE6-468F-BC56-F0F843A7E308createFolder|class=node}{tr:id=name}{td}h6.deleteFoldercreateFolder{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}deleteFoldercreateFolder{span}{span:id=iets|style=float: left;}\(targetFolder, showWarning){span}{td}{tr}{tr:id=des}{td}{sub-section:EAEC4528-CFE6-468F-BC56-F0F843A7E308createFolder_des|text=|trigger=button}{sub-section}{sub-section:EAEC4528-CFE6-468F-BC56-F0F843A7E308createFolder_des|trigger=none|class=sIndent}DeletesCreates a folder fromon disk recursively. Returns true onif success, false otherwise. If the second parameter is set to true, then a warning will be issued to the user before actually removing the folderthe folder is successfully created, false if any error occurs.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:EAEC4528-CFE6-468F-BC56-F0F843A7E308_prscreateFolder_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EAEC4528-CFE6-468F-BC56-F0F843A7E308_prscreateFolder_snc|trigger=none}targetFolder
showWarning
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:EAEC4528-CFE6-468F-BC56-F0F843A7E308_retcreateFolder_prs|text=|trigger=button}{sub-section}{sub-section:EAEC4528-CFE6-468F-BC56-F0F843A7E308_retcreateFolder_prs|trigger=none|class=sIndent}[Boolean]targetFolder
{sub-section}{td}{tr}{builder-showtr:permission=id=ret}{td}*Returns*\\{sub-section:createFolder_ret|text=|trigger=button}{sub-section}{sub-section:createFolder_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:EAEC4528-CFE6-468F-BC56-F0F843A7E308createFolder_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EAEC4528-CFE6-468F-BC56-F0F843A7E308createFolder_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:EAEC4528-CFE6-468F-BC56-F0F843A7E308_seecreateFolder_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EAEC4528-CFE6-468F-BC56-F0F843A7E308createFolder_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:EAEC4528-CFE6-468F-BC56-F0F843A7E308createFolder_sam|text=|trigger=button}{sub-section}{subdiv:class=sIndent}{sub-section:EAEC4528-CFE6-468F-BC56-F0F843A7E308createFolder_sam|class=sIndent|trigger=none}{code:language=javascript}
var d = plugins.file.convertToJSFile("newfolder");
if (!plugins.file.deleteFolder('stories', truecreateFolder(d))
	application.output('"Folder deleted.'could not be created.");
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=8F245643-66DF-4CD3-9A92-AEDFB850CC61createTempFile|class=node}{tr:id=name}{td}h6.getDesktopFoldercreateTempFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}getDesktopFoldercreateTempFile{span}{span:id=iets|style=float: left;}\(filePrefix, fileSuffix){span}{td}{tr}{tr:id=des}{td}{sub-section:8F245643-66DF-4CD3-9A92-AEDFB850CC61createTempFile_des|text=|trigger=button}{sub-section}{sub-section:8F245643-66DF-4CD3-9A92-AEDFB850CC61createTempFile_des|trigger=none|class=sIndent}ReturnsCreates a JSFile instance that corresponds to the Desktop folder temporary file on disk. A prefix and an extension are specified and they will be part of the currently logged in userfile name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:8F245643-66DF-4CD3-9A92-AEDFB850CC61_prscreateTempFile_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8F245643-66DF-4CD3-9A92-AEDFB850CC61_prscreateTempFile_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{div}{td}{tr}{builder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:8F245643-66DF-4CD3-9A92-AEDFB850CC61_retcreateTempFile_prs|text=|trigger=button}{sub-section}{sub-section:8F245643-66DF-4CD3-9A92-AEDFB850CC61_retcreateTempFile_prs|trigger=none|class=sIndent}[JSFile]filePrefix
fileSuffix
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:8F245643-66DF-4CD3-9A92-AEDFB850CC61_seecreateTempFile_ret|text=|trigger=button}{sub-section}{sub-section:8F245643-66DF-4CD3-9A92-AEDFB850CC61_seecreateTempFile_ret|trigger=none|class=sIndent|trigger=none}}[JSFile]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:8F245643-66DF-4CD3-9A92-AEDFB850CC61createTempFile_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8F245643-66DF-4CD3-9A92-AEDFB850CC61_link|class=sIndentcreateTempFile_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:createTempFile_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createTempFile_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:8F245643-66DF-4CD3-9A92-AEDFB850CC61createTempFile_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8F245643-66DF-4CD3-9A92-AEDFB850CC61createTempFile_sam|class=sIndent|trigger=none}{code:language=javascript}
var dtempFile = plugins.file.getDesktopFolder(createTempFile('myfile','.txt');
application.output('desktopTemporary file foldercreated isas: ' + dtempFile.getAbsolutePath());
{codeplugins.file.writeTXTFile(tempFile, 'abcdefg');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=DAD2BB17-315E-4740-B877-90C291FEBB80=deleteFile|class=node}{tr:id=name}{td}h6.getDiskListdeleteFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]\[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}getDiskListdeleteFile{span}{span:id=iets|style=float: left;}\(targetFile){span}{td}{tr}{tr:id=des}{td}{sub-section:DAD2BB17-315E-4740-B877-90C291FEBB80deleteFile_des|text=|trigger=button}{sub-section}{sub-section:DAD2BB17-315E-4740-B877-90C291FEBB80deleteFile_des|trigger=none|class=sIndent}ReturnsRemoves ana Arrayfile offrom JSFiledisk. instancesReturns correpondingtrue toon thesuccess, file system root foldersfalse otherwise.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:DAD2BB17-315E-4740-B877-90C291FEBB80_prsdeleteFile_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DAD2BB17-315E-4740-B877-90C291FEBB80_prsdeleteFile_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{div}{td}{tr}{builder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:DAD2BB17-315E-4740-B877-90C291FEBB80deleteFile_prs|text=|trigger=button}{sub-section}{sub-section:deleteFile_prs|trigger=none|class=sIndent}targetFile
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:deleteFile_ret|text=|trigger=button}{sub-section}{sub-section:DAD2BB17-315E-4740-B877-90C291FEBB80deleteFile_ret|trigger=none|class=sIndent}[JSFile]\[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:DAD2BB17-315E-4740-B877-90C291FEBB80deleteFile_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DAD2BB17-315E-4740-B877-90C291FEBB80deleteFile_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DAD2BB17-315E-4740-B877-90C291FEBB80_seedeleteFile_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DAD2BB17-315E-4740-B877-90C291FEBB80deleteFile_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DAD2BB17-315E-4740-B877-90C291FEBB80_deleteFile_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DAD2BB17-315E-4740-B877-90C291FEBB80deleteFile_sam|class=sIndent|trigger=none}{code:language=javascript}
var roots = if (plugins.file.getDiskListdeleteFile();
for (var i = 0; i < roots.length; i++'story.txt'))
	application.output(roots[i].getAbsolutePath()'File deleted.');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=390CB14F-2DAB-4148-A7BB-9DDBA2CD111FdeleteFolder|class=node}{tr:id=name}{td}h6.getFileSizedeleteFolder{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[NumberBoolean]{span}{span:id=iets|style=float: left; font-weight: bold;}getFileSizedeleteFolder{span}{span:id=iets|style=float: left;}\(targetFiletargetFolder, showWarning){span}{td}{tr}{tr:id=des}{td}{sub-section:390CB14F-2DAB-4148-A7BB-9DDBA2CD111FdeleteFolder_des|text=|trigger=button}{sub-section}{sub-section:390CB14F-2DAB-4148-A7BB-9DDBA2CD111FdeleteFolder_des|trigger=none|class=sIndent}Returns the size of the specified file.{subDeletes 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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:390CB14F-2DAB-4148-A7BB-9DDBA2CD111F_prsdeleteFolder_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:390CB14F-2DAB-4148-A7BB-9DDBA2CD111F_prsdeleteFolder_snc|trigger=none}targetFile
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:390CB14F-2DAB-4148-A7BB-9DDBA2CD111F_retdeleteFolder_prs|text=|trigger=button}{sub-section}{sub-section:390CB14F-2DAB-4148-A7BB-9DDBA2CD111F_retdeleteFolder_prs|trigger=none|class=sIndent}[NumbertargetFolder
showWarning
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:deleteFolder_ret|text=|trigger=button}{sub-section}{sub-section:deleteFolder_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:390CB14F-2DAB-4148-A7BB-9DDBA2CD111FdeleteFolder_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:390CB14F-2DAB-4148-A7BB-9DDBA2CD111FdeleteFolder_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:390CB14F-2DAB-4148-A7BB-9DDBA2CD111F_seedeleteFolder_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:390CB14F-2DAB-4148-A7BB-9DDBA2CD111FdeleteFolder_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:390CB14F-2DAB-4148-A7BB-9DDBA2CD111FdeleteFolder_sam|text=|trigger=button}{sub-section}{sub-section:390CB14F-2DAB-4148-A7BB-9DDBA2CD111F_sam|class=sIndentdiv:class=sIndent}{sub-section:deleteFolder_sam|trigger=none}{code:language=javascript}
var f = if (plugins.file.convertToJSFiledeleteFolder('story.txt');
stories', true))
	application.output('file size: ' + plugins.file.getFileSize(f)Folder deleted.');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=0C908C1E-84B3-4399-9A5F-7C4B5A2DA969=getDesktopFolder|class=node}{tr:id=name}{td}h6.getFolderContentsgetDesktopFolder{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getFolderContentsgetDesktopFolder{span}{span:id=iets|style=float: left;}\(targetFolder, fileFilter, fileOption(1=files,2=dirs), visibleOption(1=visible,2=nonvisible), lockedOption(1=locked,2=nonlocked)){span}{td}{tr}{tr:id=des}{td}{sub-section:0C908C1E-84B3-4399-9A5F-7C4B5A2DA969getDesktopFolder_des|text=|trigger=button}{sub-section}{sub-section:0C908C1E-84B3-4399-9A5F-7C4B5A2DA969getDesktopFolder_des|trigger=none|class=sIndent}Returns ana arrayJSFile ofinstance JSFilethat instancescorresponds corresponding to content of the specifiedDesktop folder. Theof contentthe cancurrently belogged filtered by optional name filter(s), by type, by visibility and by lock statusin user.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:0C908C1E-84B3-4399-9A5F-7C4B5A2DA969_prsgetDesktopFolder_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0C908C1E-84B3-4399-9A5F-7C4B5A2DA969_prsgetDesktopFolder_snc|trigger=none|class=sIndent}targetFolder \[fileFilter\]
\[fileOption(1=files,2=dirs)\]
\[visibleOption(1=visible,2=nonvisible)\]
\[lockedOption(1=locked,2=nonlocked)\]
Replace with version info{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:0C908C1E-84B3-4399-9A5F-7C4B5A2DA969_retgetDesktopFolder_prs|text=|trigger=button}{sub-section}{sub-section:0C908C1E-84B3-4399-9A5F-7C4B5A2DA969_retgetDesktopFolder_prs|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:0C908C1E-84B3-4399-9A5F-7C4B5A2DA969_seegetDesktopFolder_ret|text=|trigger=button}{sub-section}{sub-section:0C908C1E-84B3-4399-9A5F-7C4B5A2DA969_seegetDesktopFolder_ret|trigger=none|class=sIndent|trigger=none}}[JSFile]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:0C908C1E-84B3-4399-9A5F-7C4B5A2DA969getDesktopFolder_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0C908C1E-84B3-4399-9A5F-7C4B5A2DA969_link|class=sIndentgetDesktopFolder_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:0C908C1E-84B3-4399-9A5F-7C4B5A2DA969_samgetDesktopFolder_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0C908C1E-84B3-4399-9A5F-7C4B5A2DA969_sam|class=sIndentgetDesktopFolder_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getDesktopFolder_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getDesktopFolder_sam|trigger=none}{code:language=javascript}
var filesd = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i]getDesktopFolder();
application.output('desktop folder is: ' + d.getAbsolutePath());
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=D31B88E9-5EDB-49B2-B9DF-7759BE0DD464getDiskList|class=node}{tr:id=name}{td}h6.getHomeDirectorygetDiskList{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getHomeDirectorygetDiskList{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:D31B88E9-5EDB-49B2-B9DF-7759BE0DD464getDiskList_des|text=|trigger=button}{sub-section}{sub-section:D31B88E9-5EDB-49B2-B9DF-7759BE0DD464getDiskList_des|trigger=none|class=sIndent}Returns an Array aof JSFile instanceinstances correspondingcorreponding to the homefile foldersystem of the logged in usedroot folders.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:D31B88E9-5EDB-49B2-B9DF-7759BE0DD464_prsgetDiskList_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D31B88E9-5EDB-49B2-B9DF-7759BE0DD464_prsgetDiskList_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{builder-show:permission=edit}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:D31B88E9-5EDB-49B2-B9DF-7759BE0DD464_retgetDiskList_prs|text=|trigger=button}{sub-section}{sub-section:D31B88E9-5EDB-49B2-B9DF-7759BE0DD464_retgetDiskList_prs|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getDiskList_ret|text=|trigger=button}{sub-section}{sub-section:getDiskList_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D31B88E9-5EDB-49B2-B9DF-7759BE0DD464getDiskList_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D31B88E9-5EDB-49B2-B9DF-7759BE0DD464getDiskList_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D31B88E9-5EDB-49B2-B9DF-7759BE0DD464_seegetDiskList_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D31B88E9-5EDB-49B2-B9DF-7759BE0DD464getDiskList_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D31B88E9-5EDB-49B2-B9DF-7759BE0DD464getDiskList_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D31B88E9-5EDB-49B2-B9DF-7759BE0DD464getDiskList_sam|class=sIndent|trigger=none}{code:language=javascript}
var droots = plugins.file.getHomeDirectorygetDiskList();
application.output('home folder: ' + dfor (var i = 0; i < roots.length; i++)
	application.output(roots[i].getAbsolutePath());
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=87032485-9B32-4A14-831E-E1DF2D0A9CE1getFileSize|class=node}{tr:id=name}{td}h6.getModificationDategetFileSize{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[DateNumber]{span}{span:id=iets|style=float: left; font-weight: bold;}getModificationDategetFileSize{span}{span:id=iets|style=float: left;}\(targetFile){span}{td}{tr}{tr:id=des}{td}{sub-section:87032485-9B32-4A14-831E-E1DF2D0A9CE1getFileSize_des|text=|trigger=button}{sub-section}{sub-section:87032485-9B32-4A14-831E-E1DF2D0A9CE1getFileSize_des|trigger=none|class=sIndent}Returns the modificationsize dateof ofthe aspecified file.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:87032485-9B32-4A14-831E-E1DF2D0A9CE1_prsgetFileSize_snc|text=|trigger=button}{sub-section}{div:sub-section:getFileSize_snc|trigger=none|class=sIndent} Replace with version info{sub-section:87032485-9B32-4A14-831E-E1DF2D0A9CE1}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:getFileSize_prs|text=|trigger=button}{sub-section}{sub-section:getFileSize_prs|trigger=none|class=sIndent}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:87032485-9B32-4A14-831E-E1DF2D0A9CE1getFileSize_ret|text=|trigger=button}{sub-section}{sub-section:87032485-9B32-4A14-831E-E1DF2D0A9CE1getFileSize_ret|trigger=none|class=sIndent}[DateNumber]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:87032485-9B32-4A14-831E-E1DF2D0A9CE1getFileSize_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:87032485-9B32-4A14-831E-E1DF2D0A9CE1getFileSize_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:87032485-9B32-4A14-831E-E1DF2D0A9CE1_seegetFileSize_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:87032485-9B32-4A14-831E-E1DF2D0A9CE1_link|class=sIndent|getFileSize_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:87032485-9B32-4A14-831E-E1DF2D0A9CE1getFileSize_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:87032485-9B32-4A14-831E-E1DF2D0A9CE1getFileSize_sam|class=sIndent|trigger=none}{code:language=javascript}
var f = plugins.file.convertToJSFile('story.txt');
application.output('lastfile changedsize: ' + plugins.file.getModificationDategetFileSize(f));
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=0D46B6AE-D657-4B22-B8E1-3883D4248F55=getFolderContents|class=node}{tr:id=name}{td}h6.moveFilegetFolderContents{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]\[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}moveFilegetFolderContents{span}{span:id=iets|style=float: left;}\(targetFolder, \[fileFilter], \[fileOption(1=files,2=dirs)], \(sourceFile, destinationFile[visibleOption(1=visible,2=nonvisible)], \[lockedOption(1=locked,2=nonlocked)]){span}{td}{tr}{tr:id=des}{td}{sub-section:0D46B6AE-D657-4B22-B8E1-3883D4248F55getFolderContents_des|text=|trigger=button}{sub-section}{sub-section:0D46B6AE-D657-4B22-B8E1-3883D4248F55getFolderContents_des|trigger=none|class=sIndent}MovesReturns an thearray fileof fromJSFile theinstances sourcecorresponding to content of the destinationspecified placefolder. Returns true on success, false otherwise The content can be filtered by optional name filter(s), by type, by visibility and by lock status.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:0D46B6AE-D657-4B22-B8E1-3883D4248F55_prsgetFolderContents_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0D46B6AE-D657-4B22-B8E1-3883D4248F55_prsgetFolderContents_snc|trigger=none}sourceFile
destinationFile
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:0D46B6AE-D657-4B22-B8E1-3883D4248F55_retgetFolderContents_prs|text=|trigger=button}{sub-section}{sub-section:0D46B6AE-D657-4B22-B8E1-3883D4248F55_retgetFolderContents_prs|trigger=none|class=sIndent}[Boolean]targetFolder
\[fileFilter]
\[fileOption(1=files,2=dirs)]
\[visibleOption(1=visible,2=nonvisible)]
\[lockedOption(1=locked,2=nonlocked)]
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:0D46B6AE-D657-4B22-B8E1-3883D4248F55_seegetFolderContents_ret|text=|trigger=button}{sub-section}{sub-section:0D46B6AE-D657-4B22-B8E1-3883D4248F55_seegetFolderContents_ret|trigger=none|class=sIndent|trigger=none}}[JSFile]\[]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:0D46B6AE-D657-4B22-B8E1-3883D4248F55getFolderContents_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0D46B6AE-D657-4B22-B8E1-3883D4248F55_link|class=sIndent|getFolderContents_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:0D46B6AE-D657-4B22-B8E1-3883D4248F55_samgetFolderContents_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0D46B6AE-D657-4B22-B8E1-3883D4248F55_sam|class=sIndentgetFolderContents_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getFolderContents_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getFolderContents_sam|trigger=none}{code:language=javascript}
//var Move file based on names.
if (!files = plugins.file.moveFilegetFolderContents('story.txtstories', '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));
for (var i=0; i<files.length; i++)
	application.output('File move back failed.'files[i].getAbsolutePath());
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=6DA45605-D2CF-4548-A4D9-FD73CC312191=getHomeDirectory|class=node}{tr:id=name}{td}h6.readFilegetHomeDirectory{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}byte[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}readFilegetHomeDirectory{span}{span:id=iets|style=float: left;}\(file, size){span}{td}{tr}{tr:id=des}{td}{sub-section:6DA45605-D2CF-4548-A4D9-FD73CC312191getHomeDirectory_des|text=|trigger=button}{sub-section}{sub-section:6DA45605-D2CF-4548-A4D9-FD73CC312191getHomeDirectory_des|trigger=none|class=sIndent}ReadsReturns alla orJSFile partinstance ofcorresponding to the contenthome fromfolder aof binarythe file.logged If a file name is not specified, then a file selection dialog pops up for selecting a file. (Web Enabled)in used.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:6DA45605-D2CF-4548-A4D9-FD73CC312191_prsgetHomeDirectory_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6DA45605-D2CF-4548-A4D9-FD73CC312191_prsgetHomeDirectory_snc|trigger=none}\[file\]
\[size\]
|class=sIndent} Replace with version info{sub-section}{divtd}{tr}{tdbuilder-show}{trbuilder-show:permission=edit}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:6DA45605-D2CF-4548-A4D9-FD73CC312191_retgetHomeDirectory_prs|text=|trigger=button}{sub-section}{sub-section:6DA45605-D2CF-4548-A4D9-FD73CC312191getHomeDirectory_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getHomeDirectory_ret|text=|trigger=button}{sub-section}{sub-section:getHomeDirectory_ret|trigger=none|class=sIndent}byte[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:6DA45605-D2CF-4548-A4D9-FD73CC312191getHomeDirectory_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6DA45605-D2CF-4548-A4D9-FD73CC312191getHomeDirectory_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:6DA45605-D2CF-4548-A4D9-FD73CC312191_seegetHomeDirectory_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6DA45605-D2CF-4548-A4D9-FD73CC312191getHomeDirectory_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:6DA45605-D2CF-4548-A4D9-FD73CC312191_sam|getHomeDirectory_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6DA45605-D2CF-4548-A4D9-FD73CC312191getHomeDirectory_sam|class=sIndent|trigger=none}{code:language=javascript}
// Read all content from the file.
var bytesd = plugins.file.readFilegetHomeDirectory('big.jpg');
application.output('filehome sizefolder: ' + bytesd.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);
{code}{sub-section}{td}{tr}{tr:class=lastDetailRowgetAbsolutePath());
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=D140E376-2B9B-4DBD-806B-C4AF051E40EAgetModificationDate|class=node}{tr:id=name}{td}h6.readTXTFilegetModificationDate{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[StringDate]{span}{span:id=iets|style=float: left; font-weight: bold;}readTXTFilegetModificationDate{span}{span:id=iets|style=float: left;}\(file, charsetnametargetFile){span}{td}{tr}{tr:id=des}{td}{sub-section:D140E376-2B9B-4DBD-806B-C4AF051E40EAgetModificationDate_des|text=|trigger=button}{sub-section}{sub-section:D140E376-2B9B-4DBD-806B-C4AF051E40EAgetModificationDate_des|trigger=none|class=sIndent}ReadReturns the allmodification contentdate fromof 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){sub-section}{td}{tr file.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:D140E376-2B9B-4DBD-806B-C4AF051E40EA_prsgetModificationDate_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D140E376-2B9B-4DBD-806B-C4AF051E40EA_prsgetModificationDate_snc|trigger=none}\[file\]
\[charsetname\]
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:D140E376-2B9B-4DBD-806B-C4AF051E40EA_retgetModificationDate_prs|text=|trigger=button}{sub-section}{sub-section:D140E376-2B9B-4DBD-806B-C4AF051E40EAgetModificationDate_prs|trigger=none|class=sIndent}targetFile
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getModificationDate_ret|text=|trigger=button}{sub-section}{sub-section:getModificationDate_ret|trigger=none|class=sIndent}[StringDate]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D140E376-2B9B-4DBD-806B-C4AF051E40EAgetModificationDate_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D140E376-2B9B-4DBD-806B-C4AF051E40EAgetModificationDate_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D140E376-2B9B-4DBD-806B-C4AF051E40EA_seegetModificationDate_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D140E376-2B9B-4DBD-806B-C4AF051E40EAgetModificationDate_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D140E376-2B9B-4DBD-806B-C4AF051E40EAgetModificationDate_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D140E376-2B9B-4DBD-806B-C4AF051E40EAgetModificationDate_sam|class=sIndent|trigger=none}{code:language=javascript}
// Read content from a
known text file.
var txtf = plugins.file.readTXTFileconvertToJSFile('story.txt');
application.output(txt);
// Read content from a text file selected from the file open dialog.
var txtUnknown ='last changed: ' + plugins.file.readTXTFilegetModificationDate(f);
application.output(txtUnknown);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=33BD0338-6EC5-472C-A9E6-7D67BBA9E616getRemoteList|class=node}{tr:id=name}{td}h6.showDirectorySelectDialoggetRemoteList{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}showDirectorySelectDialoggetRemoteList{span}{span:id=iets|style=float: left;}\(directory suggestion, dialog title textserverFolder/serverFolderPath, \[filesOnly]){span}{td}{tr}{tr:id=des}{td}{sub-section:33BD0338-6EC5-472C-A9E6-7D67BBA9E616getRemoteList_des|text=|trigger=button}{sub-section}{sub-section:33BD0338-6EC5-472C-A9E6-7D67BBA9E616getRemoteList_des|trigger=none|class=sIndent}ShowsRetrieves a directorylist selector dialog.of files existing in a folder on the server side (in the path provided, relative to the default server location){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:33BD0338-6EC5-472C-A9E6-7D67BBA9E616_prsgetRemoteList_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:33BD0338-6EC5-472C-A9E6-7D67BBA9E616_prsgetRemoteList_snc|trigger=none}\[directory suggestion\]
\[dialog title text\]
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:33BD0338-6EC5-472C-A9E6-7D67BBA9E616_retgetRemoteList_prs|text=|trigger=button}{sub-section}{sub-section:33BD0338-6EC5-472C-A9E6-7D67BBA9E616_retgetRemoteList_prs|trigger=none|class=sIndent}serverFolder/serverFolderPath
\[JSFilefilesOnly]
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getRemoteList_ret|text=|trigger=button}{sub-section}{sub-section:getRemoteList_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:33BD0338-6EC5-472C-A9E6-7D67BBA9E616getRemoteList_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:33BD0338-6EC5-472C-A9E6-7D67BBA9E616getRemoteList_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:33BD0338-6EC5-472C-A9E6-7D67BBA9E616_seegetRemoteList_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:33BD0338-6EC5-472C-A9E6-7D67BBA9E616getRemoteList_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:33BD0338-6EC5-472C-A9E6-7D67BBA9E616getRemoteList_sam|text=|trigger=button}{sub-section}{subdiv:class=sIndent}{sub-section:33BD0338-6EC5-472C-A9E6-7D67BBA9E616getRemoteList_sam|class=sIndent|trigger=none}{builder-show:permission=edit}{code:language=javascript}
var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder:
"
+ dir.getAbsolutePath());
{code}{builder-show}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=B4416BD9-E281-4444-A73E-8F6E8F5BD055=moveFile|class=node}{tr:id=name}{td}h6.showFileOpenDialogmoveFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}Object[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}showFileOpenDialogmoveFile{span}{span:id=iets|style=float: left;}\(selectionMode(0=both,1=Files,2=Dirs), startDirectory(null=default/previous), multiselect(true/false), filterarray, callbackmethod, dialog title textsourceFile, destinationFile){span}{td}{tr}{tr:id=des}{td}{sub-section:B4416BD9-E281-4444-A73E-8F6E8F5BD055_des|moveFile_des|text=|trigger=button}{sub-section}{sub-section:B4416BD9-E281-4444-A73E-8F6E8F5BD055moveFile_des|trigger=none|class=sIndent}ShowsMoves athe file openfrom dialog.the Filterssource canto bethe applieddestination onplace. whatReturns typetrue ofon filessuccess, canfalse be selected. (Web Enabled)otherwise.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:B4416BD9-E281-4444-A73E-8F6E8F5BD055_prsmoveFile_snc|text=|trigger=button}{sub-section}{div:sub-section:moveFile_snc|trigger=none|class=sIndent} Replace with version info{sub-section:B4416BD9-E281-4444-A73E-8F6E8F5BD055_prs|trigger=none}\[selectionMode(0=both,1=Files,2=Dirs)\]
\[startDirectory(null=default/previous)\]
\[multiselect(true/false)\]
\[filterarray\]
\[callbackmethod\]
\[dialog title text\]
{sub-section}{div}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:moveFile_prs|text=|trigger=button}{sub-section}{sub-section:moveFile_prs|trigger=none|class=sIndent}sourceFile
destinationFile
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:B4416BD9-E281-4444-A73E-8F6E8F5BD055moveFile_ret|text=|trigger=button}{sub-section}{sub-section:B4416BD9-E281-4444-A73E-8F6E8F5BD055moveFile_ret|trigger=none|class=sIndent}Object[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B4416BD9-E281-4444-A73E-8F6E8F5BD055moveFile_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B4416BD9-E281-4444-A73E-8F6E8F5BD055moveFile_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B4416BD9-E281-4444-A73E-8F6E8F5BD055_seemoveFile_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B4416BD9-E281-4444-A73E-8F6E8F5BD055moveFile_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B4416BD9-E281-4444-A73E-8F6E8F5BD055moveFile_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B4416BD9-E281-4444-A73E-8F6E8F5BD055moveFile_sam|class=sIndent|trigger=none}{code:language=javascript}
// Move file Thisbased selectson onlynames.
filesif ('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")').
var file!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.showFileOpenDialog(1, null, false, new Array("JPG and GIF","jpg","gif"));
convertToJSFile('story.txt');
if (!plugins.file.moveFile(f, fmoved))
	application.output("you'veFile selectedmove file: " + file.getAbsolutePath());
//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)
{code}{sub-sectionback failed.');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=readFile|class=node}{tr:id=name}{td}h6.readFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}byte[]{span}{span:id=iets|style=float: left; font-weight: bold;}readFile{span}{span:id=iets|style=float: left;}\(\[file], \[size]){span}{td}{tr}{tr:id=des}{td}{sub-section:readFile_des|text=|trigger=button}{sub-section}{sub-section:readFile_des|trigger=none|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){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:readFile_snc|text=|trigger=button}{sub-section}{sub-section:readFile_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:readFile_prs|text=|trigger=button}{sub-section}{sub-section:readFile_prs|trigger=none|class=sIndent}\[file]
\[size]
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:readFile_ret|text=|trigger=button}{sub-section}{sub-section:readFile_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:readFile_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:readFile_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:readFile_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:readFile_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:readFile_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:readFile_sam|trigger=none}{code: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);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=readTXTFile|class=node}{tr:id=name}{td}h6.readTXTFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}readTXTFile{span}{span:id=iets|style=float: left;}\(\[file], \[charsetname]){span}{td}{tr}{tr:id=des}{td}{sub-section:readTXTFile_des|text=|trigger=button}{sub-section}{sub-section:readTXTFile_des|trigger=none|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){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:readTXTFile_snc|text=|trigger=button}{sub-section}{sub-section:readTXTFile_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:readTXTFile_prs|text=|trigger=button}{sub-section}{sub-section:readTXTFile_prs|trigger=none|class=sIndent}\[file]
\[charsetname]
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:readTXTFile_ret|text=|trigger=button}{sub-section}{sub-section:readTXTFile_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:readTXTFile_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:readTXTFile_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:readTXTFile_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:readTXTFile_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:readTXTFile_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:readTXTFile_sam|trigger=none}{code: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);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showDirectorySelectDialog|class=node}{tr:id=name}{td}h6.showDirectorySelectDialog{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}showDirectorySelectDialog{span}{span:id=iets|style=float: left;}\(\[directory suggestion], \[dialog title text]){span}{td}{tr}{tr:id=des}{td}{sub-section:showDirectorySelectDialog_des|text=|trigger=button}{sub-section}{sub-section:showDirectorySelectDialog_des|trigger=none|class=sIndent}Shows a directory selector dialog.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:showDirectorySelectDialog_snc|text=|trigger=button}{sub-section}{sub-section:showDirectorySelectDialog_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:showDirectorySelectDialog_prs|text=|trigger=button}{sub-section}{sub-section:showDirectorySelectDialog_prs|trigger=none|class=sIndent}\[directory suggestion]
\[dialog title text]
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:showDirectorySelectDialog_ret|text=|trigger=button}{sub-section}{sub-section:showDirectorySelectDialog_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:showDirectorySelectDialog_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:showDirectorySelectDialog_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:showDirectorySelectDialog_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:showDirectorySelectDialog_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:showDirectorySelectDialog_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:showDirectorySelectDialog_sam|trigger=none}{code:language=javascript}
var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath());
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showFileOpenDialog|class=node}{tr:id=name}{td}h6.showFileOpenDialog{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Object]{span}{span:id=iets|style=float: left; font-weight: bold;}showFileOpenDialog{span}{span:id=iets|style=float: left;}\(\[selectionMode(0=both,1=Files,2=Dirs)], \[startDirectory(null=default/previous)], \[multiselect(true/false)], \[filterarray], \[callbackmethod], \[dialog title text]){span}{td}{tr}{tr:id=des}{td}{sub-section:showFileOpenDialog_des|text=|trigger=button}{sub-section}{sub-section:showFileOpenDialog_des|trigger=none|class=sIndent}Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:showFileOpenDialog_snc|text=|trigger=button}{sub-section}{sub-section:showFileOpenDialog_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:showFileOpenDialog_prs|text=|trigger=button}{sub-section}{sub-section:showFileOpenDialog_prs|trigger=none|class=sIndent}\[selectionMode(0=both,1=Files,2=Dirs)]
\[startDirectory(null=default/previous)]
\[multiselect(true/false)]
\[filterarray]
\[callbackmethod]
\[dialog title text]
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:showFileOpenDialog_ret|text=|trigger=button}{sub-section}{sub-section:showFileOpenDialog_ret|trigger=none|class=sIndent}[Object]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:showFileOpenDialog_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:showFileOpenDialog_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:showFileOpenDialog_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:showFileOpenDialog_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:showFileOpenDialog_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:showFileOpenDialog_sam|trigger=none}{code: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")').
var file = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF","jpg","gif"));
application.output("you've selected file: " + file.getAbsolutePath());
//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)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showFileSaveDialog|class=node}{tr:id=name}{td}h6.showFileSaveDialog{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}showFileSaveDialog{span}{span:id=iets|style=float: left;}\(\[fileName/dir suggestion], \[dialog title text]){span}{td}{tr}{tr:id=des}{td}{sub-section:showFileSaveDialog_des|text=|trigger=button}{sub-section}{sub-section:showFileSaveDialog_des|trigger=none|class=sIndent}Shows a file save dialog.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:showFileSaveDialog_snc|text=|trigger=button}{sub-section}{sub-section:showFileSaveDialog_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:showFileSaveDialog_prs|text=|trigger=button}{sub-section}{sub-section:showFileSaveDialog_prs|trigger=none|class=sIndent}\[fileName/dir suggestion]
\[dialog title text]
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:showFileSaveDialog_ret|text=|trigger=button}{sub-section}{sub-section:showFileSaveDialog_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:showFileSaveDialog_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:showFileSaveDialog_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:showFileSaveDialog_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:showFileSaveDialog_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:showFileSaveDialog_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:showFileSaveDialog_sam|trigger=none}{code:language=javascript}
var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath());
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=streamFilesFromServer|class=node}{tr:id=name}{td}h6.streamFilesFromServer{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}streamFilesFromServer{span}{span:id=iets|style=float: left;}\(file/fileName|fileArray/fileNameArray, serverFile/serverFileName|serverFileArray/serverFileNameArray, \[callbackFunction]){span}{td}{tr}{tr:id=des}{td}{sub-section:streamFilesFromServer_des|text=|trigger=button}{sub-section}{sub-section:streamFilesFromServer_des|trigger=none|class=sIndent}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{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:streamFilesFromServer_snc|text=|trigger=button}{sub-section}{sub-section:streamFilesFromServer_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:streamFilesFromServer_prs|text=|trigger=button}{sub-section}{sub-section:streamFilesFromServer_prs|trigger=none|class=sIndent}file/fileName|fileArray/fileNameArray
serverFile/serverFileName|serverFileArray/serverFileNameArray
\[callbackFunction]
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:streamFilesFromServer_ret|text=|trigger=button}{sub-section}{sub-section:streamFilesFromServer_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:streamFilesFromServer_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:streamFilesFromServer_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:streamFilesFromServer_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:streamFilesFromServer_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:streamFilesFromServer_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:streamFilesFromServer_sam|trigger=none}{code:language=javascript}
// transfer the first file of the default server folder to a chosen file on the client
	var dir = plugins.file.getDesktopFolder();
	var file = plugins.file.showFileSaveDialog(dir,'Save file to');
	if (file) {
		var list = plugins.file.getRemoteList('/', true);
		if (list && list.length > 0) {
			plugins.file.streamFilesFromServer(file, list[0], callbackFunction);
		}
	}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=7921CF41-ECC5-4662-936F-8A7A63D4D326streamFilesToServer|class=node}{tr:id=name}{td}h6.showFileSaveDialogstreamFilesToServer{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}streamFilesToServer{span}{span:id=iets|style=float: left;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}showFileSaveDialog{span}{span:id=iets|style=float: left;}\(fileName/dir suggestion, dialog title text){span\(file/fileName|fileArray/fileNameArray, \[serverFile/serverFileName|serverFileArray/serverFileNameArray], \[callbackFunction]){span}{td}{tr}{tr:id=des}{td}{sub-section:streamFilesToServer_des|text=|trigger=button}{sub-section}{sub-section:streamFilesToServer_des|trigger=none|class=sIndent}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{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=dessnc}{td}*Since*\\{sub-section:7921CF41-ECC5-4662-936F-8A7A63D4D326_desstreamFilesToServer_snc|text=|trigger=button}{sub-section}{sub-section:7921CF41-ECC5-4662-936F-8A7A63D4D326_desstreamFilesToServer_snc|trigger=none|class=sIndent}Shows aReplace filewith saveversion dialog.info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:7921CF41-ECC5-4662-936F-8A7A63D4D326streamFilesToServer_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7921CF41-ECC5-4662-936F-8A7A63D4D326streamFilesToServer_prs|trigger=none}\[fileName/dir suggestion\|class=sIndent}file/fileName|fileArray/fileNameArray
\[serverFile/serverFileName|serverFileArray/serverFileNameArray]
\[dialog title text\callbackFunction]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:7921CF41-ECC5-4662-936F-8A7A63D4D326streamFilesToServer_ret|text=|trigger=button}{sub-section}{sub-section:7921CF41-ECC5-4662-936F-8A7A63D4D326streamFilesToServer_ret|trigger=none|class=sIndent}[JSFile]void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:7921CF41-ECC5-4662-936F-8A7A63D4D326streamFilesToServer_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7921CF41-ECC5-4662-936F-8A7A63D4D326streamFilesToServer_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:7921CF41-ECC5-4662-936F-8A7A63D4D326_seestreamFilesToServer_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7921CF41-ECC5-4662-936F-8A7A63D4D326streamFilesToServer_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:7921CF41-ECC5-4662-936F-8A7A63D4D326streamFilesToServer_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7921CF41-ECC5-4662-936F-8A7A63D4D326streamFilesToServer_sam|class=sIndent|trigger=none}{code:language=javascript}
// send one file:
	var file = plugins.file.showFileOpenDialog( 1, null, false, null, null, 'Choose a file to transfer' );
	if (file) {
		plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath());
streamFilesToServer( file, callbackFunction );
	}
	// send an array of files:
	var folder = plugins.file.showDirectorySelectDialog();
	if (folder) {
		var files = plugins.file.getFolderContents(folder);
		if (files) {
			plugins.file.streamFilesToServer( files, callbackFunction );
		}
	}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=A9EFCC2B-B8F9-4B60-9669-AF9B4EFDC495writeFile|class=node}{tr:id=name}{td}h6.writeFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}writeFile{span}{span:id=iets|style=float: left;}\(file, binary_data, \[mimeType]){span}{td}{tr}{tr:id=des}{td}{sub-section:A9EFCC2B-B8F9-4B60-9669-AF9B4EFDC495writeFile_des|text=|trigger=button}{sub-section}{sub-section:A9EFCC2B-B8F9-4B60-9669-AF9B4EFDC495writeFile_des|trigger=none|class=sIndent}Writes data into a binary file. (Web Enabled){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:A9EFCC2B-B8F9-4B60-9669-AF9B4EFDC495writeFile_snc|text=|trigger=button}{sub-section}{sub-section:writeFile_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:writeFile_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A9EFCC2B-B8F9-4B60-9669-AF9B4EFDC495writeFile_prs|trigger=none|class=sIndent}file
binary_data
\[mimeType]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:A9EFCC2B-B8F9-4B60-9669-AF9B4EFDC495writeFile_ret|text=|trigger=button}{sub-section}{sub-section:A9EFCC2B-B8F9-4B60-9669-AF9B4EFDC495writeFile_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:A9EFCC2B-B8F9-4B60-9669-AF9B4EFDC495writeFile_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A9EFCC2B-B8F9-4B60-9669-AF9B4EFDC495writeFile_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:A9EFCC2B-B8F9-4B60-9669-AF9B4EFDC495_seewriteFile_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A9EFCC2B-B8F9-4B60-9669-AF9B4EFDC495writeFile_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:A9EFCC2B-B8F9-4B60-9669-AF9B4EFDC495writeFile_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A9EFCC2B-B8F9-4B60-9669-AF9B4EFDC495writeFile_sam|class=sIndent|trigger=none}{code:language=javascript}
var bytes = new Array();
	for (var i=0; i<1024; i++)
	bytes[i] = i % 100;
var f = plugins.file.convertToJSFile('bin.dat');
++)
		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.');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=293D1B5E-8910-4D0C-AA5A-977B282F8EEDwriteTXTFile|class=node}{tr:id=name}{td}h6.writeTXTFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}writeTXTFile{span}{span:id=iets|style=float: left;}\(file, text_data, \[charsetname], \[mimeType]){span}{td}{tr}{td}{tr}{tr:id=des}{td}{sub-section:writeTXTFile_des|text=|trigger=button}{sub-section}{sub-section:writeTXTFile_des|trigger=none|class=sIndent}Writes data into a text file. (Web Enabled){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=dessnc}{td}*Since*\\{sub-section:293D1B5E-8910-4D0C-AA5A-977B282F8EED_deswriteTXTFile_snc|text=|trigger=button}{sub-section}{sub-section:293D1B5E-8910-4D0C-AA5A-977B282F8EED_deswriteTXTFile_snc|trigger=none|class=sIndent}Writes dataReplace intowith a text file. (Web Enabled)version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:293D1B5E-8910-4D0C-AA5A-977B282F8EEDwriteTXTFile_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:293D1B5E-8910-4D0C-AA5A-977B282F8EEDwriteTXTFile_prs|trigger=none|class=sIndent}file
text_data
\[charsetname]
\[mimeType]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:293D1B5E-8910-4D0C-AA5A-977B282F8EEDwriteTXTFile_ret|text=|trigger=button}{sub-section}{sub-section:293D1B5E-8910-4D0C-AA5A-977B282F8EEDwriteTXTFile_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:293D1B5E-8910-4D0C-AA5A-977B282F8EEDwriteTXTFile_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:293D1B5E-8910-4D0C-AA5A-977B282F8EEDwriteTXTFile_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:293D1B5E-8910-4D0C-AA5A-977B282F8EED_seewriteTXTFile_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:293D1B5E-8910-4D0C-AA5A-977B282F8EEDwriteTXTFile_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:293D1B5E-8910-4D0C-AA5A-977B282F8EEDwriteTXTFile_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:293D1B5E-8910-4D0C-AA5A-977B282F8EEDwriteTXTFile_sam|class=sIndent|trigger=none}{code: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://javawww.sunw3schools.com/j2semedia/1.4.2/docs/guide/intl/encoding.doc.htmlmedia_mimeref.asp'
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=07D0BB77-4135-420F-A09C-1D97E056B7ECwriteXMLFile|class=node}{tr:id=name}{td}h6.writeXMLFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}writeXMLFile{span}{span:id=iets|style=float: left;}\(file, xml_data){span}{td}{tr}{tr:id=des}{td}{sub-section:07D0BB77-4135-420F-A09C-1D97E056B7ECwriteXMLFile_des|text=|trigger=button}{sub-section}{sub-section:07D0BB77-4135-420F-A09C-1D97E056B7ECwriteXMLFile_des|trigger=none|class=sIndent}Writes data into an XML file. The file is saved with the encoding specified by the XML itself. (Web Enabled){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:07D0BB77-4135-420F-A09C-1D97E056B7ECwriteXMLFile_snc|text=|trigger=button}{sub-section}{sub-section:writeXMLFile_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:writeXMLFile_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:07D0BB77-4135-420F-A09C-1D97E056B7ECwriteXMLFile_prs|trigger=none|class=sIndent}file
xml_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:07D0BB77-4135-420F-A09C-1D97E056B7ECwriteXMLFile_ret|text=|trigger=button}{sub-section}{sub-section:07D0BB77-4135-420F-A09C-1D97E056B7ECwriteXMLFile_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:07D0BB77-4135-420F-A09C-1D97E056B7ECwriteXMLFile_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:07D0BB77-4135-420F-A09C-1D97E056B7ECwriteXMLFile_see|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:07D0BB77-4135-420F-A09C-1D97E056B7EC_seewriteXMLFile_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:07D0BB77-4135-420F-A09C-1D97E056B7ECwriteXMLFile_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:07D0BB77-4135-420F-A09C-1D97E056B7ECwriteXMLFile_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:07D0BB77-4135-420F-A09C-1D97E056B7ECwriteXMLFile_sam|class=sIndent|trigger=none}{code: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.');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}