Page History

Wiki Markup
{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:class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Return Types{th}{tr}{tr}{td}{span:class=sWordList}[JSFile]{span}{td}{tr}{table}\\{table:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{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}{tbody}{tr}{td}[Boolean]{td}{td}[#copyFile]\(sourceFile, destinationFile)
Copies the sourcefile to the destination file.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#copyFolder]\(sourceFolder, destinationFolder)
Copies the sourcefolder to the destination folder, recursively.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#createFile]\(targetFile)
Creates a JSFile instance.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#createFolder]\(targetFolder)
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}[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)
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)
Shows a file open dialog.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#showFileSaveDialog]\(fileName/dir suggestion)
Shows a file save dialog.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#writeFile]\(file, binary_data)
Writes data into a binary file.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#writeTXTFile]\(file, text_data, charsetname)
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:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=7A3568D3CADCF3B6-38553D4A-4E344952-BFF3AC37-2AF1AC6A0A8ECA1B15363FFC}{tr:id=name}{td}h6.convertToJSFile{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:7A3568D3CADCF3B6-38553D4A-4E344952-BFF3AC37-2AF1AC6A0A8ECA1B15363FFC_des|text=|trigger=button}{sub-section}{sub-section:7A3568D3CADCF3B6-38553D4A-4E344952-BFF3AC37-2AF1AC6A0A8ECA1B15363FFC_des|trigger=none|class=sIndent}Returns a JSFile instance corresponding to an alternative representation of a file (for example a string).{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:7A3568D3CADCF3B6-38553D4A-4E344952-BFF3AC37-2AF1AC6A0A8ECA1B15363FFC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7A3568D3CADCF3B6-38553D4A-4E344952-BFF3AC37-2AF1AC6A0A8ECA1B15363FFC_prs|trigger=none}file
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:7A3568D3CADCF3B6-38553D4A-4E344952-BFF3AC37-2AF1AC6A0A8ECA1B15363FFC_ret|text=|trigger=button}{sub-section}{sub-section:7A3568D3CADCF3B6-38553D4A-4E344952-BFF3AC37-2AF1AC6A0A8ECA1B15363FFC_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:7A3568D3CADCF3B6-38553D4A-4E344952-BFF3AC37-2AF1AC6A0A8ECA1B15363FFC_see|text=|trigger=button}{sub-section}{sub-section:7A3568D3CADCF3B6-38553D4A-4E344952-BFF3AC37-2AF1AC6A0A8ECA1B15363FFC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:7A3568D3CADCF3B6-38553D4A-4E344952-BFF3AC37-2AF1AC6A0A8ECA1B15363FFC_see|text=|trigger=button}{sub-section}{sub-section:7A3568D3CADCF3B6-38553D4A-4E344952-BFF3AC37-2AF1AC6A0A8ECA1B15363FFC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:7A3568D3CADCF3B6-38553D4A-4E344952-BFF3AC37-2AF1AC6A0A8ECA1B15363FFC_sam|text=|trigger=button}{sub-section}{sub-section:7A3568D3CADCF3B6-38553D4A-4E344952-BFF3AC37-2AF1AC6A0A8ECA1B15363FFC_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}{td}{td}{tr}{tbody}{tbody:id=AF5434A805485669-FADE13A9-405B4BAE-895F8977-FAC0368A3FB86755C96EDF66}{tr:id=name}{td}h6.copyFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}copyFile{span}{span:id=iets|style=float: left;}\(sourceFile, destinationFile){span}{td}{tr}{tr:id=des}{td}{sub-section:AF5434A805485669-FADE13A9-405B4BAE-895F8977-FAC0368A3FB86755C96EDF66_des|text=|trigger=button}{sub-section}{sub-section:AF5434A805485669-FADE13A9-405B4BAE-895F8977-FAC0368A3FB86755C96EDF66_des|trigger=none|class=sIndent}Copies the sourcefile to the destination file. Returns true if the copy succeeds, false if any error occurs.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:AF5434A805485669-FADE13A9-405B4BAE-895F8977-FAC0368A3FB86755C96EDF66_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:AF5434A805485669-FADE13A9-405B4BAE-895F8977-FAC0368A3FB86755C96EDF66_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:AF5434A805485669-FADE13A9-405B4BAE-895F8977-FAC0368A3FB86755C96EDF66_ret|text=|trigger=button}{sub-section}{sub-section:AF5434A805485669-FADE13A9-405B4BAE-895F8977-FAC0368A3FB86755C96EDF66_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:AF5434A805485669-FADE13A9-405B4BAE-895F8977-FAC0368A3FB86755C96EDF66_see|text=|trigger=button}{sub-section}{sub-section:AF5434A805485669-FADE13A9-405B4BAE-895F8977-FAC0368A3FB86755C96EDF66_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:AF5434A805485669-FADE13A9-405B4BAE-895F8977-FAC0368A3FB86755C96EDF66_see|text=|trigger=button}{sub-section}{sub-section:AF5434A805485669-FADE13A9-405B4BAE-895F8977-FAC0368A3FB86755C96EDF66_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:AF5434A805485669-FADE13A9-405B4BAE-895F8977-FAC0368A3FB86755C96EDF66_sam|text=|trigger=button}{sub-section}{sub-section:AF5434A805485669-FADE13A9-405B4BAE-895F8977-FAC0368A3FB86755C96EDF66_sam|class=sIndent|trigger=none}{code:language=javascript}
// Copy based on file names.
if (!plugins.file.copyFile("story.txt", "story.txt.copy"))
	application.output("Copy failed.");
