Servoy 7.x.x Documentation
Child pages
  • file

Versions Compared

Old Version 1

changes.mady.by.user Servoy Docs

Saved on

compared with

New Version 2

changes.mady.by.user Servoy Docs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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=6C93E2F37A3568D3-1AF93855-45F94E34-9491BFF3-5BDD2DC2F68F2AF1AC6A0A8E}{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:6C93E2F37A3568D3-1AF93855-45F94E34-9491BFF3-5BDD2DC2F68F2AF1AC6A0A8E_des|text=|trigger=button}{sub-section}{sub-section:6C93E2F37A3568D3-1AF93855-45F94E34-9491BFF3-5BDD2DC2F68F2AF1AC6A0A8E_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:6C93E2F37A3568D3-1AF93855-45F94E34-9491BFF3-5BDD2DC2F68F2AF1AC6A0A8E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6C93E2F37A3568D3-1AF93855-45F94E34-9491BFF3-5BDD2DC2F68F2AF1AC6A0A8E_prs|trigger=none}file
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:6C93E2F37A3568D3-1AF93855-45F94E34-9491BFF3-5BDD2DC2F68F2AF1AC6A0A8E_ret|text=|trigger=button}{sub-section}{sub-section:6C93E2F37A3568D3-1AF93855-45F94E34-9491BFF3-5BDD2DC2F68F2AF1AC6A0A8E_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:6C93E2F37A3568D3-1AF93855-45F94E34-9491BFF3-5BDD2DC2F68F2AF1AC6A0A8E_see|text=|trigger=button}{sub-section}{sub-section:6C93E2F37A3568D3-1AF93855-45F94E34-9491BFF3-5BDD2DC2F68F2AF1AC6A0A8E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:6C93E2F37A3568D3-1AF93855-45F94E34-9491BFF3-5BDD2DC2F68F2AF1AC6A0A8E_see|text=|trigger=button}{sub-section}{sub-section:6C93E2F37A3568D3-1AF93855-45F94E34-9491BFF3-5BDD2DC2F68F2AF1AC6A0A8E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:6C93E2F37A3568D3-1AF93855-45F94E34-9491BFF3-5BDD2DC2F68F2AF1AC6A0A8E_sam|text=|trigger=button}{sub-section}{sub-section:6C93E2F37A3568D3-1AF93855-45F94E34-9491BFF3-5BDD2DC2F68F2AF1AC6A0A8E_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=7DB358FFAF5434A8-DDFBFADE-4025405B-90BF895F-A6CBC12CBA3DFAC0368A3FB8}{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:7DB358FFAF5434A8-DDFBFADE-4025405B-90BF895F-A6CBC12CBA3DFAC0368A3FB8_des|text=|trigger=button}{sub-section}{sub-section:7DB358FFAF5434A8-DDFBFADE-4025405B-90BF895F-A6CBC12CBA3DFAC0368A3FB8_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:7DB358FFAF5434A8-DDFBFADE-4025405B-90BF895F-A6CBC12CBA3DFAC0368A3FB8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7DB358FFAF5434A8-DDFBFADE-4025405B-90BF895F-A6CBC12CBA3DFAC0368A3FB8_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:7DB358FFAF5434A8-DDFBFADE-4025405B-90BF895F-A6CBC12CBA3DFAC0368A3FB8_ret|text=|trigger=button}{sub-section}{sub-section:7DB358FFAF5434A8-DDFBFADE-4025405B-90BF895F-A6CBC12CBA3DFAC0368A3FB8_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:7DB358FFAF5434A8-DDFBFADE-4025405B-90BF895F-A6CBC12CBA3DFAC0368A3FB8_see|text=|trigger=button}{sub-section}{sub-section:7DB358FFAF5434A8-DDFBFADE-4025405B-90BF895F-A6CBC12CBA3DFAC0368A3FB8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:7DB358FFAF5434A8-DDFBFADE-4025405B-90BF895F-A6CBC12CBA3DFAC0368A3FB8_see|text=|trigger=button}{sub-section}{sub-section:7DB358FFAF5434A8-DDFBFADE-4025405B-90BF895F-A6CBC12CBA3DFAC0368A3FB8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:7DB358FFAF5434A8-DDFBFADE-4025405B-90BF895F-A6CBC12CBA3DFAC0368A3FB8_sam|text=|trigger=button}{sub-section}{sub-section:7DB358FFAF5434A8-DDFBFADE-4025405B-90BF895F-A6CBC12CBA3DFAC0368A3FB8_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=129F24C3759BA455-806341CE-4F5145DC-9DB2A338-D1D36D65D4E3159F24B913D1}{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:129F24C3759BA455-806341CE-4F5145DC-9DB2A338-D1D36D65D4E3159F24B913D1_des|text=|trigger=button}{sub-section}{sub-section:129F24C3759BA455-806341CE-4F5145DC-9DB2A338-D1D36D65D4E3159F24B913D1_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:129F24C3759BA455-806341CE-4F5145DC-9DB2A338-D1D36D65D4E3159F24B913D1_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:129F24C3759BA455-806341CE-4F5145DC-9DB2A338-D1D36D65D4E3159F24B913D1_prs|trigger=none}sourceFolder
destinationFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:129F24C3759BA455-806341CE-4F5145DC-9DB2A338-D1D36D65D4E3159F24B913D1_ret|text=|trigger=button}{sub-section}{sub-section:129F24C3759BA455-806341CE-4F5145DC-9DB2A338-D1D36D65D4E3159F24B913D1_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:129F24C3759BA455-806341CE-4F5145DC-9DB2A338-D1D36D65D4E3159F24B913D1_see|text=|trigger=button}{sub-section}{sub-section:129F24C3759BA455-806341CE-4F5145DC-9DB2A338-D1D36D65D4E3159F24B913D1_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:129F24C3759BA455-806341CE-4F5145DC-9DB2A338-D1D36D65D4E3159F24B913D1_see|text=|trigger=button}{sub-section}{sub-section:129F24C3759BA455-806341CE-4F5145DC-9DB2A338-D1D36D65D4E3159F24B913D1_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:129F24C3759BA455-806341CE-4F5145DC-9DB2A338-D1D36D65D4E3159F24B913D1_sam|text=|trigger=button}{sub-section}{sub-section:129F24C3759BA455-806341CE-4F5145DC-9DB2A338-D1D36D65D4E3159F24B913D1_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=0553F53C616C3E60-5A85B8E4-4D744444-832781DE-AA3377B57C57841119E6F926}{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:0553F53C616C3E60-5A85B8E4-4D744444-832781DE-AA3377B57C57841119E6F926_des|text=|trigger=button}{sub-section}{sub-section:0553F53C616C3E60-5A85B8E4-4D744444-832781DE-AA3377B57C57841119E6F926_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:0553F53C616C3E60-5A85B8E4-4D744444-832781DE-AA3377B57C57841119E6F926_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0553F53C616C3E60-5A85B8E4-4D744444-832781DE-AA3377B57C57841119E6F926_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:0553F53C616C3E60-5A85B8E4-4D744444-832781DE-AA3377B57C57841119E6F926_ret|text=|trigger=button}{sub-section}{sub-section:0553F53C616C3E60-5A85B8E4-4D744444-832781DE-AA3377B57C57841119E6F926_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:0553F53C616C3E60-5A85B8E4-4D744444-832781DE-AA3377B57C57841119E6F926_see|text=|trigger=button}{sub-section}{sub-section:0553F53C616C3E60-5A85B8E4-4D744444-832781DE-AA3377B57C57841119E6F926_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:0553F53C616C3E60-5A85B8E4-4D744444-832781DE-AA3377B57C57841119E6F926_see|text=|trigger=button}{sub-section}{sub-section:0553F53C616C3E60-5A85B8E4-4D744444-832781DE-AA3377B57C57841119E6F926_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:0553F53C616C3E60-5A85B8E4-4D744444-832781DE-AA3377B57C57841119E6F926_sam|text=|trigger=button}{sub-section}{sub-section:0553F53C616C3E60-5A85B8E4-4D744444-832781DE-AA3377B57C57841119E6F926_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=52301F02C7F2F3FC-DC8FF7B9-4AB240A6-AF94B12A-1F7C5CA1E92ABA0D7D4590FB}{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:52301F02C7F2F3FC-DC8FF7B9-4AB240A6-AF94B12A-1F7C5CA1E92ABA0D7D4590FB_des|text=|trigger=button}{sub-section}{sub-section:52301F02C7F2F3FC-DC8FF7B9-4AB240A6-AF94B12A-1F7C5CA1E92ABA0D7D4590FB_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:52301F02C7F2F3FC-DC8FF7B9-4AB240A6-AF94B12A-1F7C5CA1E92ABA0D7D4590FB_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:52301F02C7F2F3FC-DC8FF7B9-4AB240A6-AF94B12A-1F7C5CA1E92ABA0D7D4590FB_prs|trigger=none}targetFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:52301F02C7F2F3FC-DC8FF7B9-4AB240A6-AF94B12A-1F7C5CA1E92ABA0D7D4590FB_ret|text=|trigger=button}{sub-section}{sub-section:52301F02C7F2F3FC-DC8FF7B9-4AB240A6-AF94B12A-1F7C5CA1E92ABA0D7D4590FB_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:52301F02C7F2F3FC-DC8FF7B9-4AB240A6-AF94B12A-1F7C5CA1E92ABA0D7D4590FB_see|text=|trigger=button}{sub-section}{sub-section:52301F02C7F2F3FC-DC8FF7B9-4AB240A6-AF94B12A-1F7C5CA1E92ABA0D7D4590FB_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:52301F02C7F2F3FC-DC8FF7B9-4AB240A6-AF94B12A-1F7C5CA1E92ABA0D7D4590FB_see|text=|trigger=button}{sub-section}{sub-section:52301F02C7F2F3FC-DC8FF7B9-4AB240A6-AF94B12A-1F7C5CA1E92ABA0D7D4590FB_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:52301F02C7F2F3FC-DC8FF7B9-4AB240A6-AF94B12A-1F7C5CA1E92ABA0D7D4590FB_sam|text=|trigger=button}{sub-section}{sub-section:52301F02C7F2F3FC-DC8FF7B9-4AB240A6-AF94B12A-1F7C5CA1E92ABA0D7D4590FB_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=23D922BADBA71328-76B1FD48-455D4049-A5C985F7-FBEFCA63CD2E0911A109FA13}{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:23D922BADBA71328-76B1FD48-455D4049-A5C985F7-FBEFCA63CD2E0911A109FA13_des|text=|trigger=button}{sub-section}{sub-section:23D922BADBA71328-76B1FD48-455D4049-A5C985F7-FBEFCA63CD2E0911A109FA13_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:23D922BADBA71328-76B1FD48-455D4049-A5C985F7-FBEFCA63CD2E0911A109FA13_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:23D922BADBA71328-76B1FD48-455D4049-A5C985F7-FBEFCA63CD2E0911A109FA13_prs|trigger=none}filePrefix
fileSuffix
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:23D922BADBA71328-76B1FD48-455D4049-A5C985F7-FBEFCA63CD2E0911A109FA13_ret|text=|trigger=button}{sub-section}{sub-section:23D922BADBA71328-76B1FD48-455D4049-A5C985F7-FBEFCA63CD2E0911A109FA13_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:23D922BADBA71328-76B1FD48-455D4049-A5C985F7-FBEFCA63CD2E0911A109FA13_see|text=|trigger=button}{sub-section}{sub-section:23D922BADBA71328-76B1FD48-455D4049-A5C985F7-FBEFCA63CD2E0911A109FA13_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:23D922BADBA71328-76B1FD48-455D4049-A5C985F7-FBEFCA63CD2E0911A109FA13_see|text=|trigger=button}{sub-section}{sub-section:23D922BADBA71328-76B1FD48-455D4049-A5C985F7-FBEFCA63CD2E0911A109FA13_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:23D922BADBA71328-76B1FD48-455D4049-A5C985F7-FBEFCA63CD2E0911A109FA13_sam|text=|trigger=button}{sub-section}{sub-section:23D922BADBA71328-76B1FD48-455D4049-A5C985F7-FBEFCA63CD2E0911A109FA13_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=2BBF95E736ABF0EE-C0A4CC4A-4EC34C66-B0AE9569-04D6F46BAAB75691BB109C93}{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:2BBF95E736ABF0EE-C0A4CC4A-4EC34C66-B0AE9569-04D6F46BAAB75691BB109C93_des|text=|trigger=button}{sub-section}{sub-section:2BBF95E736ABF0EE-C0A4CC4A-4EC34C66-B0AE9569-04D6F46BAAB75691BB109C93_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:2BBF95E736ABF0EE-C0A4CC4A-4EC34C66-B0AE9569-04D6F46BAAB75691BB109C93_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2BBF95E736ABF0EE-C0A4CC4A-4EC34C66-B0AE9569-04D6F46BAAB75691BB109C93_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:2BBF95E736ABF0EE-C0A4CC4A-4EC34C66-B0AE9569-04D6F46BAAB75691BB109C93_ret|text=|trigger=button}{sub-section}{sub-section:2BBF95E736ABF0EE-C0A4CC4A-4EC34C66-B0AE9569-04D6F46BAAB75691BB109C93_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:2BBF95E736ABF0EE-C0A4CC4A-4EC34C66-B0AE9569-04D6F46BAAB75691BB109C93_see|text=|trigger=button}{sub-section}{sub-section:2BBF95E736ABF0EE-C0A4CC4A-4EC34C66-B0AE9569-04D6F46BAAB75691BB109C93_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2BBF95E736ABF0EE-C0A4CC4A-4EC34C66-B0AE9569-04D6F46BAAB75691BB109C93_see|text=|trigger=button}{sub-section}{sub-section:2BBF95E736ABF0EE-C0A4CC4A-4EC34C66-B0AE9569-04D6F46BAAB75691BB109C93_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2BBF95E736ABF0EE-C0A4CC4A-4EC34C66-B0AE9569-04D6F46BAAB75691BB109C93_sam|text=|trigger=button}{sub-section}{sub-section:2BBF95E736ABF0EE-C0A4CC4A-4EC34C66-B0AE9569-04D6F46BAAB75691BB109C93_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=BF758D5D785B122E-2B2ACF26-475541BB-89F89986-3C6DFC3ED668C44461370002}{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:BF758D5D785B122E-2B2ACF26-475541BB-89F89986-3C6DFC3ED668C44461370002_des|text=|trigger=button}{sub-section}{sub-section:BF758D5D785B122E-2B2ACF26-475541BB-89F89986-3C6DFC3ED668C44461370002_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:BF758D5D785B122E-2B2ACF26-475541BB-89F89986-3C6DFC3ED668C44461370002_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BF758D5D785B122E-2B2ACF26-475541BB-89F89986-3C6DFC3ED668C44461370002_prs|trigger=none}targetFolder
showWarning
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:BF758D5D785B122E-2B2ACF26-475541BB-89F89986-3C6DFC3ED668C44461370002_ret|text=|trigger=button}{sub-section}{sub-section:BF758D5D785B122E-2B2ACF26-475541BB-89F89986-3C6DFC3ED668C44461370002_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BF758D5D785B122E-2B2ACF26-475541BB-89F89986-3C6DFC3ED668C44461370002_see|text=|trigger=button}{sub-section}{sub-section:BF758D5D785B122E-2B2ACF26-475541BB-89F89986-3C6DFC3ED668C44461370002_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BF758D5D785B122E-2B2ACF26-475541BB-89F89986-3C6DFC3ED668C44461370002_see|text=|trigger=button}{sub-section}{sub-section:BF758D5D785B122E-2B2ACF26-475541BB-89F89986-3C6DFC3ED668C44461370002_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BF758D5D785B122E-2B2ACF26-475541BB-89F89986-3C6DFC3ED668C44461370002_sam|text=|trigger=button}{sub-section}{sub-section:BF758D5D785B122E-2B2ACF26-475541BB-89F89986-3C6DFC3ED668C44461370002_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=DDCC5B9427C9EA1E-2BBBE616-4C6C48E1-8A85B20F-5B79480816FEDEDC85D93291}{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:DDCC5B9427C9EA1E-2BBBE616-4C6C48E1-8A85B20F-5B79480816FEDEDC85D93291_des|text=|trigger=button}{sub-section}{sub-section:DDCC5B9427C9EA1E-2BBBE616-4C6C48E1-8A85B20F-5B79480816FEDEDC85D93291_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:DDCC5B9427C9EA1E-2BBBE616-4C6C48E1-8A85B20F-5B79480816FEDEDC85D93291_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DDCC5B9427C9EA1E-2BBBE616-4C6C48E1-8A85B20F-5B79480816FEDEDC85D93291_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:DDCC5B9427C9EA1E-2BBBE616-4C6C48E1-8A85B20F-5B79480816FEDEDC85D93291_ret|text=|trigger=button}{sub-section}{sub-section:DDCC5B9427C9EA1E-2BBBE616-4C6C48E1-8A85B20F-5B79480816FEDEDC85D93291_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:DDCC5B9427C9EA1E-2BBBE616-4C6C48E1-8A85B20F-5B79480816FEDEDC85D93291_see|text=|trigger=button}{sub-section}{sub-section:DDCC5B9427C9EA1E-2BBBE616-4C6C48E1-8A85B20F-5B79480816FEDEDC85D93291_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DDCC5B9427C9EA1E-2BBBE616-4C6C48E1-8A85B20F-5B79480816FEDEDC85D93291_see|text=|trigger=button}{sub-section}{sub-section:DDCC5B9427C9EA1E-2BBBE616-4C6C48E1-8A85B20F-5B79480816FEDEDC85D93291_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DDCC5B9427C9EA1E-2BBBE616-4C6C48E1-8A85B20F-5B79480816FEDEDC85D93291_sam|text=|trigger=button}{sub-section}{sub-section:DDCC5B9427C9EA1E-2BBBE616-4C6C48E1-8A85B20F-5B79480816FEDEDC85D93291_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=F13B79117CDA44C8-27B67AB1-465E4088-8360860D-F42A8DF6C67E74D93E513D2F}{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:F13B79117CDA44C8-27B67AB1-465E4088-8360860D-F42A8DF6C67E74D93E513D2F_des|text=|trigger=button}{sub-section}{sub-section:F13B79117CDA44C8-27B67AB1-465E4088-8360860D-F42A8DF6C67E74D93E513D2F_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:F13B79117CDA44C8-27B67AB1-465E4088-8360860D-F42A8DF6C67E74D93E513D2F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F13B79117CDA44C8-27B67AB1-465E4088-8360860D-F42A8DF6C67E74D93E513D2F_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:F13B79117CDA44C8-27B67AB1-465E4088-8360860D-F42A8DF6C67E74D93E513D2F_ret|text=|trigger=button}{sub-section}{sub-section:F13B79117CDA44C8-27B67AB1-465E4088-8360860D-F42A8DF6C67E74D93E513D2F_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F13B79117CDA44C8-27B67AB1-465E4088-8360860D-F42A8DF6C67E74D93E513D2F_see|text=|trigger=button}{sub-section}{sub-section:F13B79117CDA44C8-27B67AB1-465E4088-8360860D-F42A8DF6C67E74D93E513D2F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F13B79117CDA44C8-27B67AB1-465E4088-8360860D-F42A8DF6C67E74D93E513D2F_see|text=|trigger=button}{sub-section}{sub-section:F13B79117CDA44C8-27B67AB1-465E4088-8360860D-F42A8DF6C67E74D93E513D2F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F13B79117CDA44C8-27B67AB1-465E4088-8360860D-F42A8DF6C67E74D93E513D2F_sam|text=|trigger=button}{sub-section}{sub-section:F13B79117CDA44C8-27B67AB1-465E4088-8360860D-F42A8DF6C67E74D93E513D2F_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=2FF4210CDB321C90-7585D082-4D9B45A2-9E5ABCE2-E3816F97147466B9210E627B}{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:2FF4210CDB321C90-7585D082-4D9B45A2-9E5ABCE2-E3816F97147466B9210E627B_des|text=|trigger=button}{sub-section}{sub-section:2FF4210CDB321C90-7585D082-4D9B45A2-9E5ABCE2-E3816F97147466B9210E627B_des|trigger=none|class=sIndent}Returns the size of the specified file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:2FF4210CDB321C90-7585D082-4D9B45A2-9E5ABCE2-E3816F97147466B9210E627B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2FF4210CDB321C90-7585D082-4D9B45A2-9E5ABCE2-E3816F97147466B9210E627B_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:2FF4210CDB321C90-7585D082-4D9B45A2-9E5ABCE2-E3816F97147466B9210E627B_ret|text=|trigger=button}{sub-section}{sub-section:2FF4210CDB321C90-7585D082-4D9B45A2-9E5ABCE2-E3816F97147466B9210E627B_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:2FF4210CDB321C90-7585D082-4D9B45A2-9E5ABCE2-E3816F97147466B9210E627B_see|text=|trigger=button}{sub-section}{sub-section:2FF4210CDB321C90-7585D082-4D9B45A2-9E5ABCE2-E3816F97147466B9210E627B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2FF4210CDB321C90-7585D082-4D9B45A2-9E5ABCE2-E3816F97147466B9210E627B_see|text=|trigger=button}{sub-section}{sub-section:2FF4210CDB321C90-7585D082-4D9B45A2-9E5ABCE2-E3816F97147466B9210E627B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2FF4210CDB321C90-7585D082-4D9B45A2-9E5ABCE2-E3816F97147466B9210E627B_sam|text=|trigger=button}{sub-section}{sub-section:2FF4210CDB321C90-7585D082-4D9B45A2-9E5ABCE2-E3816F97147466B9210E627B_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=7AEA6DB658E7241F-65378E2D-4D074FB0-B4CA99B7-540058D7D4E3CA72B766AF87}{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:7AEA6DB658E7241F-65378E2D-4D074FB0-B4CA99B7-540058D7D4E3CA72B766AF87_des|text=|trigger=button}{sub-section}{sub-section:7AEA6DB658E7241F-65378E2D-4D074FB0-B4CA99B7-540058D7D4E3CA72B766AF87_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:7AEA6DB658E7241F-65378E2D-4D074FB0-B4CA99B7-540058D7D4E3CA72B766AF87_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7AEA6DB658E7241F-65378E2D-4D074FB0-B4CA99B7-540058D7D4E3CA72B766AF87_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:7AEA6DB658E7241F-65378E2D-4D074FB0-B4CA99B7-540058D7D4E3CA72B766AF87_ret|text=|trigger=button}{sub-section}{sub-section:7AEA6DB658E7241F-65378E2D-4D074FB0-B4CA99B7-540058D7D4E3CA72B766AF87_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:7AEA6DB658E7241F-65378E2D-4D074FB0-B4CA99B7-540058D7D4E3CA72B766AF87_see|text=|trigger=button}{sub-section}{sub-section:7AEA6DB658E7241F-65378E2D-4D074FB0-B4CA99B7-540058D7D4E3CA72B766AF87_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:7AEA6DB658E7241F-65378E2D-4D074FB0-B4CA99B7-540058D7D4E3CA72B766AF87_see|text=|trigger=button}{sub-section}{sub-section:7AEA6DB658E7241F-65378E2D-4D074FB0-B4CA99B7-540058D7D4E3CA72B766AF87_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:7AEA6DB658E7241F-65378E2D-4D074FB0-B4CA99B7-540058D7D4E3CA72B766AF87_sam|text=|trigger=button}{sub-section}{sub-section:7AEA6DB658E7241F-65378E2D-4D074FB0-B4CA99B7-540058D7D4E3CA72B766AF87_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=16020D0856B7D301-719AD295-4B4047EB-AF4BBA07-77AD0E12FA8BF18662E25F82}{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:16020D0856B7D301-719AD295-4B4047EB-AF4BBA07-77AD0E12FA8BF18662E25F82_des|text=|trigger=button}{sub-section}{sub-section:16020D0856B7D301-719AD295-4B4047EB-AF4BBA07-77AD0E12FA8BF18662E25F82_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:16020D0856B7D301-719AD295-4B4047EB-AF4BBA07-77AD0E12FA8BF18662E25F82_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:16020D0856B7D301-719AD295-4B4047EB-AF4BBA07-77AD0E12FA8BF18662E25F82_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:16020D0856B7D301-719AD295-4B4047EB-AF4BBA07-77AD0E12FA8BF18662E25F82_ret|text=|trigger=button}{sub-section}{sub-section:16020D0856B7D301-719AD295-4B4047EB-AF4BBA07-77AD0E12FA8BF18662E25F82_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:16020D0856B7D301-719AD295-4B4047EB-AF4BBA07-77AD0E12FA8BF18662E25F82_see|text=|trigger=button}{sub-section}{sub-section:16020D0856B7D301-719AD295-4B4047EB-AF4BBA07-77AD0E12FA8BF18662E25F82_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:16020D0856B7D301-719AD295-4B4047EB-AF4BBA07-77AD0E12FA8BF18662E25F82_see|text=|trigger=button}{sub-section}{sub-section:16020D0856B7D301-719AD295-4B4047EB-AF4BBA07-77AD0E12FA8BF18662E25F82_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:16020D0856B7D301-719AD295-4B4047EB-AF4BBA07-77AD0E12FA8BF18662E25F82_sam|text=|trigger=button}{sub-section}{sub-section:16020D0856B7D301-719AD295-4B4047EB-AF4BBA07-77AD0E12FA8BF18662E25F82_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=A07FBCD9B2E3394E-ADFD2767-4EDD43D9-ADB38535-F434656C42FBA55954AFDB58}{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:A07FBCD9B2E3394E-ADFD2767-4EDD43D9-ADB38535-F434656C42FBA55954AFDB58_des|text=|trigger=button}{sub-section}{sub-section:A07FBCD9B2E3394E-ADFD2767-4EDD43D9-ADB38535-F434656C42FBA55954AFDB58_des|trigger=none|class=sIndent}Returns the modification date of a file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:A07FBCD9B2E3394E-ADFD2767-4EDD43D9-ADB38535-F434656C42FBA55954AFDB58_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A07FBCD9B2E3394E-ADFD2767-4EDD43D9-ADB38535-F434656C42FBA55954AFDB58_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:A07FBCD9B2E3394E-ADFD2767-4EDD43D9-ADB38535-F434656C42FBA55954AFDB58_ret|text=|trigger=button}{sub-section}{sub-section:A07FBCD9B2E3394E-ADFD2767-4EDD43D9-ADB38535-F434656C42FBA55954AFDB58_ret|trigger=none|class=sIndent}[Date]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:A07FBCD9B2E3394E-ADFD2767-4EDD43D9-ADB38535-F434656C42FBA55954AFDB58_see|text=|trigger=button}{sub-section}{sub-section:A07FBCD9B2E3394E-ADFD2767-4EDD43D9-ADB38535-F434656C42FBA55954AFDB58_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:A07FBCD9B2E3394E-ADFD2767-4EDD43D9-ADB38535-F434656C42FBA55954AFDB58_see|text=|trigger=button}{sub-section}{sub-section:A07FBCD9B2E3394E-ADFD2767-4EDD43D9-ADB38535-F434656C42FBA55954AFDB58_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:A07FBCD9B2E3394E-ADFD2767-4EDD43D9-ADB38535-F434656C42FBA55954AFDB58_sam|text=|trigger=button}{sub-section}{sub-section:A07FBCD9B2E3394E-ADFD2767-4EDD43D9-ADB38535-F434656C42FBA55954AFDB58_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=47B8C5EA670009F5-9B5154BF-46DC423E-8D49B55E-3DAF744CE2FA17EDBEC9EE8C}{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:47B8C5EA670009F5-9B5154BF-46DC423E-8D49B55E-3DAF744CE2FA17EDBEC9EE8C_des|text=|trigger=button}{sub-section}{sub-section:47B8C5EA670009F5-9B5154BF-46DC423E-8D49B55E-3DAF744CE2FA17EDBEC9EE8C_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:47B8C5EA670009F5-9B5154BF-46DC423E-8D49B55E-3DAF744CE2FA17EDBEC9EE8C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:47B8C5EA670009F5-9B5154BF-46DC423E-8D49B55E-3DAF744CE2FA17EDBEC9EE8C_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:47B8C5EA670009F5-9B5154BF-46DC423E-8D49B55E-3DAF744CE2FA17EDBEC9EE8C_ret|text=|trigger=button}{sub-section}{sub-section:47B8C5EA670009F5-9B5154BF-46DC423E-8D49B55E-3DAF744CE2FA17EDBEC9EE8C_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:47B8C5EA670009F5-9B5154BF-46DC423E-8D49B55E-3DAF744CE2FA17EDBEC9EE8C_see|text=|trigger=button}{sub-section}{sub-section:47B8C5EA670009F5-9B5154BF-46DC423E-8D49B55E-3DAF744CE2FA17EDBEC9EE8C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:47B8C5EA670009F5-9B5154BF-46DC423E-8D49B55E-3DAF744CE2FA17EDBEC9EE8C_see|text=|trigger=button}{sub-section}{sub-section:47B8C5EA670009F5-9B5154BF-46DC423E-8D49B55E-3DAF744CE2FA17EDBEC9EE8C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:47B8C5EA670009F5-9B5154BF-46DC423E-8D49B55E-3DAF744CE2FA17EDBEC9EE8C_sam|text=|trigger=button}{sub-section}{sub-section:47B8C5EA670009F5-9B5154BF-46DC423E-8D49B55E-3DAF744CE2FA17EDBEC9EE8C_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=318A856046DE7FD7-E2DF4976-41FE4C60-924A9423-A54C7EF24A05E2C47B8948CD}{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:318A856046DE7FD7-E2DF4976-41FE4C60-924A9423-A54C7EF24A05E2C47B8948CD_des|text=|trigger=button}{sub-section}{sub-section:318A856046DE7FD7-E2DF4976-41FE4C60-924A9423-A54C7EF24A05E2C47B8948CD_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:318A856046DE7FD7-E2DF4976-41FE4C60-924A9423-A54C7EF24A05E2C47B8948CD_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:318A856046DE7FD7-E2DF4976-41FE4C60-924A9423-A54C7EF24A05E2C47B8948CD_prs|trigger=none}\[file\]
\[size\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:318A856046DE7FD7-E2DF4976-41FE4C60-924A9423-A54C7EF24A05E2C47B8948CD_ret|text=|trigger=button}{sub-section}{sub-section:318A856046DE7FD7-E2DF4976-41FE4C60-924A9423-A54C7EF24A05E2C47B8948CD_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:318A856046DE7FD7-E2DF4976-41FE4C60-924A9423-A54C7EF24A05E2C47B8948CD_see|text=|trigger=button}{sub-section}{sub-section:318A856046DE7FD7-E2DF4976-41FE4C60-924A9423-A54C7EF24A05E2C47B8948CD_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:318A856046DE7FD7-E2DF4976-41FE4C60-924A9423-A54C7EF24A05E2C47B8948CD_see|text=|trigger=button}{sub-section}{sub-section:318A856046DE7FD7-E2DF4976-41FE4C60-924A9423-A54C7EF24A05E2C47B8948CD_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:318A856046DE7FD7-E2DF4976-41FE4C60-924A9423-A54C7EF24A05E2C47B8948CD_sam|text=|trigger=button}{sub-section}{sub-section:318A856046DE7FD7-E2DF4976-41FE4C60-924A9423-A54C7EF24A05E2C47B8948CD_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=471DF4681805BF53-A0E66FAF-4EE3460A-8FDE8A94-639109BA6342885DB5031489}{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:471DF4681805BF53-A0E66FAF-4EE3460A-8FDE8A94-639109BA6342885DB5031489_des|text=|trigger=button}{sub-section}{sub-section:471DF4681805BF53-A0E66FAF-4EE3460A-8FDE8A94-639109BA6342885DB5031489_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:471DF4681805BF53-A0E66FAF-4EE3460A-8FDE8A94-639109BA6342885DB5031489_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:471DF4681805BF53-A0E66FAF-4EE3460A-8FDE8A94-639109BA6342885DB5031489_prs|trigger=none}\[file\]
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:471DF4681805BF53-A0E66FAF-4EE3460A-8FDE8A94-639109BA6342885DB5031489_ret|text=|trigger=button}{sub-section}{sub-section:471DF4681805BF53-A0E66FAF-4EE3460A-8FDE8A94-639109BA6342885DB5031489_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:471DF4681805BF53-A0E66FAF-4EE3460A-8FDE8A94-639109BA6342885DB5031489_see|text=|trigger=button}{sub-section}{sub-section:471DF4681805BF53-A0E66FAF-4EE3460A-8FDE8A94-639109BA6342885DB5031489_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:471DF4681805BF53-A0E66FAF-4EE3460A-8FDE8A94-639109BA6342885DB5031489_see|text=|trigger=button}{sub-section}{sub-section:471DF4681805BF53-A0E66FAF-4EE3460A-8FDE8A94-639109BA6342885DB5031489_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:471DF4681805BF53-A0E66FAF-4EE3460A-8FDE8A94-639109BA6342885DB5031489_sam|text=|trigger=button}{sub-section}{sub-section:471DF4681805BF53-A0E66FAF-4EE3460A-8FDE8A94-639109BA6342885DB5031489_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=EEF08D837A0F1207-512D8AD6-4F2140A6-83D48110-7DC0CA70FE47F32FC30FB120}{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:EEF08D837A0F1207-512D8AD6-4F2140A6-83D48110-7DC0CA70FE47F32FC30FB120_des|text=|trigger=button}{sub-section}{sub-section:EEF08D837A0F1207-512D8AD6-4F2140A6-83D48110-7DC0CA70FE47F32FC30FB120_des|trigger=none|class=sIndent}Shows a directory selector dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:EEF08D837A0F1207-512D8AD6-4F2140A6-83D48110-7DC0CA70FE47F32FC30FB120_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EEF08D837A0F1207-512D8AD6-4F2140A6-83D48110-7DC0CA70FE47F32FC30FB120_prs|trigger=none}\[directory suggestion\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:EEF08D837A0F1207-512D8AD6-4F2140A6-83D48110-7DC0CA70FE47F32FC30FB120_ret|text=|trigger=button}{sub-section}{sub-section:EEF08D837A0F1207-512D8AD6-4F2140A6-83D48110-7DC0CA70FE47F32FC30FB120_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:EEF08D837A0F1207-512D8AD6-4F2140A6-83D48110-7DC0CA70FE47F32FC30FB120_see|text=|trigger=button}{sub-section}{sub-section:EEF08D837A0F1207-512D8AD6-4F2140A6-83D48110-7DC0CA70FE47F32FC30FB120_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:EEF08D837A0F1207-512D8AD6-4F2140A6-83D48110-7DC0CA70FE47F32FC30FB120_see|text=|trigger=button}{sub-section}{sub-section:EEF08D837A0F1207-512D8AD6-4F2140A6-83D48110-7DC0CA70FE47F32FC30FB120_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:EEF08D837A0F1207-512D8AD6-4F2140A6-83D48110-7DC0CA70FE47F32FC30FB120_sam|text=|trigger=button}{sub-section}{sub-section:EEF08D837A0F1207-512D8AD6-4F2140A6-83D48110-7DC0CA70FE47F32FC30FB120_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=28B16C9278C167C3-D5C8A033-44304DDA-BDA39937-C716EBCA52C554E5D8FA4646}{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:28B16C9278C167C3-D5C8A033-44304DDA-BDA39937-C716EBCA52C554E5D8FA4646_des|text=|trigger=button}{sub-section}{sub-section:28B16C9278C167C3-D5C8A033-44304DDA-BDA39937-C716EBCA52C554E5D8FA4646_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:28B16C9278C167C3-D5C8A033-44304DDA-BDA39937-C716EBCA52C554E5D8FA4646_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:28B16C9278C167C3-D5C8A033-44304DDA-BDA39937-C716EBCA52C554E5D8FA4646_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:28B16C9278C167C3-D5C8A033-44304DDA-BDA39937-C716EBCA52C554E5D8FA4646_ret|text=|trigger=button}{sub-section}{sub-section:28B16C9278C167C3-D5C8A033-44304DDA-BDA39937-C716EBCA52C554E5D8FA4646_ret|trigger=none|class=sIndent}Object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:28B16C9278C167C3-D5C8A033-44304DDA-BDA39937-C716EBCA52C554E5D8FA4646_see|text=|trigger=button}{sub-section}{sub-section:28B16C9278C167C3-D5C8A033-44304DDA-BDA39937-C716EBCA52C554E5D8FA4646_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:28B16C9278C167C3-D5C8A033-44304DDA-BDA39937-C716EBCA52C554E5D8FA4646_see|text=|trigger=button}{sub-section}{sub-section:28B16C9278C167C3-D5C8A033-44304DDA-BDA39937-C716EBCA52C554E5D8FA4646_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:28B16C9278C167C3-D5C8A033-44304DDA-BDA39937-C716EBCA52C554E5D8FA4646_sam|text=|trigger=button}{sub-section}{sub-section:28B16C9278C167C3-D5C8A033-44304DDA-BDA39937-C716EBCA52C554E5D8FA4646_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=9AB8AC49CF8EF8EE-8B0375F1-40E7445D-BB58B728-E8DA8E0FD193F83DE1CC5DB2}{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:9AB8AC49CF8EF8EE-8B0375F1-40E7445D-BB58B728-E8DA8E0FD193F83DE1CC5DB2_des|text=|trigger=button}{sub-section}{sub-section:9AB8AC49CF8EF8EE-8B0375F1-40E7445D-BB58B728-E8DA8E0FD193F83DE1CC5DB2_des|trigger=none|class=sIndent}Shows a file save dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:9AB8AC49CF8EF8EE-8B0375F1-40E7445D-BB58B728-E8DA8E0FD193F83DE1CC5DB2_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9AB8AC49CF8EF8EE-8B0375F1-40E7445D-BB58B728-E8DA8E0FD193F83DE1CC5DB2_prs|trigger=none}\[fileName/dir suggestion\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:9AB8AC49CF8EF8EE-8B0375F1-40E7445D-BB58B728-E8DA8E0FD193F83DE1CC5DB2_ret|text=|trigger=button}{sub-section}{sub-section:9AB8AC49CF8EF8EE-8B0375F1-40E7445D-BB58B728-E8DA8E0FD193F83DE1CC5DB2_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:9AB8AC49CF8EF8EE-8B0375F1-40E7445D-BB58B728-E8DA8E0FD193F83DE1CC5DB2_see|text=|trigger=button}{sub-section}{sub-section:9AB8AC49CF8EF8EE-8B0375F1-40E7445D-BB58B728-E8DA8E0FD193F83DE1CC5DB2_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9AB8AC49CF8EF8EE-8B0375F1-40E7445D-BB58B728-E8DA8E0FD193F83DE1CC5DB2_see|text=|trigger=button}{sub-section}{sub-section:9AB8AC49CF8EF8EE-8B0375F1-40E7445D-BB58B728-E8DA8E0FD193F83DE1CC5DB2_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9AB8AC49CF8EF8EE-8B0375F1-40E7445D-BB58B728-E8DA8E0FD193F83DE1CC5DB2_sam|text=|trigger=button}{sub-section}{sub-section:9AB8AC49CF8EF8EE-8B0375F1-40E7445D-BB58B728-E8DA8E0FD193F83DE1CC5DB2_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=DE060A02C3B77A44-6ACC5376-4E6C4CFE-AC8E9669-71ACC70D57235145F8AA56FC}{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:DE060A02C3B77A44-6ACC5376-4E6C4CFE-AC8E9669-71ACC70D57235145F8AA56FC_des|text=|trigger=button}{sub-section}{sub-section:DE060A02C3B77A44-6ACC5376-4E6C4CFE-AC8E9669-71ACC70D57235145F8AA56FC_des|trigger=none|class=sIndent}Writes data into a binary file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:DE060A02C3B77A44-6ACC5376-4E6C4CFE-AC8E9669-71ACC70D57235145F8AA56FC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DE060A02C3B77A44-6ACC5376-4E6C4CFE-AC8E9669-71ACC70D57235145F8AA56FC_prs|trigger=none}file
binary_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:DE060A02C3B77A44-6ACC5376-4E6C4CFE-AC8E9669-71ACC70D57235145F8AA56FC_ret|text=|trigger=button}{sub-section}{sub-section:DE060A02C3B77A44-6ACC5376-4E6C4CFE-AC8E9669-71ACC70D57235145F8AA56FC_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:DE060A02C3B77A44-6ACC5376-4E6C4CFE-AC8E9669-71ACC70D57235145F8AA56FC_see|text=|trigger=button}{sub-section}{sub-section:DE060A02C3B77A44-6ACC5376-4E6C4CFE-AC8E9669-71ACC70D57235145F8AA56FC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DE060A02C3B77A44-6ACC5376-4E6C4CFE-AC8E9669-71ACC70D57235145F8AA56FC_see|text=|trigger=button}{sub-section}{sub-section:DE060A02C3B77A44-6ACC5376-4E6C4CFE-AC8E9669-71ACC70D57235145F8AA56FC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DE060A02C3B77A44-6ACC5376-4E6C4CFE-AC8E9669-71ACC70D57235145F8AA56FC_sam|text=|trigger=button}{sub-section}{sub-section:DE060A02C3B77A44-6ACC5376-4E6C4CFE-AC8E9669-71ACC70D57235145F8AA56FC_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=FD433D5DF5BE021C-FC10E105-41E34681-8355960E-69A579C804F5EB258C5A1823}{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:FD433D5DF5BE021C-FC10E105-41E34681-8355960E-69A579C804F5EB258C5A1823_des|text=|trigger=button}{sub-section}{sub-section:FD433D5DF5BE021C-FC10E105-41E34681-8355960E-69A579C804F5EB258C5A1823_des|trigger=none|class=sIndent}Writes data into a text file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:FD433D5DF5BE021C-FC10E105-41E34681-8355960E-69A579C804F5EB258C5A1823_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FD433D5DF5BE021C-FC10E105-41E34681-8355960E-69A579C804F5EB258C5A1823_prs|trigger=none}file
text_data
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:FD433D5DF5BE021C-FC10E105-41E34681-8355960E-69A579C804F5EB258C5A1823_ret|text=|trigger=button}{sub-section}{sub-section:FD433D5DF5BE021C-FC10E105-41E34681-8355960E-69A579C804F5EB258C5A1823_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FD433D5DF5BE021C-FC10E105-41E34681-8355960E-69A579C804F5EB258C5A1823_see|text=|trigger=button}{sub-section}{sub-section:FD433D5DF5BE021C-FC10E105-41E34681-8355960E-69A579C804F5EB258C5A1823_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FD433D5DF5BE021C-FC10E105-41E34681-8355960E-69A579C804F5EB258C5A1823_see|text=|trigger=button}{sub-section}{sub-section:FD433D5DF5BE021C-FC10E105-41E34681-8355960E-69A579C804F5EB258C5A1823_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FD433D5DF5BE021C-FC10E105-41E34681-8355960E-69A579C804F5EB258C5A1823_sam|text=|trigger=button}{sub-section}{sub-section:FD433D5DF5BE021C-FC10E105-41E34681-8355960E-69A579C804F5EB258C5A1823_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=597B310E3DD1BA39-870BA0C5-40C74B71-9CCE9C59-AFE9E8829C8387E5C57873DE}{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:597B310E3DD1BA39-870BA0C5-40C74B71-9CCE9C59-AFE9E8829C8387E5C57873DE_des|text=|trigger=button}{sub-section}{sub-section:597B310E3DD1BA39-870BA0C5-40C74B71-9CCE9C59-AFE9E8829C8387E5C57873DE_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:597B310E3DD1BA39-870BA0C5-40C74B71-9CCE9C59-AFE9E8829C8387E5C57873DE_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:597B310E3DD1BA39-870BA0C5-40C74B71-9CCE9C59-AFE9E8829C8387E5C57873DE_prs|trigger=none}file
xml_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:597B310E3DD1BA39-870BA0C5-40C74B71-9CCE9C59-AFE9E8829C8387E5C57873DE_ret|text=|trigger=button}{sub-section}{sub-section:597B310E3DD1BA39-870BA0C5-40C74B71-9CCE9C59-AFE9E8829C8387E5C57873DE_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:597B310E3DD1BA39-870BA0C5-40C74B71-9CCE9C59-AFE9E8829C8387E5C57873DE_see|text=|trigger=button}{sub-section}{sub-section:597B310E3DD1BA39-870BA0C5-40C74B71-9CCE9C59-AFE9E8829C8387E5C57873DE_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:597B310E3DD1BA39-870BA0C5-40C74B71-9CCE9C59-AFE9E8829C8387E5C57873DE_see|text=|trigger=button}{sub-section}{sub-section:597B310E3DD1BA39-870BA0C5-40C74B71-9CCE9C59-AFE9E8829C8387E5C57873DE_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:597B310E3DD1BA39-870BA0C5-40C74B71-9CCE9C59-AFE9E8829C8387E5C57873DE_sam|text=|trigger=button}{sub-section}{sub-section:597B310E3DD1BA39-870BA0C5-40C74B71-9CCE9C59-AFE9E8829C8387E5C57873DE_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}