Servoy 7.x.x Documentation
Child pages
  • file

Versions Compared

Old Version 3

changes.mady.by.user Servoy Docs

Saved on

compared with

New Version 4

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=CADCF3B6DA7C6773-3D4A0538-495246BF-AC37AC9A-CA1B15363FFC1085D6A8D4AC}{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:CADCF3B6DA7C6773-3D4A0538-495246BF-AC37AC9A-CA1B15363FFC1085D6A8D4AC_des|text=|trigger=button}{sub-section}{sub-section:CADCF3B6DA7C6773-3D4A0538-495246BF-AC37AC9A-CA1B15363FFC1085D6A8D4AC_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:CADCF3B6DA7C6773-3D4A0538-495246BF-AC37AC9A-CA1B15363FFC1085D6A8D4AC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:CADCF3B6DA7C6773-3D4A0538-495246BF-AC37AC9A-CA1B15363FFC1085D6A8D4AC_prs|trigger=none}file
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:CADCF3B6DA7C6773-3D4A0538-495246BF-AC37AC9A-CA1B15363FFC1085D6A8D4AC_ret|text=|trigger=button}{sub-section}{sub-section:CADCF3B6DA7C6773-3D4A0538-495246BF-AC37AC9A-CA1B15363FFC1085D6A8D4AC_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:CADCF3B6DA7C6773-3D4A0538-495246BF-AC37AC9A-CA1B15363FFC1085D6A8D4AC_see|text=|trigger=button}{sub-section}{sub-section:CADCF3B6DA7C6773-3D4A0538-495246BF-AC37AC9A-CA1B15363FFC1085D6A8D4AC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:CADCF3B6DA7C6773-3D4A0538-495246BF-AC37AC9A-CA1B15363FFC1085D6A8D4AC_see|text=|trigger=button}{sub-section}{sub-section:CADCF3B6DA7C6773-3D4A0538-495246BF-AC37AC9A-CA1B15363FFC1085D6A8D4AC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:CADCF3B6DA7C6773-3D4A0538-495246BF-AC37AC9A-CA1B15363FFC1085D6A8D4AC_sam|text=|trigger=button}{sub-section}{sub-section:CADCF3B6DA7C6773-3D4A0538-495246BF-AC37AC9A-CA1B15363FFC1085D6A8D4AC_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=05485669A35ED659-13A9331D-4BAE4748-8977851C-6755C96EDF665A1EB9C423A2}{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:05485669A35ED659-13A9331D-4BAE4748-8977851C-6755C96EDF665A1EB9C423A2_des|text=|trigger=button}{sub-section}{sub-section:05485669A35ED659-13A9331D-4BAE4748-8977851C-6755C96EDF665A1EB9C423A2_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:05485669A35ED659-13A9331D-4BAE4748-8977851C-6755C96EDF665A1EB9C423A2_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:05485669A35ED659-13A9331D-4BAE4748-8977851C-6755C96EDF665A1EB9C423A2_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:05485669A35ED659-13A9331D-4BAE4748-8977851C-6755C96EDF665A1EB9C423A2_ret|text=|trigger=button}{sub-section}{sub-section:05485669A35ED659-13A9331D-4BAE4748-8977851C-6755C96EDF665A1EB9C423A2_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:05485669A35ED659-13A9331D-4BAE4748-8977851C-6755C96EDF665A1EB9C423A2_see|text=|trigger=button}{sub-section}{sub-section:05485669A35ED659-13A9331D-4BAE4748-8977851C-6755C96EDF665A1EB9C423A2_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:05485669A35ED659-13A9331D-4BAE4748-8977851C-6755C96EDF665A1EB9C423A2_see|text=|trigger=button}{sub-section}{sub-section:05485669A35ED659-13A9331D-4BAE4748-8977851C-6755C96EDF665A1EB9C423A2_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:05485669A35ED659-13A9331D-4BAE4748-8977851C-6755C96EDF665A1EB9C423A2_sam|text=|trigger=button}{sub-section}{sub-section:05485669A35ED659-13A9331D-4BAE4748-8977851C-6755C96EDF665A1EB9C423A2_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=597DCCE8F0BE16D4-9AEAB1FF-4F4243A2-835093B6-E71B70A540ADA7A69C58E3C6}{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:597DCCE8F0BE16D4-9AEAB1FF-4F4243A2-835093B6-E71B70A540ADA7A69C58E3C6_des|text=|trigger=button}{sub-section}{sub-section:597DCCE8F0BE16D4-9AEAB1FF-4F4243A2-835093B6-E71B70A540ADA7A69C58E3C6_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:597DCCE8F0BE16D4-9AEAB1FF-4F4243A2-835093B6-E71B70A540ADA7A69C58E3C6_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:597DCCE8F0BE16D4-9AEAB1FF-4F4243A2-835093B6-E71B70A540ADA7A69C58E3C6_prs|trigger=none}sourceFolder
destinationFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:597DCCE8F0BE16D4-9AEAB1FF-4F4243A2-835093B6-E71B70A540ADA7A69C58E3C6_ret|text=|trigger=button}{sub-section}{sub-section:597DCCE8F0BE16D4-9AEAB1FF-4F4243A2-835093B6-E71B70A540ADA7A69C58E3C6_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:597DCCE8F0BE16D4-9AEAB1FF-4F4243A2-835093B6-E71B70A540ADA7A69C58E3C6_see|text=|trigger=button}{sub-section}{sub-section:597DCCE8F0BE16D4-9AEAB1FF-4F4243A2-835093B6-E71B70A540ADA7A69C58E3C6_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:597DCCE8F0BE16D4-9AEAB1FF-4F4243A2-835093B6-E71B70A540ADA7A69C58E3C6_see|text=|trigger=button}{sub-section}{sub-section:597DCCE8F0BE16D4-9AEAB1FF-4F4243A2-835093B6-E71B70A540ADA7A69C58E3C6_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:597DCCE8F0BE16D4-9AEAB1FF-4F4243A2-835093B6-E71B70A540ADA7A69C58E3C6_sam|text=|trigger=button}{sub-section}{sub-section:597DCCE8F0BE16D4-9AEAB1FF-4F4243A2-835093B6-E71B70A540ADA7A69C58E3C6_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=5BEEF4BAD128E10A-81A3012C-456C41AA-8F859672-6352A8307FCC4A16F447CE13}{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:5BEEF4BAD128E10A-81A3012C-456C41AA-8F859672-6352A8307FCC4A16F447CE13_des|text=|trigger=button}{sub-section}{sub-section:5BEEF4BAD128E10A-81A3012C-456C41AA-8F859672-6352A8307FCC4A16F447CE13_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:5BEEF4BAD128E10A-81A3012C-456C41AA-8F859672-6352A8307FCC4A16F447CE13_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5BEEF4BAD128E10A-81A3012C-456C41AA-8F859672-6352A8307FCC4A16F447CE13_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:5BEEF4BAD128E10A-81A3012C-456C41AA-8F859672-6352A8307FCC4A16F447CE13_ret|text=|trigger=button}{sub-section}{sub-section:5BEEF4BAD128E10A-81A3012C-456C41AA-8F859672-6352A8307FCC4A16F447CE13_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:5BEEF4BAD128E10A-81A3012C-456C41AA-8F859672-6352A8307FCC4A16F447CE13_see|text=|trigger=button}{sub-section}{sub-section:5BEEF4BAD128E10A-81A3012C-456C41AA-8F859672-6352A8307FCC4A16F447CE13_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:5BEEF4BAD128E10A-81A3012C-456C41AA-8F859672-6352A8307FCC4A16F447CE13_see|text=|trigger=button}{sub-section}{sub-section:5BEEF4BAD128E10A-81A3012C-456C41AA-8F859672-6352A8307FCC4A16F447CE13_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:5BEEF4BAD128E10A-81A3012C-456C41AA-8F859672-6352A8307FCC4A16F447CE13_sam|text=|trigger=button}{sub-section}{sub-section:5BEEF4BAD128E10A-81A3012C-456C41AA-8F859672-6352A8307FCC4A16F447CE13_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=5ABC81F181D722DA-C393C4C3-4F7945FD-A844A65A-0F4EF08FF4910D3F5DD6EB23}{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:5ABC81F181D722DA-C393C4C3-4F7945FD-A844A65A-0F4EF08FF4910D3F5DD6EB23_des|text=|trigger=button}{sub-section}{sub-section:5ABC81F181D722DA-C393C4C3-4F7945FD-A844A65A-0F4EF08FF4910D3F5DD6EB23_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:5ABC81F181D722DA-C393C4C3-4F7945FD-A844A65A-0F4EF08FF4910D3F5DD6EB23_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5ABC81F181D722DA-C393C4C3-4F7945FD-A844A65A-0F4EF08FF4910D3F5DD6EB23_prs|trigger=none}targetFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:5ABC81F181D722DA-C393C4C3-4F7945FD-A844A65A-0F4EF08FF4910D3F5DD6EB23_ret|text=|trigger=button}{sub-section}{sub-section:5ABC81F181D722DA-C393C4C3-4F7945FD-A844A65A-0F4EF08FF4910D3F5DD6EB23_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:5ABC81F181D722DA-C393C4C3-4F7945FD-A844A65A-0F4EF08FF4910D3F5DD6EB23_see|text=|trigger=button}{sub-section}{sub-section:5ABC81F181D722DA-C393C4C3-4F7945FD-A844A65A-0F4EF08FF4910D3F5DD6EB23_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:5ABC81F181D722DA-C393C4C3-4F7945FD-A844A65A-0F4EF08FF4910D3F5DD6EB23_see|text=|trigger=button}{sub-section}{sub-section:5ABC81F181D722DA-C393C4C3-4F7945FD-A844A65A-0F4EF08FF4910D3F5DD6EB23_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:5ABC81F181D722DA-C393C4C3-4F7945FD-A844A65A-0F4EF08FF4910D3F5DD6EB23_sam|text=|trigger=button}{sub-section}{sub-section:5ABC81F181D722DA-C393C4C3-4F7945FD-A844A65A-0F4EF08FF4910D3F5DD6EB23_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=EC42B55A4BCCDA21-0BDDF0F2-4FCC4C78-AB8292F0-A7C8B993E6E72A76EACB70AD}{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:EC42B55A4BCCDA21-0BDDF0F2-4FCC4C78-AB8292F0-A7C8B993E6E72A76EACB70AD_des|text=|trigger=button}{sub-section}{sub-section:EC42B55A4BCCDA21-0BDDF0F2-4FCC4C78-AB8292F0-A7C8B993E6E72A76EACB70AD_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:EC42B55A4BCCDA21-0BDDF0F2-4FCC4C78-AB8292F0-A7C8B993E6E72A76EACB70AD_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EC42B55A4BCCDA21-0BDDF0F2-4FCC4C78-AB8292F0-A7C8B993E6E72A76EACB70AD_prs|trigger=none}filePrefix
fileSuffix
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:EC42B55A4BCCDA21-0BDDF0F2-4FCC4C78-AB8292F0-A7C8B993E6E72A76EACB70AD_ret|text=|trigger=button}{sub-section}{sub-section:EC42B55A4BCCDA21-0BDDF0F2-4FCC4C78-AB8292F0-A7C8B993E6E72A76EACB70AD_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:EC42B55A4BCCDA21-0BDDF0F2-4FCC4C78-AB8292F0-A7C8B993E6E72A76EACB70AD_see|text=|trigger=button}{sub-section}{sub-section:EC42B55A4BCCDA21-0BDDF0F2-4FCC4C78-AB8292F0-A7C8B993E6E72A76EACB70AD_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:EC42B55A4BCCDA21-0BDDF0F2-4FCC4C78-AB8292F0-A7C8B993E6E72A76EACB70AD_see|text=|trigger=button}{sub-section}{sub-section:EC42B55A4BCCDA21-0BDDF0F2-4FCC4C78-AB8292F0-A7C8B993E6E72A76EACB70AD_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:EC42B55A4BCCDA21-0BDDF0F2-4FCC4C78-AB8292F0-A7C8B993E6E72A76EACB70AD_sam|text=|trigger=button}{sub-section}{sub-section:EC42B55A4BCCDA21-0BDDF0F2-4FCC4C78-AB8292F0-A7C8B993E6E72A76EACB70AD_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=242C35AC5E774248-78DC3542-41004BCB-AA3E911A-E44BAAED52EE09835B6C2AB8}{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:242C35AC5E774248-78DC3542-41004BCB-AA3E911A-E44BAAED52EE09835B6C2AB8_des|text=|trigger=button}{sub-section}{sub-section:242C35AC5E774248-78DC3542-41004BCB-AA3E911A-E44BAAED52EE09835B6C2AB8_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:242C35AC5E774248-78DC3542-41004BCB-AA3E911A-E44BAAED52EE09835B6C2AB8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:242C35AC5E774248-78DC3542-41004BCB-AA3E911A-E44BAAED52EE09835B6C2AB8_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:242C35AC5E774248-78DC3542-41004BCB-AA3E911A-E44BAAED52EE09835B6C2AB8_ret|text=|trigger=button}{sub-section}{sub-section:242C35AC5E774248-78DC3542-41004BCB-AA3E911A-E44BAAED52EE09835B6C2AB8_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:242C35AC5E774248-78DC3542-41004BCB-AA3E911A-E44BAAED52EE09835B6C2AB8_see|text=|trigger=button}{sub-section}{sub-section:242C35AC5E774248-78DC3542-41004BCB-AA3E911A-E44BAAED52EE09835B6C2AB8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:242C35AC5E774248-78DC3542-41004BCB-AA3E911A-E44BAAED52EE09835B6C2AB8_see|text=|trigger=button}{sub-section}{sub-section:242C35AC5E774248-78DC3542-41004BCB-AA3E911A-E44BAAED52EE09835B6C2AB8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:242C35AC5E774248-78DC3542-41004BCB-AA3E911A-E44BAAED52EE09835B6C2AB8_sam|text=|trigger=button}{sub-section}{sub-section:242C35AC5E774248-78DC3542-41004BCB-AA3E911A-E44BAAED52EE09835B6C2AB8_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=FA7E94D79BF37AB3-61067877-47EC443A-8EF68379-7B5570ED1ECF7A0182632335}{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:FA7E94D79BF37AB3-61067877-47EC443A-8EF68379-7B5570ED1ECF7A0182632335_des|text=|trigger=button}{sub-section}{sub-section:FA7E94D79BF37AB3-61067877-47EC443A-8EF68379-7B5570ED1ECF7A0182632335_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:FA7E94D79BF37AB3-61067877-47EC443A-8EF68379-7B5570ED1ECF7A0182632335_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FA7E94D79BF37AB3-61067877-47EC443A-8EF68379-7B5570ED1ECF7A0182632335_prs|trigger=none}targetFolder
showWarning
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:FA7E94D79BF37AB3-61067877-47EC443A-8EF68379-7B5570ED1ECF7A0182632335_ret|text=|trigger=button}{sub-section}{sub-section:FA7E94D79BF37AB3-61067877-47EC443A-8EF68379-7B5570ED1ECF7A0182632335_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FA7E94D79BF37AB3-61067877-47EC443A-8EF68379-7B5570ED1ECF7A0182632335_see|text=|trigger=button}{sub-section}{sub-section:FA7E94D79BF37AB3-61067877-47EC443A-8EF68379-7B5570ED1ECF7A0182632335_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FA7E94D79BF37AB3-61067877-47EC443A-8EF68379-7B5570ED1ECF7A0182632335_see|text=|trigger=button}{sub-section}{sub-section:FA7E94D79BF37AB3-61067877-47EC443A-8EF68379-7B5570ED1ECF7A0182632335_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FA7E94D79BF37AB3-61067877-47EC443A-8EF68379-7B5570ED1ECF7A0182632335_sam|text=|trigger=button}{sub-section}{sub-section:FA7E94D79BF37AB3-61067877-47EC443A-8EF68379-7B5570ED1ECF7A0182632335_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=887CC54A7E715C78-73174119-431C4A88-90F2827A-F83F083C3B99632CCC21F50F}{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:887CC54A7E715C78-73174119-431C4A88-90F2827A-F83F083C3B99632CCC21F50F_des|text=|trigger=button}{sub-section}{sub-section:887CC54A7E715C78-73174119-431C4A88-90F2827A-F83F083C3B99632CCC21F50F_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:887CC54A7E715C78-73174119-431C4A88-90F2827A-F83F083C3B99632CCC21F50F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:887CC54A7E715C78-73174119-431C4A88-90F2827A-F83F083C3B99632CCC21F50F_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:887CC54A7E715C78-73174119-431C4A88-90F2827A-F83F083C3B99632CCC21F50F_ret|text=|trigger=button}{sub-section}{sub-section:887CC54A7E715C78-73174119-431C4A88-90F2827A-F83F083C3B99632CCC21F50F_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:887CC54A7E715C78-73174119-431C4A88-90F2827A-F83F083C3B99632CCC21F50F_see|text=|trigger=button}{sub-section}{sub-section:887CC54A7E715C78-73174119-431C4A88-90F2827A-F83F083C3B99632CCC21F50F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:887CC54A7E715C78-73174119-431C4A88-90F2827A-F83F083C3B99632CCC21F50F_see|text=|trigger=button}{sub-section}{sub-section:887CC54A7E715C78-73174119-431C4A88-90F2827A-F83F083C3B99632CCC21F50F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:887CC54A7E715C78-73174119-431C4A88-90F2827A-F83F083C3B99632CCC21F50F_sam|text=|trigger=button}{sub-section}{sub-section:887CC54A7E715C78-73174119-431C4A88-90F2827A-F83F083C3B99632CCC21F50F_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=19F3C4B1D39C2880-38DEA4F0-4CB64393-A920BB92-356F583E34C6F46DCA55E8B9}{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:19F3C4B1D39C2880-38DEA4F0-4CB64393-A920BB92-356F583E34C6F46DCA55E8B9_des|text=|trigger=button}{sub-section}{sub-section:19F3C4B1D39C2880-38DEA4F0-4CB64393-A920BB92-356F583E34C6F46DCA55E8B9_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:19F3C4B1D39C2880-38DEA4F0-4CB64393-A920BB92-356F583E34C6F46DCA55E8B9_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:19F3C4B1D39C2880-38DEA4F0-4CB64393-A920BB92-356F583E34C6F46DCA55E8B9_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:19F3C4B1D39C2880-38DEA4F0-4CB64393-A920BB92-356F583E34C6F46DCA55E8B9_ret|text=|trigger=button}{sub-section}{sub-section:19F3C4B1D39C2880-38DEA4F0-4CB64393-A920BB92-356F583E34C6F46DCA55E8B9_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:19F3C4B1D39C2880-38DEA4F0-4CB64393-A920BB92-356F583E34C6F46DCA55E8B9_see|text=|trigger=button}{sub-section}{sub-section:19F3C4B1D39C2880-38DEA4F0-4CB64393-A920BB92-356F583E34C6F46DCA55E8B9_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:19F3C4B1D39C2880-38DEA4F0-4CB64393-A920BB92-356F583E34C6F46DCA55E8B9_see|text=|trigger=button}{sub-section}{sub-section:19F3C4B1D39C2880-38DEA4F0-4CB64393-A920BB92-356F583E34C6F46DCA55E8B9_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:19F3C4B1D39C2880-38DEA4F0-4CB64393-A920BB92-356F583E34C6F46DCA55E8B9_sam|text=|trigger=button}{sub-section}{sub-section:19F3C4B1D39C2880-38DEA4F0-4CB64393-A920BB92-356F583E34C6F46DCA55E8B9_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=52B985E336AFE766-8DF2CA4A-4C284FD1-84EC816D-5038AAD0F9105803C424497B}{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:52B985E336AFE766-8DF2CA4A-4C284FD1-84EC816D-5038AAD0F9105803C424497B_des|text=|trigger=button}{sub-section}{sub-section:52B985E336AFE766-8DF2CA4A-4C284FD1-84EC816D-5038AAD0F9105803C424497B_des|trigger=none|class=sIndent}Returns the size of the specified file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:52B985E336AFE766-8DF2CA4A-4C284FD1-84EC816D-5038AAD0F9105803C424497B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:52B985E336AFE766-8DF2CA4A-4C284FD1-84EC816D-5038AAD0F9105803C424497B_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:52B985E336AFE766-8DF2CA4A-4C284FD1-84EC816D-5038AAD0F9105803C424497B_ret|text=|trigger=button}{sub-section}{sub-section:52B985E336AFE766-8DF2CA4A-4C284FD1-84EC816D-5038AAD0F9105803C424497B_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:52B985E336AFE766-8DF2CA4A-4C284FD1-84EC816D-5038AAD0F9105803C424497B_see|text=|trigger=button}{sub-section}{sub-section:52B985E336AFE766-8DF2CA4A-4C284FD1-84EC816D-5038AAD0F9105803C424497B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:52B985E336AFE766-8DF2CA4A-4C284FD1-84EC816D-5038AAD0F9105803C424497B_see|text=|trigger=button}{sub-section}{sub-section:52B985E336AFE766-8DF2CA4A-4C284FD1-84EC816D-5038AAD0F9105803C424497B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:52B985E336AFE766-8DF2CA4A-4C284FD1-84EC816D-5038AAD0F9105803C424497B_sam|text=|trigger=button}{sub-section}{sub-section:52B985E336AFE766-8DF2CA4A-4C284FD1-84EC816D-5038AAD0F9105803C424497B_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=EFCBE241D964432B-F42AD77E-49DD467B-A856A594-7D85C74DB3E5A574F154B960}{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:EFCBE241D964432B-F42AD77E-49DD467B-A856A594-7D85C74DB3E5A574F154B960_des|text=|trigger=button}{sub-section}{sub-section:EFCBE241D964432B-F42AD77E-49DD467B-A856A594-7D85C74DB3E5A574F154B960_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:EFCBE241D964432B-F42AD77E-49DD467B-A856A594-7D85C74DB3E5A574F154B960_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EFCBE241D964432B-F42AD77E-49DD467B-A856A594-7D85C74DB3E5A574F154B960_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:EFCBE241D964432B-F42AD77E-49DD467B-A856A594-7D85C74DB3E5A574F154B960_ret|text=|trigger=button}{sub-section}{sub-section:EFCBE241D964432B-F42AD77E-49DD467B-A856A594-7D85C74DB3E5A574F154B960_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:EFCBE241D964432B-F42AD77E-49DD467B-A856A594-7D85C74DB3E5A574F154B960_see|text=|trigger=button}{sub-section}{sub-section:EFCBE241D964432B-F42AD77E-49DD467B-A856A594-7D85C74DB3E5A574F154B960_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:EFCBE241D964432B-F42AD77E-49DD467B-A856A594-7D85C74DB3E5A574F154B960_see|text=|trigger=button}{sub-section}{sub-section:EFCBE241D964432B-F42AD77E-49DD467B-A856A594-7D85C74DB3E5A574F154B960_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:EFCBE241D964432B-F42AD77E-49DD467B-A856A594-7D85C74DB3E5A574F154B960_sam|text=|trigger=button}{sub-section}{sub-section:EFCBE241D964432B-F42AD77E-49DD467B-A856A594-7D85C74DB3E5A574F154B960_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=3B6CA53F0D379DE3-B740873A-400D40BD-8FF8BEF2-4872A3686BEC28684B431648}{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:3B6CA53F0D379DE3-B740873A-400D40BD-8FF8BEF2-4872A3686BEC28684B431648_des|text=|trigger=button}{sub-section}{sub-section:3B6CA53F0D379DE3-B740873A-400D40BD-8FF8BEF2-4872A3686BEC28684B431648_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:3B6CA53F0D379DE3-B740873A-400D40BD-8FF8BEF2-4872A3686BEC28684B431648_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3B6CA53F0D379DE3-B740873A-400D40BD-8FF8BEF2-4872A3686BEC28684B431648_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:3B6CA53F0D379DE3-B740873A-400D40BD-8FF8BEF2-4872A3686BEC28684B431648_ret|text=|trigger=button}{sub-section}{sub-section:3B6CA53F0D379DE3-B740873A-400D40BD-8FF8BEF2-4872A3686BEC28684B431648_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3B6CA53F0D379DE3-B740873A-400D40BD-8FF8BEF2-4872A3686BEC28684B431648_see|text=|trigger=button}{sub-section}{sub-section:3B6CA53F0D379DE3-B740873A-400D40BD-8FF8BEF2-4872A3686BEC28684B431648_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3B6CA53F0D379DE3-B740873A-400D40BD-8FF8BEF2-4872A3686BEC28684B431648_see|text=|trigger=button}{sub-section}{sub-section:3B6CA53F0D379DE3-B740873A-400D40BD-8FF8BEF2-4872A3686BEC28684B431648_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3B6CA53F0D379DE3-B740873A-400D40BD-8FF8BEF2-4872A3686BEC28684B431648_sam|text=|trigger=button}{sub-section}{sub-section:3B6CA53F0D379DE3-B740873A-400D40BD-8FF8BEF2-4872A3686BEC28684B431648_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=79A7BAF91D3701FC-5DAD1C92-418D4BDE-9F859345-0DA8C042CFB495476715905E}{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:79A7BAF91D3701FC-5DAD1C92-418D4BDE-9F859345-0DA8C042CFB495476715905E_des|text=|trigger=button}{sub-section}{sub-section:79A7BAF91D3701FC-5DAD1C92-418D4BDE-9F859345-0DA8C042CFB495476715905E_des|trigger=none|class=sIndent}Returns the modification date of a file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:79A7BAF91D3701FC-5DAD1C92-418D4BDE-9F859345-0DA8C042CFB495476715905E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:79A7BAF91D3701FC-5DAD1C92-418D4BDE-9F859345-0DA8C042CFB495476715905E_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:79A7BAF91D3701FC-5DAD1C92-418D4BDE-9F859345-0DA8C042CFB495476715905E_ret|text=|trigger=button}{sub-section}{sub-section:79A7BAF91D3701FC-5DAD1C92-418D4BDE-9F859345-0DA8C042CFB495476715905E_ret|trigger=none|class=sIndent}[Date]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:79A7BAF91D3701FC-5DAD1C92-418D4BDE-9F859345-0DA8C042CFB495476715905E_see|text=|trigger=button}{sub-section}{sub-section:79A7BAF91D3701FC-5DAD1C92-418D4BDE-9F859345-0DA8C042CFB495476715905E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:79A7BAF91D3701FC-5DAD1C92-418D4BDE-9F859345-0DA8C042CFB495476715905E_see|text=|trigger=button}{sub-section}{sub-section:79A7BAF91D3701FC-5DAD1C92-418D4BDE-9F859345-0DA8C042CFB495476715905E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:79A7BAF91D3701FC-5DAD1C92-418D4BDE-9F859345-0DA8C042CFB495476715905E_sam|text=|trigger=button}{sub-section}{sub-section:79A7BAF91D3701FC-5DAD1C92-418D4BDE-9F859345-0DA8C042CFB495476715905E_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=336EA3331D6F0A7B-FFF7B80C-4FC14855-937A8BDC-8CC2B3D1F4C1097BFA6DCCD2}{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:336EA3331D6F0A7B-FFF7B80C-4FC14855-937A8BDC-8CC2B3D1F4C1097BFA6DCCD2_des|text=|trigger=button}{sub-section}{sub-section:336EA3331D6F0A7B-FFF7B80C-4FC14855-937A8BDC-8CC2B3D1F4C1097BFA6DCCD2_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:336EA3331D6F0A7B-FFF7B80C-4FC14855-937A8BDC-8CC2B3D1F4C1097BFA6DCCD2_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:336EA3331D6F0A7B-FFF7B80C-4FC14855-937A8BDC-8CC2B3D1F4C1097BFA6DCCD2_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:336EA3331D6F0A7B-FFF7B80C-4FC14855-937A8BDC-8CC2B3D1F4C1097BFA6DCCD2_ret|text=|trigger=button}{sub-section}{sub-section:336EA3331D6F0A7B-FFF7B80C-4FC14855-937A8BDC-8CC2B3D1F4C1097BFA6DCCD2_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:336EA3331D6F0A7B-FFF7B80C-4FC14855-937A8BDC-8CC2B3D1F4C1097BFA6DCCD2_see|text=|trigger=button}{sub-section}{sub-section:336EA3331D6F0A7B-FFF7B80C-4FC14855-937A8BDC-8CC2B3D1F4C1097BFA6DCCD2_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:336EA3331D6F0A7B-FFF7B80C-4FC14855-937A8BDC-8CC2B3D1F4C1097BFA6DCCD2_see|text=|trigger=button}{sub-section}{sub-section:336EA3331D6F0A7B-FFF7B80C-4FC14855-937A8BDC-8CC2B3D1F4C1097BFA6DCCD2_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:336EA3331D6F0A7B-FFF7B80C-4FC14855-937A8BDC-8CC2B3D1F4C1097BFA6DCCD2_sam|text=|trigger=button}{sub-section}{sub-section:336EA3331D6F0A7B-FFF7B80C-4FC14855-937A8BDC-8CC2B3D1F4C1097BFA6DCCD2_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=9FF3ECF571DCD5E7-348F42B1-48D84713-A0798D4D-A95A7D5D526B38B28D199BF3}{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:9FF3ECF571DCD5E7-348F42B1-48D84713-A0798D4D-A95A7D5D526B38B28D199BF3_des|text=|trigger=button}{sub-section}{sub-section:9FF3ECF571DCD5E7-348F42B1-48D84713-A0798D4D-A95A7D5D526B38B28D199BF3_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:9FF3ECF571DCD5E7-348F42B1-48D84713-A0798D4D-A95A7D5D526B38B28D199BF3_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9FF3ECF571DCD5E7-348F42B1-48D84713-A0798D4D-A95A7D5D526B38B28D199BF3_prs|trigger=none}\[file\]
\[size\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:9FF3ECF571DCD5E7-348F42B1-48D84713-A0798D4D-A95A7D5D526B38B28D199BF3_ret|text=|trigger=button}{sub-section}{sub-section:9FF3ECF571DCD5E7-348F42B1-48D84713-A0798D4D-A95A7D5D526B38B28D199BF3_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:9FF3ECF571DCD5E7-348F42B1-48D84713-A0798D4D-A95A7D5D526B38B28D199BF3_see|text=|trigger=button}{sub-section}{sub-section:9FF3ECF571DCD5E7-348F42B1-48D84713-A0798D4D-A95A7D5D526B38B28D199BF3_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9FF3ECF571DCD5E7-348F42B1-48D84713-A0798D4D-A95A7D5D526B38B28D199BF3_see|text=|trigger=button}{sub-section}{sub-section:9FF3ECF571DCD5E7-348F42B1-48D84713-A0798D4D-A95A7D5D526B38B28D199BF3_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9FF3ECF571DCD5E7-348F42B1-48D84713-A0798D4D-A95A7D5D526B38B28D199BF3_sam|text=|trigger=button}{sub-section}{sub-section:9FF3ECF571DCD5E7-348F42B1-48D84713-A0798D4D-A95A7D5D526B38B28D199BF3_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=C430EA34FB29158F-0C0ADB11-4B2B4172-B03ABFC8-0806F5F90701178D746ACB1C}{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:C430EA34FB29158F-0C0ADB11-4B2B4172-B03ABFC8-0806F5F90701178D746ACB1C_des|text=|trigger=button}{sub-section}{sub-section:C430EA34FB29158F-0C0ADB11-4B2B4172-B03ABFC8-0806F5F90701178D746ACB1C_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:C430EA34FB29158F-0C0ADB11-4B2B4172-B03ABFC8-0806F5F90701178D746ACB1C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C430EA34FB29158F-0C0ADB11-4B2B4172-B03ABFC8-0806F5F90701178D746ACB1C_prs|trigger=none}\[file\]
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C430EA34FB29158F-0C0ADB11-4B2B4172-B03ABFC8-0806F5F90701178D746ACB1C_ret|text=|trigger=button}{sub-section}{sub-section:C430EA34FB29158F-0C0ADB11-4B2B4172-B03ABFC8-0806F5F90701178D746ACB1C_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C430EA34FB29158F-0C0ADB11-4B2B4172-B03ABFC8-0806F5F90701178D746ACB1C_see|text=|trigger=button}{sub-section}{sub-section:C430EA34FB29158F-0C0ADB11-4B2B4172-B03ABFC8-0806F5F90701178D746ACB1C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C430EA34FB29158F-0C0ADB11-4B2B4172-B03ABFC8-0806F5F90701178D746ACB1C_see|text=|trigger=button}{sub-section}{sub-section:C430EA34FB29158F-0C0ADB11-4B2B4172-B03ABFC8-0806F5F90701178D746ACB1C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C430EA34FB29158F-0C0ADB11-4B2B4172-B03ABFC8-0806F5F90701178D746ACB1C_sam|text=|trigger=button}{sub-section}{sub-section:C430EA34FB29158F-0C0ADB11-4B2B4172-B03ABFC8-0806F5F90701178D746ACB1C_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=251D63FB3EAD6483-A4AA853F-46084734-912190A0-ACBC8E75827DB6309CC7F8F6}{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:251D63FB3EAD6483-A4AA853F-46084734-912190A0-ACBC8E75827DB6309CC7F8F6_des|text=|trigger=button}{sub-section}{sub-section:251D63FB3EAD6483-A4AA853F-46084734-912190A0-ACBC8E75827DB6309CC7F8F6_des|trigger=none|class=sIndent}Shows a directory selector dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:251D63FB3EAD6483-A4AA853F-46084734-912190A0-ACBC8E75827DB6309CC7F8F6_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:251D63FB3EAD6483-A4AA853F-46084734-912190A0-ACBC8E75827DB6309CC7F8F6_prs|trigger=none}\[directory suggestion\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:251D63FB3EAD6483-A4AA853F-46084734-912190A0-ACBC8E75827DB6309CC7F8F6_ret|text=|trigger=button}{sub-section}{sub-section:251D63FB3EAD6483-A4AA853F-46084734-912190A0-ACBC8E75827DB6309CC7F8F6_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:251D63FB3EAD6483-A4AA853F-46084734-912190A0-ACBC8E75827DB6309CC7F8F6_see|text=|trigger=button}{sub-section}{sub-section:251D63FB3EAD6483-A4AA853F-46084734-912190A0-ACBC8E75827DB6309CC7F8F6_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:251D63FB3EAD6483-A4AA853F-46084734-912190A0-ACBC8E75827DB6309CC7F8F6_see|text=|trigger=button}{sub-section}{sub-section:251D63FB3EAD6483-A4AA853F-46084734-912190A0-ACBC8E75827DB6309CC7F8F6_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:251D63FB3EAD6483-A4AA853F-46084734-912190A0-ACBC8E75827DB6309CC7F8F6_sam|text=|trigger=button}{sub-section}{sub-section:251D63FB3EAD6483-A4AA853F-46084734-912190A0-ACBC8E75827DB6309CC7F8F6_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=CA2ED4790C47563A-9406D603-4A49417F-880AB058-9B58AF827B2C94F4466AB87E}{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:CA2ED4790C47563A-9406D603-4A49417F-880AB058-9B58AF827B2C94F4466AB87E_des|text=|trigger=button}{sub-section}{sub-section:CA2ED4790C47563A-9406D603-4A49417F-880AB058-9B58AF827B2C94F4466AB87E_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:CA2ED4790C47563A-9406D603-4A49417F-880AB058-9B58AF827B2C94F4466AB87E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:CA2ED4790C47563A-9406D603-4A49417F-880AB058-9B58AF827B2C94F4466AB87E_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:CA2ED4790C47563A-9406D603-4A49417F-880AB058-9B58AF827B2C94F4466AB87E_ret|text=|trigger=button}{sub-section}{sub-section:CA2ED4790C47563A-9406D603-4A49417F-880AB058-9B58AF827B2C94F4466AB87E_ret|trigger=none|class=sIndent}Object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:CA2ED4790C47563A-9406D603-4A49417F-880AB058-9B58AF827B2C94F4466AB87E_see|text=|trigger=button}{sub-section}{sub-section:CA2ED4790C47563A-9406D603-4A49417F-880AB058-9B58AF827B2C94F4466AB87E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:CA2ED4790C47563A-9406D603-4A49417F-880AB058-9B58AF827B2C94F4466AB87E_see|text=|trigger=button}{sub-section}{sub-section:CA2ED4790C47563A-9406D603-4A49417F-880AB058-9B58AF827B2C94F4466AB87E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:CA2ED4790C47563A-9406D603-4A49417F-880AB058-9B58AF827B2C94F4466AB87E_sam|text=|trigger=button}{sub-section}{sub-section:CA2ED4790C47563A-9406D603-4A49417F-880AB058-9B58AF827B2C94F4466AB87E_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=D05C8E7A2D2ADC0C-872FD53A-40ED4C89-AA80B71C-00D76D09BE2C74AD8F30604C}{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:D05C8E7A2D2ADC0C-872FD53A-40ED4C89-AA80B71C-00D76D09BE2C74AD8F30604C_des|text=|trigger=button}{sub-section}{sub-section:D05C8E7A2D2ADC0C-872FD53A-40ED4C89-AA80B71C-00D76D09BE2C74AD8F30604C_des|trigger=none|class=sIndent}Shows a file save dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:D05C8E7A2D2ADC0C-872FD53A-40ED4C89-AA80B71C-00D76D09BE2C74AD8F30604C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D05C8E7A2D2ADC0C-872FD53A-40ED4C89-AA80B71C-00D76D09BE2C74AD8F30604C_prs|trigger=none}\[fileName/dir suggestion\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:D05C8E7A2D2ADC0C-872FD53A-40ED4C89-AA80B71C-00D76D09BE2C74AD8F30604C_ret|text=|trigger=button}{sub-section}{sub-section:D05C8E7A2D2ADC0C-872FD53A-40ED4C89-AA80B71C-00D76D09BE2C74AD8F30604C_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D05C8E7A2D2ADC0C-872FD53A-40ED4C89-AA80B71C-00D76D09BE2C74AD8F30604C_see|text=|trigger=button}{sub-section}{sub-section:D05C8E7A2D2ADC0C-872FD53A-40ED4C89-AA80B71C-00D76D09BE2C74AD8F30604C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D05C8E7A2D2ADC0C-872FD53A-40ED4C89-AA80B71C-00D76D09BE2C74AD8F30604C_see|text=|trigger=button}{sub-section}{sub-section:D05C8E7A2D2ADC0C-872FD53A-40ED4C89-AA80B71C-00D76D09BE2C74AD8F30604C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D05C8E7A2D2ADC0C-872FD53A-40ED4C89-AA80B71C-00D76D09BE2C74AD8F30604C_sam|text=|trigger=button}{sub-section}{sub-section:D05C8E7A2D2ADC0C-872FD53A-40ED4C89-AA80B71C-00D76D09BE2C74AD8F30604C_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=FA26FE6933D38C34-AE50F09D-45F240FE-A10E8C4F-7BC480C73BBA191BCF5CC20E}{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:FA26FE6933D38C34-AE50F09D-45F240FE-A10E8C4F-7BC480C73BBA191BCF5CC20E_des|text=|trigger=button}{sub-section}{sub-section:FA26FE6933D38C34-AE50F09D-45F240FE-A10E8C4F-7BC480C73BBA191BCF5CC20E_des|trigger=none|class=sIndent}Writes data into a binary file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:FA26FE6933D38C34-AE50F09D-45F240FE-A10E8C4F-7BC480C73BBA191BCF5CC20E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FA26FE6933D38C34-AE50F09D-45F240FE-A10E8C4F-7BC480C73BBA191BCF5CC20E_prs|trigger=none}file
binary_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:FA26FE6933D38C34-AE50F09D-45F240FE-A10E8C4F-7BC480C73BBA191BCF5CC20E_ret|text=|trigger=button}{sub-section}{sub-section:FA26FE6933D38C34-AE50F09D-45F240FE-A10E8C4F-7BC480C73BBA191BCF5CC20E_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FA26FE6933D38C34-AE50F09D-45F240FE-A10E8C4F-7BC480C73BBA191BCF5CC20E_see|text=|trigger=button}{sub-section}{sub-section:FA26FE6933D38C34-AE50F09D-45F240FE-A10E8C4F-7BC480C73BBA191BCF5CC20E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FA26FE6933D38C34-AE50F09D-45F240FE-A10E8C4F-7BC480C73BBA191BCF5CC20E_see|text=|trigger=button}{sub-section}{sub-section:FA26FE6933D38C34-AE50F09D-45F240FE-A10E8C4F-7BC480C73BBA191BCF5CC20E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FA26FE6933D38C34-AE50F09D-45F240FE-A10E8C4F-7BC480C73BBA191BCF5CC20E_sam|text=|trigger=button}{sub-section}{sub-section:FA26FE6933D38C34-AE50F09D-45F240FE-A10E8C4F-7BC480C73BBA191BCF5CC20E_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=75A539A01CFAFED1-4EA0BADC-47D14CBD-BAB1A593-36264897C1AD813C00057AB5}{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:75A539A01CFAFED1-4EA0BADC-47D14CBD-BAB1A593-36264897C1AD813C00057AB5_des|text=|trigger=button}{sub-section}{sub-section:75A539A01CFAFED1-4EA0BADC-47D14CBD-BAB1A593-36264897C1AD813C00057AB5_des|trigger=none|class=sIndent}Writes data into a text file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:75A539A01CFAFED1-4EA0BADC-47D14CBD-BAB1A593-36264897C1AD813C00057AB5_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:75A539A01CFAFED1-4EA0BADC-47D14CBD-BAB1A593-36264897C1AD813C00057AB5_prs|trigger=none}file
text_data
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:75A539A01CFAFED1-4EA0BADC-47D14CBD-BAB1A593-36264897C1AD813C00057AB5_ret|text=|trigger=button}{sub-section}{sub-section:75A539A01CFAFED1-4EA0BADC-47D14CBD-BAB1A593-36264897C1AD813C00057AB5_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:75A539A01CFAFED1-4EA0BADC-47D14CBD-BAB1A593-36264897C1AD813C00057AB5_see|text=|trigger=button}{sub-section}{sub-section:75A539A01CFAFED1-4EA0BADC-47D14CBD-BAB1A593-36264897C1AD813C00057AB5_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:75A539A01CFAFED1-4EA0BADC-47D14CBD-BAB1A593-36264897C1AD813C00057AB5_see|text=|trigger=button}{sub-section}{sub-section:75A539A01CFAFED1-4EA0BADC-47D14CBD-BAB1A593-36264897C1AD813C00057AB5_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:75A539A01CFAFED1-4EA0BADC-47D14CBD-BAB1A593-36264897C1AD813C00057AB5_sam|text=|trigger=button}{sub-section}{sub-section:75A539A01CFAFED1-4EA0BADC-47D14CBD-BAB1A593-36264897C1AD813C00057AB5_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=585DEDD6AE7BAFA3-15E1B29A-46C34CBB-9F30AB0E-06D8195505CC6DB0309D174D}{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:585DEDD6AE7BAFA3-15E1B29A-46C34CBB-9F30AB0E-06D8195505CC6DB0309D174D_des|text=|trigger=button}{sub-section}{sub-section:585DEDD6AE7BAFA3-15E1B29A-46C34CBB-9F30AB0E-06D8195505CC6DB0309D174D_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:585DEDD6AE7BAFA3-15E1B29A-46C34CBB-9F30AB0E-06D8195505CC6DB0309D174D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:585DEDD6AE7BAFA3-15E1B29A-46C34CBB-9F30AB0E-06D8195505CC6DB0309D174D_prs|trigger=none}file
xml_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:585DEDD6AE7BAFA3-15E1B29A-46C34CBB-9F30AB0E-06D8195505CC6DB0309D174D_ret|text=|trigger=button}{sub-section}{sub-section:585DEDD6AE7BAFA3-15E1B29A-46C34CBB-9F30AB0E-06D8195505CC6DB0309D174D_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:585DEDD6AE7BAFA3-15E1B29A-46C34CBB-9F30AB0E-06D8195505CC6DB0309D174D_see|text=|trigger=button}{sub-section}{sub-section:585DEDD6AE7BAFA3-15E1B29A-46C34CBB-9F30AB0E-06D8195505CC6DB0309D174D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:585DEDD6AE7BAFA3-15E1B29A-46C34CBB-9F30AB0E-06D8195505CC6DB0309D174D_see|text=|trigger=button}{sub-section}{sub-section:585DEDD6AE7BAFA3-15E1B29A-46C34CBB-9F30AB0E-06D8195505CC6DB0309D174D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:585DEDD6AE7BAFA3-15E1B29A-46C34CBB-9F30AB0E-06D8195505CC6DB0309D174D_sam|text=|trigger=button}{sub-section}{sub-section:585DEDD6AE7BAFA3-15E1B29A-46C34CBB-9F30AB0E-06D8195505CC6DB0309D174D_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}