// Copy based on JSFile instances.
var f = plugins.file.createFile("story.txt");
var fcopy = plugins.file.createFile("story.txt.copy2");
if (!plugins.file.copyFile(f, fcopy))
	application.output("Copy failed.");
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=759BA455597DCCE8-41CE9AEA-45DC4F42-A3388350-159F24B913D1E71B70A540AD}{tr:id=name}{td}h6.copyFolder{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}copyFolder{span}{span:id=iets|style=float: left;}\(sourceFolder, destinationFolder){span}{td}{tr}{tr:id=des}{td}{sub-section:759BA455597DCCE8-41CE9AEA-45DC4F42-A3388350-159F24B913D1E71B70A540AD_des|text=|trigger=button}{sub-section}{sub-section:759BA455597DCCE8-41CE9AEA-45DC4F42-A3388350-159F24B913D1E71B70A540AD_des|trigger=none|class=sIndent}Copies the sourcefolder to the destination folder, recursively. Returns true if the copy succeeds, false if any error occurs.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:759BA455597DCCE8-41CE9AEA-45DC4F42-A3388350-159F24B913D1E71B70A540AD_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:759BA455597DCCE8-41CE9AEA-45DC4F42-A3388350-159F24B913D1E71B70A540AD_prs|trigger=none}sourceFolder
destinationFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:759BA455597DCCE8-41CE9AEA-45DC4F42-A3388350-159F24B913D1E71B70A540AD_ret|text=|trigger=button}{sub-section}{sub-section:759BA455597DCCE8-41CE9AEA-45DC4F42-A3388350-159F24B913D1E71B70A540AD_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:759BA455597DCCE8-41CE9AEA-45DC4F42-A3388350-159F24B913D1E71B70A540AD_see|text=|trigger=button}{sub-section}{sub-section:759BA455597DCCE8-41CE9AEA-45DC4F42-A3388350-159F24B913D1E71B70A540AD_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:759BA455597DCCE8-41CE9AEA-45DC4F42-A3388350-159F24B913D1E71B70A540AD_see|text=|trigger=button}{sub-section}{sub-section:759BA455597DCCE8-41CE9AEA-45DC4F42-A3388350-159F24B913D1E71B70A540AD_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:759BA455597DCCE8-41CE9AEA-45DC4F42-A3388350-159F24B913D1E71B70A540AD_sam|text=|trigger=button}{sub-section}{sub-section:759BA455597DCCE8-41CE9AEA-45DC4F42-A3388350-159F24B913D1E71B70A540AD_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 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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=616C3E605BEEF4BA-B8E481A3-4444456C-81DE8F85-841119E6F9266352A8307FCC}{tr:id=name}{td}h6.createFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}createFile{span}{span:id=iets|style=float: left;}\(targetFile){span}{td}{tr}{tr:id=des}{td}{sub-section:616C3E605BEEF4BA-B8E481A3-4444456C-81DE8F85-841119E6F9266352A8307FCC_des|text=|trigger=button}{sub-section}{sub-section:616C3E605BEEF4BA-B8E481A3-4444456C-81DE8F85-841119E6F9266352A8307FCC_des|trigger=none|class=sIndent}Creates a JSFile instance. Does not create the file on disk.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:616C3E605BEEF4BA-B8E481A3-4444456C-81DE8F85-841119E6F9266352A8307FCC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:616C3E605BEEF4BA-B8E481A3-4444456C-81DE8F85-841119E6F9266352A8307FCC_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:616C3E605BEEF4BA-B8E481A3-4444456C-81DE8F85-841119E6F9266352A8307FCC_ret|text=|trigger=button}{sub-section}{sub-section:616C3E605BEEF4BA-B8E481A3-4444456C-81DE8F85-841119E6F9266352A8307FCC_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:616C3E605BEEF4BA-B8E481A3-4444456C-81DE8F85-841119E6F9266352A8307FCC_see|text=|trigger=button}{sub-section}{sub-section:616C3E605BEEF4BA-B8E481A3-4444456C-81DE8F85-841119E6F9266352A8307FCC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:616C3E605BEEF4BA-B8E481A3-4444456C-81DE8F85-841119E6F9266352A8307FCC_see|text=|trigger=button}{sub-section}{sub-section:616C3E605BEEF4BA-B8E481A3-4444456C-81DE8F85-841119E6F9266352A8307FCC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:616C3E605BEEF4BA-B8E481A3-4444456C-81DE8F85-841119E6F9266352A8307FCC_sam|text=|trigger=button}{sub-section}{sub-section:616C3E605BEEF4BA-B8E481A3-4444456C-81DE8F85-841119E6F9266352A8307FCC_sam|class=sIndent|trigger=none}{code:language=javascript}
// Create the JSFile instance based on the file name.
var f = plugins.file.createFile("newfile.txt");
// Create the file on disk.
if (!f.createNewFile())
	application.output("The file could not be created.");
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=C7F2F3FC5ABC81F1-F7B9C393-40A64F79-B12AA844-BA0D7D4590FB0F4EF08FF491}{tr:id=name}{td}h6.createFolder{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}createFolder{span}{span:id=iets|style=float: left;}\(targetFolder){span}{td}{tr}{tr:id=des}{td}{sub-section:C7F2F3FC5ABC81F1-F7B9C393-40A64F79-B12AA844-BA0D7D4590FB0F4EF08FF491_des|text=|trigger=button}{sub-section}{sub-section:C7F2F3FC5ABC81F1-F7B9C393-40A64F79-B12AA844-BA0D7D4590FB0F4EF08FF491_des|trigger=none|class=sIndent}Creates a folder on disk. Returns true if the folder is successfully created, false if any error occurs.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:C7F2F3FC5ABC81F1-F7B9C393-40A64F79-B12AA844-BA0D7D4590FB0F4EF08FF491_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C7F2F3FC5ABC81F1-F7B9C393-40A64F79-B12AA844-BA0D7D4590FB0F4EF08FF491_prs|trigger=none}targetFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C7F2F3FC5ABC81F1-F7B9C393-40A64F79-B12AA844-BA0D7D4590FB0F4EF08FF491_ret|text=|trigger=button}{sub-section}{sub-section:C7F2F3FC5ABC81F1-F7B9C393-40A64F79-B12AA844-BA0D7D4590FB0F4EF08FF491_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C7F2F3FC5ABC81F1-F7B9C393-40A64F79-B12AA844-BA0D7D4590FB0F4EF08FF491_see|text=|trigger=button}{sub-section}{sub-section:C7F2F3FC5ABC81F1-F7B9C393-40A64F79-B12AA844-BA0D7D4590FB0F4EF08FF491_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C7F2F3FC5ABC81F1-F7B9C393-40A64F79-B12AA844-BA0D7D4590FB0F4EF08FF491_see|text=|trigger=button}{sub-section}{sub-section:C7F2F3FC5ABC81F1-F7B9C393-40A64F79-B12AA844-BA0D7D4590FB0F4EF08FF491_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C7F2F3FC5ABC81F1-F7B9C393-40A64F79-B12AA844-BA0D7D4590FB0F4EF08FF491_sam|text=|trigger=button}{sub-section}{sub-section:C7F2F3FC5ABC81F1-F7B9C393-40A64F79-B12AA844-BA0D7D4590FB0F4EF08FF491_sam|class=sIndent|trigger=none}{code:language=javascript}
var d = plugins.file.convertToJSFile("newfolder");
if (!plugins.file.createFolder(d))
	application.output("Folder could not be created.");
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=DBA71328EC42B55A-FD480BDD-40494FCC-85F7AB82-0911A109FA13A7C8B993E6E7}{tr:id=name}{td}h6.createTempFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}createTempFile{span}{span:id=iets|style=float: left;}\(filePrefix, fileSuffix){span}{td}{tr}{tr:id=des}{td}{sub-section:DBA71328EC42B55A-FD480BDD-40494FCC-85F7AB82-0911A109FA13A7C8B993E6E7_des|text=|trigger=button}{sub-section}{sub-section:DBA71328EC42B55A-FD480BDD-40494FCC-85F7AB82-0911A109FA13A7C8B993E6E7_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 name.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:DBA71328EC42B55A-FD480BDD-40494FCC-85F7AB82-0911A109FA13A7C8B993E6E7_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DBA71328EC42B55A-FD480BDD-40494FCC-85F7AB82-0911A109FA13A7C8B993E6E7_prs|trigger=none}filePrefix
fileSuffix
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:DBA71328EC42B55A-FD480BDD-40494FCC-85F7AB82-0911A109FA13A7C8B993E6E7_ret|text=|trigger=button}{sub-section}{sub-section:DBA71328EC42B55A-FD480BDD-40494FCC-85F7AB82-0911A109FA13A7C8B993E6E7_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:DBA71328EC42B55A-FD480BDD-40494FCC-85F7AB82-0911A109FA13A7C8B993E6E7_see|text=|trigger=button}{sub-section}{sub-section:DBA71328EC42B55A-FD480BDD-40494FCC-85F7AB82-0911A109FA13A7C8B993E6E7_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DBA71328EC42B55A-FD480BDD-40494FCC-85F7AB82-0911A109FA13A7C8B993E6E7_see|text=|trigger=button}{sub-section}{sub-section:DBA71328EC42B55A-FD480BDD-40494FCC-85F7AB82-0911A109FA13A7C8B993E6E7_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DBA71328EC42B55A-FD480BDD-40494FCC-85F7AB82-0911A109FA13A7C8B993E6E7_sam|text=|trigger=button}{sub-section}{sub-section:DBA71328EC42B55A-FD480BDD-40494FCC-85F7AB82-0911A109FA13A7C8B993E6E7_sam|class=sIndent|trigger=none}{code:language=javascript}
var tempFile = plugins.file.createTempFile('myfile','.txt');
application.output('Temporary file created as: ' + tempFile.getAbsolutePath());
plugins.file.writeTXTFile(tempFile, 'abcdefg');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=36ABF0EE242C35AC-CC4A78DC-4C664100-9569AA3E-5691BB109C93E44BAAED52EE}{tr:id=name}{td}h6.deleteFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}deleteFile{span}{span:id=iets|style=float: left;}\(targetFile){span}{td}{tr}{tr:id=des}{td}{sub-section:36ABF0EE242C35AC-CC4A78DC-4C664100-9569AA3E-5691BB109C93E44BAAED52EE_des|text=|trigger=button}{sub-section}{sub-section:36ABF0EE242C35AC-CC4A78DC-4C664100-9569AA3E-5691BB109C93E44BAAED52EE_des|trigger=none|class=sIndent}Removes a file from disk. Returns true on success, false otherwise.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:36ABF0EE242C35AC-CC4A78DC-4C664100-9569AA3E-5691BB109C93E44BAAED52EE_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:36ABF0EE242C35AC-CC4A78DC-4C664100-9569AA3E-5691BB109C93E44BAAED52EE_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:36ABF0EE242C35AC-CC4A78DC-4C664100-9569AA3E-5691BB109C93E44BAAED52EE_ret|text=|trigger=button}{sub-section}{sub-section:36ABF0EE242C35AC-CC4A78DC-4C664100-9569AA3E-5691BB109C93E44BAAED52EE_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:36ABF0EE242C35AC-CC4A78DC-4C664100-9569AA3E-5691BB109C93E44BAAED52EE_see|text=|trigger=button}{sub-section}{sub-section:36ABF0EE242C35AC-CC4A78DC-4C664100-9569AA3E-5691BB109C93E44BAAED52EE_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:36ABF0EE242C35AC-CC4A78DC-4C664100-9569AA3E-5691BB109C93E44BAAED52EE_see|text=|trigger=button}{sub-section}{sub-section:36ABF0EE242C35AC-CC4A78DC-4C664100-9569AA3E-5691BB109C93E44BAAED52EE_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:36ABF0EE242C35AC-CC4A78DC-4C664100-9569AA3E-5691BB109C93E44BAAED52EE_sam|text=|trigger=button}{sub-section}{sub-section:36ABF0EE242C35AC-CC4A78DC-4C664100-9569AA3E-5691BB109C93E44BAAED52EE_sam|class=sIndent|trigger=none}{code:language=javascript}
if (plugins.file.deleteFile('story.txt'))
	application.output('File deleted.');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=785B122EFA7E94D7-CF266106-41BB47EC-99868EF6-C444613700027B5570ED1ECF}{tr:id=name}{td}h6.deleteFolder{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}deleteFolder{span}{span:id=iets|style=float: left;}\(targetFolder, showWarning){span}{td}{tr}{tr:id=des}{td}{sub-section:785B122EFA7E94D7-CF266106-41BB47EC-99868EF6-C444613700027B5570ED1ECF_des|text=|trigger=button}{sub-section}{sub-section:785B122EFA7E94D7-CF266106-41BB47EC-99868EF6-C444613700027B5570ED1ECF_des|trigger=none|class=sIndent}Deletes a folder from disk recursively. Returns true on success, false otherwise. If the second parameter is set to true, then a warning will be issued to the user before actually removing the folder.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:785B122EFA7E94D7-CF266106-41BB47EC-99868EF6-C444613700027B5570ED1ECF_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:785B122EFA7E94D7-CF266106-41BB47EC-99868EF6-C444613700027B5570ED1ECF_prs|trigger=none}targetFolder
showWarning
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:785B122EFA7E94D7-CF266106-41BB47EC-99868EF6-C444613700027B5570ED1ECF_ret|text=|trigger=button}{sub-section}{sub-section:785B122EFA7E94D7-CF266106-41BB47EC-99868EF6-C444613700027B5570ED1ECF_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:785B122EFA7E94D7-CF266106-41BB47EC-99868EF6-C444613700027B5570ED1ECF_see|text=|trigger=button}{sub-section}{sub-section:785B122EFA7E94D7-CF266106-41BB47EC-99868EF6-C444613700027B5570ED1ECF_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:785B122EFA7E94D7-CF266106-41BB47EC-99868EF6-C444613700027B5570ED1ECF_see|text=|trigger=button}{sub-section}{sub-section:785B122EFA7E94D7-CF266106-41BB47EC-99868EF6-C444613700027B5570ED1ECF_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:785B122EFA7E94D7-CF266106-41BB47EC-99868EF6-C444613700027B5570ED1ECF_sam|text=|trigger=button}{sub-section}{sub-section:785B122EFA7E94D7-CF266106-41BB47EC-99868EF6-C444613700027B5570ED1ECF_sam|class=sIndent|trigger=none}{code:language=javascript}
if (plugins.file.deleteFolder('stories', true))
	application.output('Folder deleted.');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=27C9EA1E887CC54A-E6167317-48E1431C-B20F90F2-DEDC85D93291F83F083C3B99}{tr:id=name}{td}h6.getDesktopFolder{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}getDesktopFolder{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:27C9EA1E887CC54A-E6167317-48E1431C-B20F90F2-DEDC85D93291F83F083C3B99_des|text=|trigger=button}{sub-section}{sub-section:27C9EA1E887CC54A-E6167317-48E1431C-B20F90F2-DEDC85D93291F83F083C3B99_des|trigger=none|class=sIndent}Returns a JSFile instance that corresponds to the Desktop folder of the currently logged in user.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:27C9EA1E887CC54A-E6167317-48E1431C-B20F90F2-DEDC85D93291F83F083C3B99_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:27C9EA1E887CC54A-E6167317-48E1431C-B20F90F2-DEDC85D93291F83F083C3B99_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:27C9EA1E887CC54A-E6167317-48E1431C-B20F90F2-DEDC85D93291F83F083C3B99_ret|text=|trigger=button}{sub-section}{sub-section:27C9EA1E887CC54A-E6167317-48E1431C-B20F90F2-DEDC85D93291F83F083C3B99_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:27C9EA1E887CC54A-E6167317-48E1431C-B20F90F2-DEDC85D93291F83F083C3B99_see|text=|trigger=button}{sub-section}{sub-section:27C9EA1E887CC54A-E6167317-48E1431C-B20F90F2-DEDC85D93291F83F083C3B99_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:27C9EA1E887CC54A-E6167317-48E1431C-B20F90F2-DEDC85D93291F83F083C3B99_see|text=|trigger=button}{sub-section}{sub-section:27C9EA1E887CC54A-E6167317-48E1431C-B20F90F2-DEDC85D93291F83F083C3B99_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:27C9EA1E887CC54A-E6167317-48E1431C-B20F90F2-DEDC85D93291F83F083C3B99_sam|text=|trigger=button}{sub-section}{sub-section:27C9EA1E887CC54A-E6167317-48E1431C-B20F90F2-DEDC85D93291F83F083C3B99_sam|class=sIndent|trigger=none}{code:language=javascript}
var d = plugins.file.getDesktopFolder();
application.output('desktop folder is: ' + d.getAbsolutePath());
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=7CDA44C819F3C4B1-7AB138DE-40884CB6-860DA920-74D93E513D2F356F583E34C6}{tr:id=name}{td}h6.getDiskList{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getDiskList{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:7CDA44C819F3C4B1-7AB138DE-40884CB6-860DA920-74D93E513D2F356F583E34C6_des|text=|trigger=button}{sub-section}{sub-section:7CDA44C819F3C4B1-7AB138DE-40884CB6-860DA920-74D93E513D2F356F583E34C6_des|trigger=none|class=sIndent}Returns an Array of JSFile instances correponding to the file system root folders.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:7CDA44C819F3C4B1-7AB138DE-40884CB6-860DA920-74D93E513D2F356F583E34C6_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7CDA44C819F3C4B1-7AB138DE-40884CB6-860DA920-74D93E513D2F356F583E34C6_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:7CDA44C819F3C4B1-7AB138DE-40884CB6-860DA920-74D93E513D2F356F583E34C6_ret|text=|trigger=button}{sub-section}{sub-section:7CDA44C819F3C4B1-7AB138DE-40884CB6-860DA920-74D93E513D2F356F583E34C6_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:7CDA44C819F3C4B1-7AB138DE-40884CB6-860DA920-74D93E513D2F356F583E34C6_see|text=|trigger=button}{sub-section}{sub-section:7CDA44C819F3C4B1-7AB138DE-40884CB6-860DA920-74D93E513D2F356F583E34C6_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:7CDA44C819F3C4B1-7AB138DE-40884CB6-860DA920-74D93E513D2F356F583E34C6_see|text=|trigger=button}{sub-section}{sub-section:7CDA44C819F3C4B1-7AB138DE-40884CB6-860DA920-74D93E513D2F356F583E34C6_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:7CDA44C819F3C4B1-7AB138DE-40884CB6-860DA920-74D93E513D2F356F583E34C6_sam|text=|trigger=button}{sub-section}{sub-section:7CDA44C819F3C4B1-7AB138DE-40884CB6-860DA920-74D93E513D2F356F583E34C6_sam|class=sIndent|trigger=none}{code:language=javascript}
var roots = plugins.file.getDiskList();
for (var i = 0; i < roots.length; i++)
	application.output(roots[i].getAbsolutePath());
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=DB321C9052B985E3-D0828DF2-45A24C28-BCE284EC-66B9210E627B5038AAD0F910}{tr:id=name}{td}h6.getFileSize{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getFileSize{span}{span:id=iets|style=float: left;}\(targetFile){span}{td}{tr}{tr:id=des}{td}{sub-section:DB321C9052B985E3-D0828DF2-45A24C28-BCE284EC-66B9210E627B5038AAD0F910_des|text=|trigger=button}{sub-section}{sub-section:DB321C9052B985E3-D0828DF2-45A24C28-BCE284EC-66B9210E627B5038AAD0F910_des|trigger=none|class=sIndent}Returns the size of the specified file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:DB321C9052B985E3-D0828DF2-45A24C28-BCE284EC-66B9210E627B5038AAD0F910_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DB321C9052B985E3-D0828DF2-45A24C28-BCE284EC-66B9210E627B5038AAD0F910_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:DB321C9052B985E3-D0828DF2-45A24C28-BCE284EC-66B9210E627B5038AAD0F910_ret|text=|trigger=button}{sub-section}{sub-section:DB321C9052B985E3-D0828DF2-45A24C28-BCE284EC-66B9210E627B5038AAD0F910_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:DB321C9052B985E3-D0828DF2-45A24C28-BCE284EC-66B9210E627B5038AAD0F910_see|text=|trigger=button}{sub-section}{sub-section:DB321C9052B985E3-D0828DF2-45A24C28-BCE284EC-66B9210E627B5038AAD0F910_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DB321C9052B985E3-D0828DF2-45A24C28-BCE284EC-66B9210E627B5038AAD0F910_see|text=|trigger=button}{sub-section}{sub-section:DB321C9052B985E3-D0828DF2-45A24C28-BCE284EC-66B9210E627B5038AAD0F910_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DB321C9052B985E3-D0828DF2-45A24C28-BCE284EC-66B9210E627B5038AAD0F910_sam|text=|trigger=button}{sub-section}{sub-section:DB321C9052B985E3-D0828DF2-45A24C28-BCE284EC-66B9210E627B5038AAD0F910_sam|class=sIndent|trigger=none}{code:language=javascript}
var f = plugins.file.convertToJSFile('story.txt');
application.output('file size: ' + plugins.file.getFileSize(f));
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=58E7241FEFCBE241-8E2DF42A-4FB049DD-99B7A856-CA72B766AF877D85C74DB3E5}{tr:id=name}{td}h6.getFolderContents{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getFolderContents{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:58E7241FEFCBE241-8E2DF42A-4FB049DD-99B7A856-CA72B766AF877D85C74DB3E5_des|text=|trigger=button}{sub-section}{sub-section:58E7241FEFCBE241-8E2DF42A-4FB049DD-99B7A856-CA72B766AF877D85C74DB3E5_des|trigger=none|class=sIndent}Returns an array of JSFile instances corresponding to content of the specified folder. The content can be filtered by optional name filter(s), by type, by visibility and by lock status.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:58E7241FEFCBE241-8E2DF42A-4FB049DD-99B7A856-CA72B766AF877D85C74DB3E5_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:58E7241FEFCBE241-8E2DF42A-4FB049DD-99B7A856-CA72B766AF877D85C74DB3E5_prs|trigger=none}targetFolder
\[fileFilter\]
\[fileOption(1=files,2=dirs)\]
\[visibleOption(1=visible,2=nonvisible)\]
\[lockedOption(1=locked,2=nonlocked)\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:58E7241FEFCBE241-8E2DF42A-4FB049DD-99B7A856-CA72B766AF877D85C74DB3E5_ret|text=|trigger=button}{sub-section}{sub-section:58E7241FEFCBE241-8E2DF42A-4FB049DD-99B7A856-CA72B766AF877D85C74DB3E5_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:58E7241FEFCBE241-8E2DF42A-4FB049DD-99B7A856-CA72B766AF877D85C74DB3E5_see|text=|trigger=button}{sub-section}{sub-section:58E7241FEFCBE241-8E2DF42A-4FB049DD-99B7A856-CA72B766AF877D85C74DB3E5_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:58E7241FEFCBE241-8E2DF42A-4FB049DD-99B7A856-CA72B766AF877D85C74DB3E5_see|text=|trigger=button}{sub-section}{sub-section:58E7241FEFCBE241-8E2DF42A-4FB049DD-99B7A856-CA72B766AF877D85C74DB3E5_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:58E7241FEFCBE241-8E2DF42A-4FB049DD-99B7A856-CA72B766AF877D85C74DB3E5_sam|text=|trigger=button}{sub-section}{sub-section:58E7241FEFCBE241-8E2DF42A-4FB049DD-99B7A856-CA72B766AF877D85C74DB3E5_sam|class=sIndent|trigger=none}{code:language=javascript}
var files = plugins.file.getFolderContents('stories', '.txt');
for (var i=0; i<files.length; i++)
	application.output(files[i].getAbsolutePath());
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=56B7D3013B6CA53F-D295B740-47EB400D-BA078FF8-F18662E25F824872A3686BEC}{tr:id=name}{td}h6.getHomeDirectory{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}getHomeDirectory{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:56B7D3013B6CA53F-D295B740-47EB400D-BA078FF8-F18662E25F824872A3686BEC_des|text=|trigger=button}{sub-section}{sub-section:56B7D3013B6CA53F-D295B740-47EB400D-BA078FF8-F18662E25F824872A3686BEC_des|trigger=none|class=sIndent}Returns a JSFile instance corresponding to the home folder of the logged in used.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:56B7D3013B6CA53F-D295B740-47EB400D-BA078FF8-F18662E25F824872A3686BEC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:56B7D3013B6CA53F-D295B740-47EB400D-BA078FF8-F18662E25F824872A3686BEC_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:56B7D3013B6CA53F-D295B740-47EB400D-BA078FF8-F18662E25F824872A3686BEC_ret|text=|trigger=button}{sub-section}{sub-section:56B7D3013B6CA53F-D295B740-47EB400D-BA078FF8-F18662E25F824872A3686BEC_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:56B7D3013B6CA53F-D295B740-47EB400D-BA078FF8-F18662E25F824872A3686BEC_see|text=|trigger=button}{sub-section}{sub-section:56B7D3013B6CA53F-D295B740-47EB400D-BA078FF8-F18662E25F824872A3686BEC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:56B7D3013B6CA53F-D295B740-47EB400D-BA078FF8-F18662E25F824872A3686BEC_see|text=|trigger=button}{sub-section}{sub-section:56B7D3013B6CA53F-D295B740-47EB400D-BA078FF8-F18662E25F824872A3686BEC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:56B7D3013B6CA53F-D295B740-47EB400D-BA078FF8-F18662E25F824872A3686BEC_sam|text=|trigger=button}{sub-section}{sub-section:56B7D3013B6CA53F-D295B740-47EB400D-BA078FF8-F18662E25F824872A3686BEC_sam|class=sIndent|trigger=none}{code:language=javascript}
var d = plugins.file.getHomeDirectory();
application.output('home folder: ' + d.getAbsolutePath());
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=B2E3394E79A7BAF9-27675DAD-43D9418D-85359F85-A55954AFDB580DA8C042CFB4}{tr:id=name}{td}h6.getModificationDate{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Date]{span}{span:id=iets|style=float: left; font-weight: bold;}getModificationDate{span}{span:id=iets|style=float: left;}\(targetFile){span}{td}{tr}{tr:id=des}{td}{sub-section:B2E3394E79A7BAF9-27675DAD-43D9418D-85359F85-A55954AFDB580DA8C042CFB4_des|text=|trigger=button}{sub-section}{sub-section:B2E3394E79A7BAF9-27675DAD-43D9418D-85359F85-A55954AFDB580DA8C042CFB4_des|trigger=none|class=sIndent}Returns the modification date of a file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:B2E3394E79A7BAF9-27675DAD-43D9418D-85359F85-A55954AFDB580DA8C042CFB4_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B2E3394E79A7BAF9-27675DAD-43D9418D-85359F85-A55954AFDB580DA8C042CFB4_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:B2E3394E79A7BAF9-27675DAD-43D9418D-85359F85-A55954AFDB580DA8C042CFB4_ret|text=|trigger=button}{sub-section}{sub-section:B2E3394E79A7BAF9-27675DAD-43D9418D-85359F85-A55954AFDB580DA8C042CFB4_ret|trigger=none|class=sIndent}[Date]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B2E3394E79A7BAF9-27675DAD-43D9418D-85359F85-A55954AFDB580DA8C042CFB4_see|text=|trigger=button}{sub-section}{sub-section:B2E3394E79A7BAF9-27675DAD-43D9418D-85359F85-A55954AFDB580DA8C042CFB4_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B2E3394E79A7BAF9-27675DAD-43D9418D-85359F85-A55954AFDB580DA8C042CFB4_see|text=|trigger=button}{sub-section}{sub-section:B2E3394E79A7BAF9-27675DAD-43D9418D-85359F85-A55954AFDB580DA8C042CFB4_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B2E3394E79A7BAF9-27675DAD-43D9418D-85359F85-A55954AFDB580DA8C042CFB4_sam|text=|trigger=button}{sub-section}{sub-section:B2E3394E79A7BAF9-27675DAD-43D9418D-85359F85-A55954AFDB580DA8C042CFB4_sam|class=sIndent|trigger=none}{code:language=javascript}
var f = plugins.file.convertToJSFile('story.txt');
application.output('last changed: ' + plugins.file.getModificationDate(f));
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=670009F5336EA333-54BFFFF7-423E4FC1-B55E937A-17EDBEC9EE8C8CC2B3D1F4C1}{tr:id=name}{td}h6.moveFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}moveFile{span}{span:id=iets|style=float: left;}\(sourceFile, destinationFile){span}{td}{tr}{tr:id=des}{td}{sub-section:670009F5336EA333-54BFFFF7-423E4FC1-B55E937A-17EDBEC9EE8C8CC2B3D1F4C1_des|text=|trigger=button}{sub-section}{sub-section:670009F5336EA333-54BFFFF7-423E4FC1-B55E937A-17EDBEC9EE8C8CC2B3D1F4C1_des|trigger=none|class=sIndent}Moves the file from the source to the destination place. Returns true on success, false otherwise.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:670009F5336EA333-54BFFFF7-423E4FC1-B55E937A-17EDBEC9EE8C8CC2B3D1F4C1_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:670009F5336EA333-54BFFFF7-423E4FC1-B55E937A-17EDBEC9EE8C8CC2B3D1F4C1_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:670009F5336EA333-54BFFFF7-423E4FC1-B55E937A-17EDBEC9EE8C8CC2B3D1F4C1_ret|text=|trigger=button}{sub-section}{sub-section:670009F5336EA333-54BFFFF7-423E4FC1-B55E937A-17EDBEC9EE8C8CC2B3D1F4C1_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:670009F5336EA333-54BFFFF7-423E4FC1-B55E937A-17EDBEC9EE8C8CC2B3D1F4C1_see|text=|trigger=button}{sub-section}{sub-section:670009F5336EA333-54BFFFF7-423E4FC1-B55E937A-17EDBEC9EE8C8CC2B3D1F4C1_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:670009F5336EA333-54BFFFF7-423E4FC1-B55E937A-17EDBEC9EE8C8CC2B3D1F4C1_see|text=|trigger=button}{sub-section}{sub-section:670009F5336EA333-54BFFFF7-423E4FC1-B55E937A-17EDBEC9EE8C8CC2B3D1F4C1_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:670009F5336EA333-54BFFFF7-423E4FC1-B55E937A-17EDBEC9EE8C8CC2B3D1F4C1_sam|text=|trigger=button}{sub-section}{sub-section:670009F5336EA333-54BFFFF7-423E4FC1-B55E937A-17EDBEC9EE8C8CC2B3D1F4C1_sam|class=sIndent|trigger=none}{code:language=javascript}
// Move file based on names.
if (!plugins.file.moveFile('story.txt','story.txt.new'))
	application.output('File move failed.');
// Move file based on JSFile instances.
var f = plugins.file.convertToJSFile('story.txt.new');
var fmoved = plugins.file.convertToJSFile('story.txt');
if (!plugins.file.moveFile(f, fmoved))
	application.output('File move back failed.');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=46DE7FD79FF3ECF5-4976348F-4C6048D8-9423A079-E2C47B8948CDA95A7D5D526B}{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:46DE7FD79FF3ECF5-4976348F-4C6048D8-9423A079-E2C47B8948CDA95A7D5D526B_des|text=|trigger=button}{sub-section}{sub-section:46DE7FD79FF3ECF5-4976348F-4C6048D8-9423A079-E2C47B8948CDA95A7D5D526B_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.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:46DE7FD79FF3ECF5-4976348F-4C6048D8-9423A079-E2C47B8948CDA95A7D5D526B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:46DE7FD79FF3ECF5-4976348F-4C6048D8-9423A079-E2C47B8948CDA95A7D5D526B_prs|trigger=none}\[file\]
\[size\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:46DE7FD79FF3ECF5-4976348F-4C6048D8-9423A079-E2C47B8948CDA95A7D5D526B_ret|text=|trigger=button}{sub-section}{sub-section:46DE7FD79FF3ECF5-4976348F-4C6048D8-9423A079-E2C47B8948CDA95A7D5D526B_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:46DE7FD79FF3ECF5-4976348F-4C6048D8-9423A079-E2C47B8948CDA95A7D5D526B_see|text=|trigger=button}{sub-section}{sub-section:46DE7FD79FF3ECF5-4976348F-4C6048D8-9423A079-E2C47B8948CDA95A7D5D526B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:46DE7FD79FF3ECF5-4976348F-4C6048D8-9423A079-E2C47B8948CDA95A7D5D526B_see|text=|trigger=button}{sub-section}{sub-section:46DE7FD79FF3ECF5-4976348F-4C6048D8-9423A079-E2C47B8948CDA95A7D5D526B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:46DE7FD79FF3ECF5-4976348F-4C6048D8-9423A079-E2C47B8948CDA95A7D5D526B_sam|text=|trigger=button}{sub-section}{sub-section:46DE7FD79FF3ECF5-4976348F-4C6048D8-9423A079-E2C47B8948CDA95A7D5D526B_sam|class=sIndent|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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=1805BF53C430EA34-6FAF0C0A-460A4B2B-8A94B03A-885DB50314890806F5F90701}{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:1805BF53C430EA34-6FAF0C0A-460A4B2B-8A94B03A-885DB50314890806F5F90701_des|text=|trigger=button}{sub-section}{sub-section:1805BF53C430EA34-6FAF0C0A-460A4B2B-8A94B03A-885DB50314890806F5F90701_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.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:1805BF53C430EA34-6FAF0C0A-460A4B2B-8A94B03A-885DB50314890806F5F90701_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:1805BF53C430EA34-6FAF0C0A-460A4B2B-8A94B03A-885DB50314890806F5F90701_prs|trigger=none}\[file\]
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:1805BF53C430EA34-6FAF0C0A-460A4B2B-8A94B03A-885DB50314890806F5F90701_ret|text=|trigger=button}{sub-section}{sub-section:1805BF53C430EA34-6FAF0C0A-460A4B2B-8A94B03A-885DB50314890806F5F90701_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:1805BF53C430EA34-6FAF0C0A-460A4B2B-8A94B03A-885DB50314890806F5F90701_see|text=|trigger=button}{sub-section}{sub-section:1805BF53C430EA34-6FAF0C0A-460A4B2B-8A94B03A-885DB50314890806F5F90701_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:1805BF53C430EA34-6FAF0C0A-460A4B2B-8A94B03A-885DB50314890806F5F90701_see|text=|trigger=button}{sub-section}{sub-section:1805BF53C430EA34-6FAF0C0A-460A4B2B-8A94B03A-885DB50314890806F5F90701_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:1805BF53C430EA34-6FAF0C0A-460A4B2B-8A94B03A-885DB50314890806F5F90701_sam|text=|trigger=button}{sub-section}{sub-section:1805BF53C430EA34-6FAF0C0A-460A4B2B-8A94B03A-885DB50314890806F5F90701_sam|class=sIndent|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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=7A0F1207251D63FB-8AD6A4AA-40A64608-81109121-F32FC30FB120ACBC8E75827D}{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){span}{td}{tr}{tr:id=des}{td}{sub-section:7A0F1207251D63FB-8AD6A4AA-40A64608-81109121-F32FC30FB120ACBC8E75827D_des|text=|trigger=button}{sub-section}{sub-section:7A0F1207251D63FB-8AD6A4AA-40A64608-81109121-F32FC30FB120ACBC8E75827D_des|trigger=none|class=sIndent}Shows a directory selector dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:7A0F1207251D63FB-8AD6A4AA-40A64608-81109121-F32FC30FB120ACBC8E75827D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7A0F1207251D63FB-8AD6A4AA-40A64608-81109121-F32FC30FB120ACBC8E75827D_prs|trigger=none}\[directory suggestion\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:7A0F1207251D63FB-8AD6A4AA-40A64608-81109121-F32FC30FB120ACBC8E75827D_ret|text=|trigger=button}{sub-section}{sub-section:7A0F1207251D63FB-8AD6A4AA-40A64608-81109121-F32FC30FB120ACBC8E75827D_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:7A0F1207251D63FB-8AD6A4AA-40A64608-81109121-F32FC30FB120ACBC8E75827D_see|text=|trigger=button}{sub-section}{sub-section:7A0F1207251D63FB-8AD6A4AA-40A64608-81109121-F32FC30FB120ACBC8E75827D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:7A0F1207251D63FB-8AD6A4AA-40A64608-81109121-F32FC30FB120ACBC8E75827D_see|text=|trigger=button}{sub-section}{sub-section:7A0F1207251D63FB-8AD6A4AA-40A64608-81109121-F32FC30FB120ACBC8E75827D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:7A0F1207251D63FB-8AD6A4AA-40A64608-81109121-F32FC30FB120ACBC8E75827D_sam|text=|trigger=button}{sub-section}{sub-section:7A0F1207251D63FB-8AD6A4AA-40A64608-81109121-F32FC30FB120ACBC8E75827D_sam|class=sIndent|trigger=none}{code:language=javascript}
var dir = plugins.file.showDirectorySelectDialog();
application.output("you've selected folder: " + dir.getAbsolutePath());
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=78C167C3CA2ED479-A0339406-4DDA4A49-9937880A-54E5D8FA46469B58AF827B2C}{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){span}{td}{tr}{tr:id=des}{td}{sub-section:78C167C3CA2ED479-A0339406-4DDA4A49-9937880A-54E5D8FA46469B58AF827B2C_des|text=|trigger=button}{sub-section}{sub-section:78C167C3CA2ED479-A0339406-4DDA4A49-9937880A-54E5D8FA46469B58AF827B2C_des|trigger=none|class=sIndent}Shows a file open dialog. Filters can be applied on what type of files can be selected.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:78C167C3CA2ED479-A0339406-4DDA4A49-9937880A-54E5D8FA46469B58AF827B2C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:78C167C3CA2ED479-A0339406-4DDA4A49-9937880A-54E5D8FA46469B58AF827B2C_prs|trigger=none}\[selectionMode(0=both,1=Files,2=Dirs)\]
\[startDirectory(null=default/previous)\]
\[multiselect(true/false)\]
\[filterarray\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:78C167C3CA2ED479-A0339406-4DDA4A49-9937880A-54E5D8FA46469B58AF827B2C_ret|text=|trigger=button}{sub-section}{sub-section:78C167C3CA2ED479-A0339406-4DDA4A49-9937880A-54E5D8FA46469B58AF827B2C_ret|trigger=none|class=sIndent}Object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:78C167C3CA2ED479-A0339406-4DDA4A49-9937880A-54E5D8FA46469B58AF827B2C_see|text=|trigger=button}{sub-section}{sub-section:78C167C3CA2ED479-A0339406-4DDA4A49-9937880A-54E5D8FA46469B58AF827B2C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:78C167C3CA2ED479-A0339406-4DDA4A49-9937880A-54E5D8FA46469B58AF827B2C_see|text=|trigger=button}{sub-section}{sub-section:78C167C3CA2ED479-A0339406-4DDA4A49-9937880A-54E5D8FA46469B58AF827B2C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:78C167C3CA2ED479-A0339406-4DDA4A49-9937880A-54E5D8FA46469B58AF827B2C_sam|text=|trigger=button}{sub-section}{sub-section:78C167C3CA2ED479-A0339406-4DDA4A49-9937880A-54E5D8FA46469B58AF827B2C_sam|class=sIndent|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());
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=CF8EF8EED05C8E7A-75F1872F-445D40ED-B728AA80-F83DE1CC5DB200D76D09BE2C}{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){span}{td}{tr}{tr:id=des}{td}{sub-section:CF8EF8EED05C8E7A-75F1872F-445D40ED-B728AA80-F83DE1CC5DB200D76D09BE2C_des|text=|trigger=button}{sub-section}{sub-section:CF8EF8EED05C8E7A-75F1872F-445D40ED-B728AA80-F83DE1CC5DB200D76D09BE2C_des|trigger=none|class=sIndent}Shows a file save dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:CF8EF8EED05C8E7A-75F1872F-445D40ED-B728AA80-F83DE1CC5DB200D76D09BE2C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:CF8EF8EED05C8E7A-75F1872F-445D40ED-B728AA80-F83DE1CC5DB200D76D09BE2C_prs|trigger=none}\[fileName/dir suggestion\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:CF8EF8EED05C8E7A-75F1872F-445D40ED-B728AA80-F83DE1CC5DB200D76D09BE2C_ret|text=|trigger=button}{sub-section}{sub-section:CF8EF8EED05C8E7A-75F1872F-445D40ED-B728AA80-F83DE1CC5DB200D76D09BE2C_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:CF8EF8EED05C8E7A-75F1872F-445D40ED-B728AA80-F83DE1CC5DB200D76D09BE2C_see|text=|trigger=button}{sub-section}{sub-section:CF8EF8EED05C8E7A-75F1872F-445D40ED-B728AA80-F83DE1CC5DB200D76D09BE2C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:CF8EF8EED05C8E7A-75F1872F-445D40ED-B728AA80-F83DE1CC5DB200D76D09BE2C_see|text=|trigger=button}{sub-section}{sub-section:CF8EF8EED05C8E7A-75F1872F-445D40ED-B728AA80-F83DE1CC5DB200D76D09BE2C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:CF8EF8EED05C8E7A-75F1872F-445D40ED-B728AA80-F83DE1CC5DB200D76D09BE2C_sam|text=|trigger=button}{sub-section}{sub-section:CF8EF8EED05C8E7A-75F1872F-445D40ED-B728AA80-F83DE1CC5DB200D76D09BE2C_sam|class=sIndent|trigger=none}{code:language=javascript}
var file = plugins.file.showFileSaveDialog();
application.output("you've selected file: " + file.getAbsolutePath());
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=C3B77A44FA26FE69-5376AE50-4CFE45F2-9669A10E-5145F8AA56FC7BC480C73BBA}{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){span}{td}{tr}{tr:id=des}{td}{sub-section:C3B77A44FA26FE69-5376AE50-4CFE45F2-9669A10E-5145F8AA56FC7BC480C73BBA_des|text=|trigger=button}{sub-section}{sub-section:C3B77A44FA26FE69-5376AE50-4CFE45F2-9669A10E-5145F8AA56FC7BC480C73BBA_des|trigger=none|class=sIndent}Writes data into a binary file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:C3B77A44FA26FE69-5376AE50-4CFE45F2-9669A10E-5145F8AA56FC7BC480C73BBA_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C3B77A44FA26FE69-5376AE50-4CFE45F2-9669A10E-5145F8AA56FC7BC480C73BBA_prs|trigger=none}file
binary_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C3B77A44FA26FE69-5376AE50-4CFE45F2-9669A10E-5145F8AA56FC7BC480C73BBA_ret|text=|trigger=button}{sub-section}{sub-section:C3B77A44FA26FE69-5376AE50-4CFE45F2-9669A10E-5145F8AA56FC7BC480C73BBA_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C3B77A44FA26FE69-5376AE50-4CFE45F2-9669A10E-5145F8AA56FC7BC480C73BBA_see|text=|trigger=button}{sub-section}{sub-section:C3B77A44FA26FE69-5376AE50-4CFE45F2-9669A10E-5145F8AA56FC7BC480C73BBA_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C3B77A44FA26FE69-5376AE50-4CFE45F2-9669A10E-5145F8AA56FC7BC480C73BBA_see|text=|trigger=button}{sub-section}{sub-section:C3B77A44FA26FE69-5376AE50-4CFE45F2-9669A10E-5145F8AA56FC7BC480C73BBA_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C3B77A44FA26FE69-5376AE50-4CFE45F2-9669A10E-5145F8AA56FC7BC480C73BBA_sam|text=|trigger=button}{sub-section}{sub-section:C3B77A44FA26FE69-5376AE50-4CFE45F2-9669A10E-5145F8AA56FC7BC480C73BBA_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');
if (!plugins.file.writeFile(f, bytes))
	application.output('Failed to write the file.');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=F5BE021C75A539A0-E1054EA0-468147D1-960EBAB1-EB258C5A182336264897C1AD}{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){span}{td}{tr}{tr:id=des}{td}{sub-section:F5BE021C75A539A0-E1054EA0-468147D1-960EBAB1-EB258C5A182336264897C1AD_des|text=|trigger=button}{sub-section}{sub-section:F5BE021C75A539A0-E1054EA0-468147D1-960EBAB1-EB258C5A182336264897C1AD_des|trigger=none|class=sIndent}Writes data into a text file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:F5BE021C75A539A0-E1054EA0-468147D1-960EBAB1-EB258C5A182336264897C1AD_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F5BE021C75A539A0-E1054EA0-468147D1-960EBAB1-EB258C5A182336264897C1AD_prs|trigger=none}file
text_data
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:F5BE021C75A539A0-E1054EA0-468147D1-960EBAB1-EB258C5A182336264897C1AD_ret|text=|trigger=button}{sub-section}{sub-section:F5BE021C75A539A0-E1054EA0-468147D1-960EBAB1-EB258C5A182336264897C1AD_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F5BE021C75A539A0-E1054EA0-468147D1-960EBAB1-EB258C5A182336264897C1AD_see|text=|trigger=button}{sub-section}{sub-section:F5BE021C75A539A0-E1054EA0-468147D1-960EBAB1-EB258C5A182336264897C1AD_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F5BE021C75A539A0-E1054EA0-468147D1-960EBAB1-EB258C5A182336264897C1AD_see|text=|trigger=button}{sub-section}{sub-section:F5BE021C75A539A0-E1054EA0-468147D1-960EBAB1-EB258C5A182336264897C1AD_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F5BE021C75A539A0-E1054EA0-468147D1-960EBAB1-EB258C5A182336264897C1AD_sam|text=|trigger=button}{sub-section}{sub-section:F5BE021C75A539A0-E1054EA0-468147D1-960EBAB1-EB258C5A182336264897C1AD_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
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=3DD1BA39585DEDD6-A0C515E1-4B7146C3-9C599F30-87E5C57873DE06D8195505CC}{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:3DD1BA39585DEDD6-A0C515E1-4B7146C3-9C599F30-87E5C57873DE06D8195505CC_des|text=|trigger=button}{sub-section}{sub-section:3DD1BA39585DEDD6-A0C515E1-4B7146C3-9C599F30-87E5C57873DE06D8195505CC_des|trigger=none|class=sIndent}Writes data into an XML file. The file is saved with the encoding specified by the XML itself.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:3DD1BA39585DEDD6-A0C515E1-4B7146C3-9C599F30-87E5C57873DE06D8195505CC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3DD1BA39585DEDD6-A0C515E1-4B7146C3-9C599F30-87E5C57873DE06D8195505CC_prs|trigger=none}file
xml_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:3DD1BA39585DEDD6-A0C515E1-4B7146C3-9C599F30-87E5C57873DE06D8195505CC_ret|text=|trigger=button}{sub-section}{sub-section:3DD1BA39585DEDD6-A0C515E1-4B7146C3-9C599F30-87E5C57873DE06D8195505CC_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3DD1BA39585DEDD6-A0C515E1-4B7146C3-9C599F30-87E5C57873DE06D8195505CC_see|text=|trigger=button}{sub-section}{sub-section:3DD1BA39585DEDD6-A0C515E1-4B7146C3-9C599F30-87E5C57873DE06D8195505CC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3DD1BA39585DEDD6-A0C515E1-4B7146C3-9C599F30-87E5C57873DE06D8195505CC_see|text=|trigger=button}{sub-section}{sub-section:3DD1BA39585DEDD6-A0C515E1-4B7146C3-9C599F30-87E5C57873DE06D8195505CC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3DD1BA39585DEDD6-A0C515E1-4B7146C3-9C599F30-87E5C57873DE06D8195505CC_sam|text=|trigger=button}{sub-section}{sub-section:3DD1BA39585DEDD6-A0C515E1-4B7146C3-9C599F30-87E5C57873DE06D8195505CC_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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Child pages

Versions Compared

Old Version 2

New Version 3

Key
