Servoy 7.x.x Documentation
Child pages
  • file

Versions Compared

Old Version 10

changes.mady.by.user Servoy Docs

Saved on

compared with

New Version 11

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, dialog title text)
Shows a directory selector dialog.{td}{tr}{tbody}{tbody}{tr}{td}Object{td}{td}[#showFileOpenDialog]\(selectionMode(0=both,1=Files,2=Dirs), startDirectory(null=default/previous), multiselect(true/false), filterarray, callbackmethod, dialog title text)
Shows a file open dialog.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#showFileSaveDialog]\(fileName/dir suggestion, dialog title text)
Shows a file save dialog.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{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=3EC9EACBDCD3BC00-496215AD-44E0423D-A55AADE4-21D2199B77D3A880FFDB72F1}{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:3EC9EACBDCD3BC00-496215AD-44E0423D-A55AADE4-21D2199B77D3A880FFDB72F1_des|text=|trigger=button}{sub-section}{sub-section:3EC9EACBDCD3BC00-496215AD-44E0423D-A55AADE4-21D2199B77D3A880FFDB72F1_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:3EC9EACBDCD3BC00-496215AD-44E0423D-A55AADE4-21D2199B77D3A880FFDB72F1_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3EC9EACBDCD3BC00-496215AD-44E0423D-A55AADE4-21D2199B77D3A880FFDB72F1_prs|trigger=none}file
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:3EC9EACBDCD3BC00-496215AD-44E0423D-A55AADE4-21D2199B77D3A880FFDB72F1_ret|text=|trigger=button}{sub-section}{sub-section:3EC9EACBDCD3BC00-496215AD-44E0423D-A55AADE4-21D2199B77D3A880FFDB72F1_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3EC9EACBDCD3BC00-496215AD-44E0423D-A55AADE4-21D2199B77D3A880FFDB72F1_see|text=|trigger=button}{sub-section}{sub-section:3EC9EACBDCD3BC00-496215AD-44E0423D-A55AADE4-21D2199B77D3A880FFDB72F1_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3EC9EACBDCD3BC00-496215AD-44E0423D-A55AADE4-21D2199B77D3A880FFDB72F1_see|text=|trigger=button}{sub-section}{sub-section:3EC9EACBDCD3BC00-496215AD-44E0423D-A55AADE4-21D2199B77D3A880FFDB72F1_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3EC9EACBDCD3BC00-496215AD-44E0423D-A55AADE4-21D2199B77D3A880FFDB72F1_sam|text=|trigger=button}{sub-section}{sub-section:3EC9EACBDCD3BC00-496215AD-44E0423D-A55AADE4-21D2199B77D3A880FFDB72F1_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=98FBB2EB621134E9-64A6532C-40C54DCC-A6A6B67C-727FD45C45C574767680F449}{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:98FBB2EB621134E9-64A6532C-40C54DCC-A6A6B67C-727FD45C45C574767680F449_des|text=|trigger=button}{sub-section}{sub-section:98FBB2EB621134E9-64A6532C-40C54DCC-A6A6B67C-727FD45C45C574767680F449_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:98FBB2EB621134E9-64A6532C-40C54DCC-A6A6B67C-727FD45C45C574767680F449_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:98FBB2EB621134E9-64A6532C-40C54DCC-A6A6B67C-727FD45C45C574767680F449_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:98FBB2EB621134E9-64A6532C-40C54DCC-A6A6B67C-727FD45C45C574767680F449_ret|text=|trigger=button}{sub-section}{sub-section:98FBB2EB621134E9-64A6532C-40C54DCC-A6A6B67C-727FD45C45C574767680F449_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:98FBB2EB621134E9-64A6532C-40C54DCC-A6A6B67C-727FD45C45C574767680F449_see|text=|trigger=button}{sub-section}{sub-section:98FBB2EB621134E9-64A6532C-40C54DCC-A6A6B67C-727FD45C45C574767680F449_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:98FBB2EB621134E9-64A6532C-40C54DCC-A6A6B67C-727FD45C45C574767680F449_see|text=|trigger=button}{sub-section}{sub-section:98FBB2EB621134E9-64A6532C-40C54DCC-A6A6B67C-727FD45C45C574767680F449_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:98FBB2EB621134E9-64A6532C-40C54DCC-A6A6B67C-727FD45C45C574767680F449_sam|text=|trigger=button}{sub-section}{sub-section:98FBB2EB621134E9-64A6532C-40C54DCC-A6A6B67C-727FD45C45C574767680F449_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=09893269C05E28FA-CA7F23C3-4C694D7E-86A78F94-8D371CED61ADAEAE44DBF082}{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:09893269C05E28FA-CA7F23C3-4C694D7E-86A78F94-8D371CED61ADAEAE44DBF082_des|text=|trigger=button}{sub-section}{sub-section:09893269C05E28FA-CA7F23C3-4C694D7E-86A78F94-8D371CED61ADAEAE44DBF082_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:09893269C05E28FA-CA7F23C3-4C694D7E-86A78F94-8D371CED61ADAEAE44DBF082_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:09893269C05E28FA-CA7F23C3-4C694D7E-86A78F94-8D371CED61ADAEAE44DBF082_prs|trigger=none}sourceFolder
destinationFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:09893269C05E28FA-CA7F23C3-4C694D7E-86A78F94-8D371CED61ADAEAE44DBF082_ret|text=|trigger=button}{sub-section}{sub-section:09893269C05E28FA-CA7F23C3-4C694D7E-86A78F94-8D371CED61ADAEAE44DBF082_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:09893269C05E28FA-CA7F23C3-4C694D7E-86A78F94-8D371CED61ADAEAE44DBF082_see|text=|trigger=button}{sub-section}{sub-section:09893269C05E28FA-CA7F23C3-4C694D7E-86A78F94-8D371CED61ADAEAE44DBF082_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:09893269C05E28FA-CA7F23C3-4C694D7E-86A78F94-8D371CED61ADAEAE44DBF082_see|text=|trigger=button}{sub-section}{sub-section:09893269C05E28FA-CA7F23C3-4C694D7E-86A78F94-8D371CED61ADAEAE44DBF082_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:09893269C05E28FA-CA7F23C3-4C694D7E-86A78F94-8D371CED61ADAEAE44DBF082_sam|text=|trigger=button}{sub-section}{sub-section:09893269C05E28FA-CA7F23C3-4C694D7E-86A78F94-8D371CED61ADAEAE44DBF082_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=C1B8DA6692E77024-2496CC2C-492D4DD0-89009F95-DC40116709004D571A7C97F5}{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:C1B8DA6692E77024-2496CC2C-492D4DD0-89009F95-DC40116709004D571A7C97F5_des|text=|trigger=button}{sub-section}{sub-section:C1B8DA6692E77024-2496CC2C-492D4DD0-89009F95-DC40116709004D571A7C97F5_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:C1B8DA6692E77024-2496CC2C-492D4DD0-89009F95-DC40116709004D571A7C97F5_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C1B8DA6692E77024-2496CC2C-492D4DD0-89009F95-DC40116709004D571A7C97F5_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C1B8DA6692E77024-2496CC2C-492D4DD0-89009F95-DC40116709004D571A7C97F5_ret|text=|trigger=button}{sub-section}{sub-section:C1B8DA6692E77024-2496CC2C-492D4DD0-89009F95-DC40116709004D571A7C97F5_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C1B8DA6692E77024-2496CC2C-492D4DD0-89009F95-DC40116709004D571A7C97F5_see|text=|trigger=button}{sub-section}{sub-section:C1B8DA6692E77024-2496CC2C-492D4DD0-89009F95-DC40116709004D571A7C97F5_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C1B8DA6692E77024-2496CC2C-492D4DD0-89009F95-DC40116709004D571A7C97F5_see|text=|trigger=button}{sub-section}{sub-section:C1B8DA6692E77024-2496CC2C-492D4DD0-89009F95-DC40116709004D571A7C97F5_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C1B8DA6692E77024-2496CC2C-492D4DD0-89009F95-DC40116709004D571A7C97F5_sam|text=|trigger=button}{sub-section}{sub-section:C1B8DA6692E77024-2496CC2C-492D4DD0-89009F95-DC40116709004D571A7C97F5_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=43AA19032B131F75-00BA7D26-480449C9-83CC8654-AD45867D70A9468089DC9776}{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:43AA19032B131F75-00BA7D26-480449C9-83CC8654-AD45867D70A9468089DC9776_des|text=|trigger=button}{sub-section}{sub-section:43AA19032B131F75-00BA7D26-480449C9-83CC8654-AD45867D70A9468089DC9776_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:43AA19032B131F75-00BA7D26-480449C9-83CC8654-AD45867D70A9468089DC9776_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:43AA19032B131F75-00BA7D26-480449C9-83CC8654-AD45867D70A9468089DC9776_prs|trigger=none}targetFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:43AA19032B131F75-00BA7D26-480449C9-83CC8654-AD45867D70A9468089DC9776_ret|text=|trigger=button}{sub-section}{sub-section:43AA19032B131F75-00BA7D26-480449C9-83CC8654-AD45867D70A9468089DC9776_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:43AA19032B131F75-00BA7D26-480449C9-83CC8654-AD45867D70A9468089DC9776_see|text=|trigger=button}{sub-section}{sub-section:43AA19032B131F75-00BA7D26-480449C9-83CC8654-AD45867D70A9468089DC9776_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:43AA19032B131F75-00BA7D26-480449C9-83CC8654-AD45867D70A9468089DC9776_see|text=|trigger=button}{sub-section}{sub-section:43AA19032B131F75-00BA7D26-480449C9-83CC8654-AD45867D70A9468089DC9776_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:43AA19032B131F75-00BA7D26-480449C9-83CC8654-AD45867D70A9468089DC9776_sam|text=|trigger=button}{sub-section}{sub-section:43AA19032B131F75-00BA7D26-480449C9-83CC8654-AD45867D70A9468089DC9776_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=7C4D4AF314068D80-D6B13482-4E1C476E-9A33A5A8-93D7941E37BCA708FCA496EF}{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:7C4D4AF314068D80-D6B13482-4E1C476E-9A33A5A8-93D7941E37BCA708FCA496EF_des|text=|trigger=button}{sub-section}{sub-section:7C4D4AF314068D80-D6B13482-4E1C476E-9A33A5A8-93D7941E37BCA708FCA496EF_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:7C4D4AF314068D80-D6B13482-4E1C476E-9A33A5A8-93D7941E37BCA708FCA496EF_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7C4D4AF314068D80-D6B13482-4E1C476E-9A33A5A8-93D7941E37BCA708FCA496EF_prs|trigger=none}filePrefix
fileSuffix
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:7C4D4AF314068D80-D6B13482-4E1C476E-9A33A5A8-93D7941E37BCA708FCA496EF_ret|text=|trigger=button}{sub-section}{sub-section:7C4D4AF314068D80-D6B13482-4E1C476E-9A33A5A8-93D7941E37BCA708FCA496EF_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:7C4D4AF314068D80-D6B13482-4E1C476E-9A33A5A8-93D7941E37BCA708FCA496EF_see|text=|trigger=button}{sub-section}{sub-section:7C4D4AF314068D80-D6B13482-4E1C476E-9A33A5A8-93D7941E37BCA708FCA496EF_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:7C4D4AF314068D80-D6B13482-4E1C476E-9A33A5A8-93D7941E37BCA708FCA496EF_see|text=|trigger=button}{sub-section}{sub-section:7C4D4AF314068D80-D6B13482-4E1C476E-9A33A5A8-93D7941E37BCA708FCA496EF_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:7C4D4AF314068D80-D6B13482-4E1C476E-9A33A5A8-93D7941E37BCA708FCA496EF_sam|text=|trigger=button}{sub-section}{sub-section:7C4D4AF314068D80-D6B13482-4E1C476E-9A33A5A8-93D7941E37BCA708FCA496EF_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=BFFA5DB2BA4D2870-0CB437A9-461A4B11-82C2B6B9-C5B46EB107F8B78269328F0D}{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:BFFA5DB2BA4D2870-0CB437A9-461A4B11-82C2B6B9-C5B46EB107F8B78269328F0D_des|text=|trigger=button}{sub-section}{sub-section:BFFA5DB2BA4D2870-0CB437A9-461A4B11-82C2B6B9-C5B46EB107F8B78269328F0D_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:BFFA5DB2BA4D2870-0CB437A9-461A4B11-82C2B6B9-C5B46EB107F8B78269328F0D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BFFA5DB2BA4D2870-0CB437A9-461A4B11-82C2B6B9-C5B46EB107F8B78269328F0D_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:BFFA5DB2BA4D2870-0CB437A9-461A4B11-82C2B6B9-C5B46EB107F8B78269328F0D_ret|text=|trigger=button}{sub-section}{sub-section:BFFA5DB2BA4D2870-0CB437A9-461A4B11-82C2B6B9-C5B46EB107F8B78269328F0D_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BFFA5DB2BA4D2870-0CB437A9-461A4B11-82C2B6B9-C5B46EB107F8B78269328F0D_see|text=|trigger=button}{sub-section}{sub-section:BFFA5DB2BA4D2870-0CB437A9-461A4B11-82C2B6B9-C5B46EB107F8B78269328F0D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BFFA5DB2BA4D2870-0CB437A9-461A4B11-82C2B6B9-C5B46EB107F8B78269328F0D_see|text=|trigger=button}{sub-section}{sub-section:BFFA5DB2BA4D2870-0CB437A9-461A4B11-82C2B6B9-C5B46EB107F8B78269328F0D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BFFA5DB2BA4D2870-0CB437A9-461A4B11-82C2B6B9-C5B46EB107F8B78269328F0D_sam|text=|trigger=button}{sub-section}{sub-section:BFFA5DB2BA4D2870-0CB437A9-461A4B11-82C2B6B9-C5B46EB107F8B78269328F0D_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=25997931EAEC4528-E773CFE6-43AE468F-B6BEBC56-FFBA967B1A89F0F843A7E308}{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:25997931EAEC4528-E773CFE6-43AE468F-B6BEBC56-FFBA967B1A89F0F843A7E308_des|text=|trigger=button}{sub-section}{sub-section:25997931EAEC4528-E773CFE6-43AE468F-B6BEBC56-FFBA967B1A89F0F843A7E308_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:25997931EAEC4528-E773CFE6-43AE468F-B6BEBC56-FFBA967B1A89F0F843A7E308_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:25997931EAEC4528-E773CFE6-43AE468F-B6BEBC56-FFBA967B1A89F0F843A7E308_prs|trigger=none}targetFolder
showWarning
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:25997931EAEC4528-E773CFE6-43AE468F-B6BEBC56-FFBA967B1A89F0F843A7E308_ret|text=|trigger=button}{sub-section}{sub-section:25997931EAEC4528-E773CFE6-43AE468F-B6BEBC56-FFBA967B1A89F0F843A7E308_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:25997931EAEC4528-E773CFE6-43AE468F-B6BEBC56-FFBA967B1A89F0F843A7E308_see|text=|trigger=button}{sub-section}{sub-section:25997931EAEC4528-E773CFE6-43AE468F-B6BEBC56-FFBA967B1A89F0F843A7E308_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:25997931EAEC4528-E773CFE6-43AE468F-B6BEBC56-FFBA967B1A89F0F843A7E308_see|text=|trigger=button}{sub-section}{sub-section:25997931EAEC4528-E773CFE6-43AE468F-B6BEBC56-FFBA967B1A89F0F843A7E308_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:25997931EAEC4528-E773CFE6-43AE468F-B6BEBC56-FFBA967B1A89F0F843A7E308_sam|text=|trigger=button}{sub-section}{sub-section:25997931EAEC4528-E773CFE6-43AE468F-B6BEBC56-FFBA967B1A89F0F843A7E308_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=50F778F58F245643-9FA966DF-414A4CD3-ACB59A92-A18146F62B98AEDFB850CC61}{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:50F778F58F245643-9FA966DF-414A4CD3-ACB59A92-A18146F62B98AEDFB850CC61_des|text=|trigger=button}{sub-section}{sub-section:50F778F58F245643-9FA966DF-414A4CD3-ACB59A92-A18146F62B98AEDFB850CC61_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:50F778F58F245643-9FA966DF-414A4CD3-ACB59A92-A18146F62B98AEDFB850CC61_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:50F778F58F245643-9FA966DF-414A4CD3-ACB59A92-A18146F62B98AEDFB850CC61_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:50F778F58F245643-9FA966DF-414A4CD3-ACB59A92-A18146F62B98AEDFB850CC61_ret|text=|trigger=button}{sub-section}{sub-section:50F778F58F245643-9FA966DF-414A4CD3-ACB59A92-A18146F62B98AEDFB850CC61_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:50F778F58F245643-9FA966DF-414A4CD3-ACB59A92-A18146F62B98AEDFB850CC61_see|text=|trigger=button}{sub-section}{sub-section:50F778F58F245643-9FA966DF-414A4CD3-ACB59A92-A18146F62B98AEDFB850CC61_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:50F778F58F245643-9FA966DF-414A4CD3-ACB59A92-A18146F62B98AEDFB850CC61_see|text=|trigger=button}{sub-section}{sub-section:50F778F58F245643-9FA966DF-414A4CD3-ACB59A92-A18146F62B98AEDFB850CC61_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:50F778F58F245643-9FA966DF-414A4CD3-ACB59A92-A18146F62B98AEDFB850CC61_sam|text=|trigger=button}{sub-section}{sub-section:50F778F58F245643-9FA966DF-414A4CD3-ACB59A92-A18146F62B98AEDFB850CC61_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=F8091A25DAD2BB17-C2F8315E-44554740-B299B877-9DDB52EC5FEB90C291FEBB80}{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:F8091A25DAD2BB17-C2F8315E-44554740-B299B877-9DDB52EC5FEB90C291FEBB80_des|text=|trigger=button}{sub-section}{sub-section:F8091A25DAD2BB17-C2F8315E-44554740-B299B877-9DDB52EC5FEB90C291FEBB80_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:F8091A25DAD2BB17-C2F8315E-44554740-B299B877-9DDB52EC5FEB90C291FEBB80_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F8091A25DAD2BB17-C2F8315E-44554740-B299B877-9DDB52EC5FEB90C291FEBB80_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:F8091A25DAD2BB17-C2F8315E-44554740-B299B877-9DDB52EC5FEB90C291FEBB80_ret|text=|trigger=button}{sub-section}{sub-section:F8091A25DAD2BB17-C2F8315E-44554740-B299B877-9DDB52EC5FEB90C291FEBB80_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F8091A25DAD2BB17-C2F8315E-44554740-B299B877-9DDB52EC5FEB90C291FEBB80_see|text=|trigger=button}{sub-section}{sub-section:F8091A25DAD2BB17-C2F8315E-44554740-B299B877-9DDB52EC5FEB90C291FEBB80_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F8091A25DAD2BB17-C2F8315E-44554740-B299B877-9DDB52EC5FEB90C291FEBB80_see|text=|trigger=button}{sub-section}{sub-section:F8091A25DAD2BB17-C2F8315E-44554740-B299B877-9DDB52EC5FEB90C291FEBB80_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F8091A25DAD2BB17-C2F8315E-44554740-B299B877-9DDB52EC5FEB90C291FEBB80_sam|text=|trigger=button}{sub-section}{sub-section:F8091A25DAD2BB17-C2F8315E-44554740-B299B877-9DDB52EC5FEB90C291FEBB80_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=E4E85E8B390CB14F-E9D22DAB-4C284148-81F6A7BB-00B3BA23CDEE9DDBA2CD111F}{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:E4E85E8B390CB14F-E9D22DAB-4C284148-81F6A7BB-00B3BA23CDEE9DDBA2CD111F_des|text=|trigger=button}{sub-section}{sub-section:E4E85E8B390CB14F-E9D22DAB-4C284148-81F6A7BB-00B3BA23CDEE9DDBA2CD111F_des|trigger=none|class=sIndent}Returns the size of the specified file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:E4E85E8B390CB14F-E9D22DAB-4C284148-81F6A7BB-00B3BA23CDEE9DDBA2CD111F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E4E85E8B390CB14F-E9D22DAB-4C284148-81F6A7BB-00B3BA23CDEE9DDBA2CD111F_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:E4E85E8B390CB14F-E9D22DAB-4C284148-81F6A7BB-00B3BA23CDEE9DDBA2CD111F_ret|text=|trigger=button}{sub-section}{sub-section:E4E85E8B390CB14F-E9D22DAB-4C284148-81F6A7BB-00B3BA23CDEE9DDBA2CD111F_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:E4E85E8B390CB14F-E9D22DAB-4C284148-81F6A7BB-00B3BA23CDEE9DDBA2CD111F_see|text=|trigger=button}{sub-section}{sub-section:E4E85E8B390CB14F-E9D22DAB-4C284148-81F6A7BB-00B3BA23CDEE9DDBA2CD111F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E4E85E8B390CB14F-E9D22DAB-4C284148-81F6A7BB-00B3BA23CDEE9DDBA2CD111F_see|text=|trigger=button}{sub-section}{sub-section:E4E85E8B390CB14F-E9D22DAB-4C284148-81F6A7BB-00B3BA23CDEE9DDBA2CD111F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E4E85E8B390CB14F-E9D22DAB-4C284148-81F6A7BB-00B3BA23CDEE9DDBA2CD111F_sam|text=|trigger=button}{sub-section}{sub-section:E4E85E8B390CB14F-E9D22DAB-4C284148-81F6A7BB-00B3BA23CDEE9DDBA2CD111F_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=A26AC66B0C908C1E-C18684B3-40D44399-BBB09A5F-BA8EF12F03F17C4B5A2DA969}{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:A26AC66B0C908C1E-C18684B3-40D44399-BBB09A5F-BA8EF12F03F17C4B5A2DA969_des|text=|trigger=button}{sub-section}{sub-section:A26AC66B0C908C1E-C18684B3-40D44399-BBB09A5F-BA8EF12F03F17C4B5A2DA969_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:A26AC66B0C908C1E-C18684B3-40D44399-BBB09A5F-BA8EF12F03F17C4B5A2DA969_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A26AC66B0C908C1E-C18684B3-40D44399-BBB09A5F-BA8EF12F03F17C4B5A2DA969_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:A26AC66B0C908C1E-C18684B3-40D44399-BBB09A5F-BA8EF12F03F17C4B5A2DA969_ret|text=|trigger=button}{sub-section}{sub-section:A26AC66B0C908C1E-C18684B3-40D44399-BBB09A5F-BA8EF12F03F17C4B5A2DA969_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:A26AC66B0C908C1E-C18684B3-40D44399-BBB09A5F-BA8EF12F03F17C4B5A2DA969_see|text=|trigger=button}{sub-section}{sub-section:A26AC66B0C908C1E-C18684B3-40D44399-BBB09A5F-BA8EF12F03F17C4B5A2DA969_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:A26AC66B0C908C1E-C18684B3-40D44399-BBB09A5F-BA8EF12F03F17C4B5A2DA969_see|text=|trigger=button}{sub-section}{sub-section:A26AC66B0C908C1E-C18684B3-40D44399-BBB09A5F-BA8EF12F03F17C4B5A2DA969_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:A26AC66B0C908C1E-C18684B3-40D44399-BBB09A5F-BA8EF12F03F17C4B5A2DA969_sam|text=|trigger=button}{sub-section}{sub-section:A26AC66B0C908C1E-C18684B3-40D44399-BBB09A5F-BA8EF12F03F17C4B5A2DA969_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=21EE890AD31B88E9-D8F25EDB-4B7849B2-90B1B9DF-E54861EB27337759BE0DD464}{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:21EE890AD31B88E9-D8F25EDB-4B7849B2-90B1B9DF-E54861EB27337759BE0DD464_des|text=|trigger=button}{sub-section}{sub-section:21EE890AD31B88E9-D8F25EDB-4B7849B2-90B1B9DF-E54861EB27337759BE0DD464_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:21EE890AD31B88E9-D8F25EDB-4B7849B2-90B1B9DF-E54861EB27337759BE0DD464_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:21EE890AD31B88E9-D8F25EDB-4B7849B2-90B1B9DF-E54861EB27337759BE0DD464_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:21EE890AD31B88E9-D8F25EDB-4B7849B2-90B1B9DF-E54861EB27337759BE0DD464_ret|text=|trigger=button}{sub-section}{sub-section:21EE890AD31B88E9-D8F25EDB-4B7849B2-90B1B9DF-E54861EB27337759BE0DD464_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:21EE890AD31B88E9-D8F25EDB-4B7849B2-90B1B9DF-E54861EB27337759BE0DD464_see|text=|trigger=button}{sub-section}{sub-section:21EE890AD31B88E9-D8F25EDB-4B7849B2-90B1B9DF-E54861EB27337759BE0DD464_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:21EE890AD31B88E9-D8F25EDB-4B7849B2-90B1B9DF-E54861EB27337759BE0DD464_see|text=|trigger=button}{sub-section}{sub-section:21EE890AD31B88E9-D8F25EDB-4B7849B2-90B1B9DF-E54861EB27337759BE0DD464_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:21EE890AD31B88E9-D8F25EDB-4B7849B2-90B1B9DF-E54861EB27337759BE0DD464_sam|text=|trigger=button}{sub-section}{sub-section:21EE890AD31B88E9-D8F25EDB-4B7849B2-90B1B9DF-E54861EB27337759BE0DD464_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=029696D087032485-D3649B32-46874A14-B797831E-FFA9A9002D64E1DF2D0A9CE1}{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:029696D087032485-D3649B32-46874A14-B797831E-FFA9A9002D64E1DF2D0A9CE1_des|text=|trigger=button}{sub-section}{sub-section:029696D087032485-D3649B32-46874A14-B797831E-FFA9A9002D64E1DF2D0A9CE1_des|trigger=none|class=sIndent}Returns the modification date of a file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:029696D087032485-D3649B32-46874A14-B797831E-FFA9A9002D64E1DF2D0A9CE1_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:029696D087032485-D3649B32-46874A14-B797831E-FFA9A9002D64E1DF2D0A9CE1_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:029696D087032485-D3649B32-46874A14-B797831E-FFA9A9002D64E1DF2D0A9CE1_ret|text=|trigger=button}{sub-section}{sub-section:029696D087032485-D3649B32-46874A14-B797831E-FFA9A9002D64E1DF2D0A9CE1_ret|trigger=none|class=sIndent}[Date]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:029696D087032485-D3649B32-46874A14-B797831E-FFA9A9002D64E1DF2D0A9CE1_see|text=|trigger=button}{sub-section}{sub-section:029696D087032485-D3649B32-46874A14-B797831E-FFA9A9002D64E1DF2D0A9CE1_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:029696D087032485-D3649B32-46874A14-B797831E-FFA9A9002D64E1DF2D0A9CE1_see|text=|trigger=button}{sub-section}{sub-section:029696D087032485-D3649B32-46874A14-B797831E-FFA9A9002D64E1DF2D0A9CE1_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:029696D087032485-D3649B32-46874A14-B797831E-FFA9A9002D64E1DF2D0A9CE1_sam|text=|trigger=button}{sub-section}{sub-section:029696D087032485-D3649B32-46874A14-B797831E-FFA9A9002D64E1DF2D0A9CE1_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=D21B2C0F0D46B6AE-8C74D657-49164B22-BEA2B8E1-BE94965290263883D4248F55}{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:D21B2C0F0D46B6AE-8C74D657-49164B22-BEA2B8E1-BE94965290263883D4248F55_des|text=|trigger=button}{sub-section}{sub-section:D21B2C0F0D46B6AE-8C74D657-49164B22-BEA2B8E1-BE94965290263883D4248F55_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:D21B2C0F0D46B6AE-8C74D657-49164B22-BEA2B8E1-BE94965290263883D4248F55_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D21B2C0F0D46B6AE-8C74D657-49164B22-BEA2B8E1-BE94965290263883D4248F55_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:D21B2C0F0D46B6AE-8C74D657-49164B22-BEA2B8E1-BE94965290263883D4248F55_ret|text=|trigger=button}{sub-section}{sub-section:D21B2C0F0D46B6AE-8C74D657-49164B22-BEA2B8E1-BE94965290263883D4248F55_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D21B2C0F0D46B6AE-8C74D657-49164B22-BEA2B8E1-BE94965290263883D4248F55_see|text=|trigger=button}{sub-section}{sub-section:D21B2C0F0D46B6AE-8C74D657-49164B22-BEA2B8E1-BE94965290263883D4248F55_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D21B2C0F0D46B6AE-8C74D657-49164B22-BEA2B8E1-BE94965290263883D4248F55_see|text=|trigger=button}{sub-section}{sub-section:D21B2C0F0D46B6AE-8C74D657-49164B22-BEA2B8E1-BE94965290263883D4248F55_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D21B2C0F0D46B6AE-8C74D657-49164B22-BEA2B8E1-BE94965290263883D4248F55_sam|text=|trigger=button}{sub-section}{sub-section:D21B2C0F0D46B6AE-8C74D657-49164B22-BEA2B8E1-BE94965290263883D4248F55_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=2546D0F66DA45605-E601D2CF-45104548-95D9A4D9-35DED36EFCC7FD73CC312191}{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:2546D0F66DA45605-E601D2CF-45104548-95D9A4D9-35DED36EFCC7FD73CC312191_des|text=|trigger=button}{sub-section}{sub-section:2546D0F66DA45605-E601D2CF-45104548-95D9A4D9-35DED36EFCC7FD73CC312191_des|trigger=none|class=sIndent}Reads all or part of the content from a binary file. If a file name is not specified, then a file selection dialog pops up for selecting a file. (Web Enabled){sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:2546D0F66DA45605-E601D2CF-45104548-95D9A4D9-35DED36EFCC7FD73CC312191_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2546D0F66DA45605-E601D2CF-45104548-95D9A4D9-35DED36EFCC7FD73CC312191_prs|trigger=none}\[file\]
\[size\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:2546D0F66DA45605-E601D2CF-45104548-95D9A4D9-35DED36EFCC7FD73CC312191_ret|text=|trigger=button}{sub-section}{sub-section:2546D0F66DA45605-E601D2CF-45104548-95D9A4D9-35DED36EFCC7FD73CC312191_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:2546D0F66DA45605-E601D2CF-45104548-95D9A4D9-35DED36EFCC7FD73CC312191_see|text=|trigger=button}{sub-section}{sub-section:2546D0F66DA45605-E601D2CF-45104548-95D9A4D9-35DED36EFCC7FD73CC312191_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2546D0F66DA45605-E601D2CF-45104548-95D9A4D9-35DED36EFCC7FD73CC312191_see|text=|trigger=button}{sub-section}{sub-section:2546D0F66DA45605-E601D2CF-45104548-95D9A4D9-35DED36EFCC7FD73CC312191_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2546D0F66DA45605-E601D2CF-45104548-95D9A4D9-35DED36EFCC7FD73CC312191_sam|text=|trigger=button}{sub-section}{sub-section:2546D0F66DA45605-E601D2CF-45104548-95D9A4D9-35DED36EFCC7FD73CC312191_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=44528FBBD140E376-9D1A2B9B-4FFE4DBD-BA3D806B-7F4B7DBAD942C4AF051E40EA}{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:44528FBBD140E376-9D1A2B9B-4FFE4DBD-BA3D806B-7F4B7DBAD942C4AF051E40EA_des|text=|trigger=button}{sub-section}{sub-section:44528FBBD140E376-9D1A2B9B-4FFE4DBD-BA3D806B-7F4B7DBAD942C4AF051E40EA_des|trigger=none|class=sIndent}Read all content from a text file. If a file name is not specified, then a file selection dialog pops up for selecting a file. The encoding can be also specified. (Web Enabled){sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:44528FBBD140E376-9D1A2B9B-4FFE4DBD-BA3D806B-7F4B7DBAD942C4AF051E40EA_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:44528FBBD140E376-9D1A2B9B-4FFE4DBD-BA3D806B-7F4B7DBAD942C4AF051E40EA_prs|trigger=none}\[file\]
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:44528FBBD140E376-9D1A2B9B-4FFE4DBD-BA3D806B-7F4B7DBAD942C4AF051E40EA_ret|text=|trigger=button}{sub-section}{sub-section:44528FBBD140E376-9D1A2B9B-4FFE4DBD-BA3D806B-7F4B7DBAD942C4AF051E40EA_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:44528FBBD140E376-9D1A2B9B-4FFE4DBD-BA3D806B-7F4B7DBAD942C4AF051E40EA_see|text=|trigger=button}{sub-section}{sub-section:44528FBBD140E376-9D1A2B9B-4FFE4DBD-BA3D806B-7F4B7DBAD942C4AF051E40EA_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:44528FBBD140E376-9D1A2B9B-4FFE4DBD-BA3D806B-7F4B7DBAD942C4AF051E40EA_see|text=|trigger=button}{sub-section}{sub-section:44528FBBD140E376-9D1A2B9B-4FFE4DBD-BA3D806B-7F4B7DBAD942C4AF051E40EA_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:44528FBBD140E376-9D1A2B9B-4FFE4DBD-BA3D806B-7F4B7DBAD942C4AF051E40EA_sam|text=|trigger=button}{sub-section}{sub-section:44528FBBD140E376-9D1A2B9B-4FFE4DBD-BA3D806B-7F4B7DBAD942C4AF051E40EA_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=41394DD633BD0338-F5C86EC5-4F6E472C-BEDBA9E6-2B67B977870F7D67BBA9E616}{tr:id=name}{td}h6.showDirectorySelectDialog{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}showDirectorySelectDialog{span}{span:id=iets|style=float: left;}\(directory suggestion, dialog title text){span}{td}{tr}{tr:id=des}{td}{sub-section:41394DD633BD0338-F5C86EC5-4F6E472C-BEDBA9E6-2B67B977870F7D67BBA9E616_des|text=|trigger=button}{sub-section}{sub-section:41394DD633BD0338-F5C86EC5-4F6E472C-BEDBA9E6-2B67B977870F7D67BBA9E616_des|trigger=none|class=sIndent}Shows a directory selector dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:41394DD633BD0338-F5C86EC5-4F6E472C-BEDBA9E6-2B67B977870F7D67BBA9E616_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:41394DD633BD0338-F5C86EC5-4F6E472C-BEDBA9E6-2B67B977870F7D67BBA9E616_prs|trigger=none}\[directory suggestion\]
\[dialog title text\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:41394DD633BD0338-F5C86EC5-4F6E472C-BEDBA9E6-2B67B977870F7D67BBA9E616_ret|text=|trigger=button}{sub-section}{sub-section:41394DD633BD0338-F5C86EC5-4F6E472C-BEDBA9E6-2B67B977870F7D67BBA9E616_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:41394DD633BD0338-F5C86EC5-4F6E472C-BEDBA9E6-2B67B977870F7D67BBA9E616_see|text=|trigger=button}{sub-section}{sub-section:41394DD633BD0338-F5C86EC5-4F6E472C-BEDBA9E6-2B67B977870F7D67BBA9E616_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:41394DD633BD0338-F5C86EC5-4F6E472C-BEDBA9E6-2B67B977870F7D67BBA9E616_see|text=|trigger=button}{sub-section}{sub-section:41394DD633BD0338-F5C86EC5-4F6E472C-BEDBA9E6-2B67B977870F7D67BBA9E616_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:41394DD633BD0338-F5C86EC5-4F6E472C-BEDBA9E6-2B67B977870F7D67BBA9E616_sam|text=|trigger=button}{sub-section}{sub-section:41394DD633BD0338-F5C86EC5-4F6E472C-BEDBA9E6-2B67B977870F7D67BBA9E616_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=EBF422D5B4416BD9-EC4CE281-4C7E4444-9FA6A73E-C89FAA5F967D8F6E8F5BD055}{tr:id=name}{td}h6.showFileOpenDialog{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}Object{span}{span:id=iets|style=float: left; font-weight: bold;}showFileOpenDialog{span}{span:id=iets|style=float: left;}\(selectionMode(0=both,1=Files,2=Dirs), startDirectory(null=default/previous), multiselect(true/false), filterarray, callbackmethod, dialog title text){span}{td}{tr}{tr:id=des}{td}{sub-section:EBF422D5B4416BD9-EC4CE281-4C7E4444-9FA6A73E-C89FAA5F967D8F6E8F5BD055_des|text=|trigger=button}{sub-section}{sub-section:EBF422D5B4416BD9-EC4CE281-4C7E4444-9FA6A73E-C89FAA5F967D8F6E8F5BD055_des|trigger=none|class=sIndent}Shows a file open dialog. Filters can be applied on what type of files can be selected. (Web Enabled){sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:EBF422D5B4416BD9-EC4CE281-4C7E4444-9FA6A73E-C89FAA5F967D8F6E8F5BD055_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EBF422D5B4416BD9-EC4CE281-4C7E4444-9FA6A73E-C89FAA5F967D8F6E8F5BD055_prs|trigger=none}\[selectionMode(0=both,1=Files,2=Dirs)\]
\[startDirectory(null=default/previous)\]
\[multiselect(true/false)\]
\[filterarray\]
\[callbackmethod\]
\[dialog title text\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:EBF422D5B4416BD9-EC4CE281-4C7E4444-9FA6A73E-C89FAA5F967D8F6E8F5BD055_ret|text=|trigger=button}{sub-section}{sub-section:EBF422D5B4416BD9-EC4CE281-4C7E4444-9FA6A73E-C89FAA5F967D8F6E8F5BD055_ret|trigger=none|class=sIndent}Object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:EBF422D5B4416BD9-EC4CE281-4C7E4444-9FA6A73E-C89FAA5F967D8F6E8F5BD055_see|text=|trigger=button}{sub-section}{sub-section:EBF422D5B4416BD9-EC4CE281-4C7E4444-9FA6A73E-C89FAA5F967D8F6E8F5BD055_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:EBF422D5B4416BD9-EC4CE281-4C7E4444-9FA6A73E-C89FAA5F967D8F6E8F5BD055_see|text=|trigger=button}{sub-section}{sub-section:EBF422D5B4416BD9-EC4CE281-4C7E4444-9FA6A73E-C89FAA5F967D8F6E8F5BD055_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:EBF422D5B4416BD9-EC4CE281-4C7E4444-9FA6A73E-C89FAA5F967D8F6E8F5BD055_sam|text=|trigger=button}{sub-section}{sub-section:EBF422D5B4416BD9-EC4CE281-4C7E4444-9FA6A73E-C89FAA5F967D8F6E8F5BD055_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());
//for the web you have to give a callback function that has a JSFile array as its first argument (also works in smart), other options can be set but are not used in the webclient (yet)
var file = plugins.file.showFileOpenDialog(myCallbackMethod)
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=9D226C197921CF41-26DBECC5-41014662-9BA6936F-7FE54D724C488A7A63D4D326}{tr:id=name}{td}h6.showFileSaveDialog{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}showFileSaveDialog{span}{span:id=iets|style=float: left;}\(fileName/dir suggestion, dialog title text){span}{td}{tr}{tr:id=des}{td}{sub-section:9D226C197921CF41-26DBECC5-41014662-9BA6936F-7FE54D724C488A7A63D4D326_des|text=|trigger=button}{sub-section}{sub-section:9D226C197921CF41-26DBECC5-41014662-9BA6936F-7FE54D724C488A7A63D4D326_des|trigger=none|class=sIndent}Shows a file save dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:9D226C197921CF41-26DBECC5-41014662-9BA6936F-7FE54D724C488A7A63D4D326_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9D226C197921CF41-26DBECC5-41014662-9BA6936F-7FE54D724C488A7A63D4D326_prs|trigger=none}\[fileName/dir suggestion\]
\[dialog title text\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:9D226C197921CF41-26DBECC5-41014662-9BA6936F-7FE54D724C488A7A63D4D326_ret|text=|trigger=button}{sub-section}{sub-section:9D226C197921CF41-26DBECC5-41014662-9BA6936F-7FE54D724C488A7A63D4D326_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:9D226C197921CF41-26DBECC5-41014662-9BA6936F-7FE54D724C488A7A63D4D326_see|text=|trigger=button}{sub-section}{sub-section:9D226C197921CF41-26DBECC5-41014662-9BA6936F-7FE54D724C488A7A63D4D326_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9D226C197921CF41-26DBECC5-41014662-9BA6936F-7FE54D724C488A7A63D4D326_see|text=|trigger=button}{sub-section}{sub-section:9D226C197921CF41-26DBECC5-41014662-9BA6936F-7FE54D724C488A7A63D4D326_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9D226C197921CF41-26DBECC5-41014662-9BA6936F-7FE54D724C488A7A63D4D326_sam|text=|trigger=button}{sub-section}{sub-section:9D226C197921CF41-26DBECC5-41014662-9BA6936F-7FE54D724C488A7A63D4D326_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=BD975EB9A9EFCC2B-4CAAB8F9-4F654B60-A0719669-80286149DD74AF9B4EFDC495}{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:BD975EB9A9EFCC2B-4CAAB8F9-4F654B60-A0719669-80286149DD74AF9B4EFDC495_des|text=|trigger=button}{sub-section}{sub-section:BD975EB9A9EFCC2B-4CAAB8F9-4F654B60-A0719669-80286149DD74AF9B4EFDC495_des|trigger=none|class=sIndent}Writes data into a binary file. (Web Enabled){sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:BD975EB9A9EFCC2B-4CAAB8F9-4F654B60-A0719669-80286149DD74AF9B4EFDC495_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BD975EB9A9EFCC2B-4CAAB8F9-4F654B60-A0719669-80286149DD74AF9B4EFDC495_prs|trigger=none}file
binary_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:BD975EB9A9EFCC2B-4CAAB8F9-4F654B60-A0719669-80286149DD74AF9B4EFDC495_ret|text=|trigger=button}{sub-section}{sub-section:BD975EB9A9EFCC2B-4CAAB8F9-4F654B60-A0719669-80286149DD74AF9B4EFDC495_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BD975EB9A9EFCC2B-4CAAB8F9-4F654B60-A0719669-80286149DD74AF9B4EFDC495_see|text=|trigger=button}{sub-section}{sub-section:BD975EB9A9EFCC2B-4CAAB8F9-4F654B60-A0719669-80286149DD74AF9B4EFDC495_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BD975EB9A9EFCC2B-4CAAB8F9-4F654B60-A0719669-80286149DD74AF9B4EFDC495_see|text=|trigger=button}{sub-section}{sub-section:BD975EB9A9EFCC2B-4CAAB8F9-4F654B60-A0719669-80286149DD74AF9B4EFDC495_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BD975EB9A9EFCC2B-4CAAB8F9-4F654B60-A0719669-80286149DD74AF9B4EFDC495_sam|text=|trigger=button}{sub-section}{sub-section:BD975EB9A9EFCC2B-4CAAB8F9-4F654B60-A0719669-80286149DD74AF9B4EFDC495_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=3F2DC601293D1B5E-6C158910-4DE14D0C-95F6AA5A-BEA08E2547C8977B282F8EED}{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:3F2DC601293D1B5E-6C158910-4DE14D0C-95F6AA5A-BEA08E2547C8977B282F8EED_des|text=|trigger=button}{sub-section}{sub-section:3F2DC601293D1B5E-6C158910-4DE14D0C-95F6AA5A-BEA08E2547C8977B282F8EED_des|trigger=none|class=sIndent}Writes data into a text file. (Web Enabled){sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:3F2DC601293D1B5E-6C158910-4DE14D0C-95F6AA5A-BEA08E2547C8977B282F8EED_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3F2DC601293D1B5E-6C158910-4DE14D0C-95F6AA5A-BEA08E2547C8977B282F8EED_prs|trigger=none}file
text_data
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:3F2DC601293D1B5E-6C158910-4DE14D0C-95F6AA5A-BEA08E2547C8977B282F8EED_ret|text=|trigger=button}{sub-section}{sub-section:3F2DC601293D1B5E-6C158910-4DE14D0C-95F6AA5A-BEA08E2547C8977B282F8EED_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3F2DC601293D1B5E-6C158910-4DE14D0C-95F6AA5A-BEA08E2547C8977B282F8EED_see|text=|trigger=button}{sub-section}{sub-section:3F2DC601293D1B5E-6C158910-4DE14D0C-95F6AA5A-BEA08E2547C8977B282F8EED_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3F2DC601293D1B5E-6C158910-4DE14D0C-95F6AA5A-BEA08E2547C8977B282F8EED_see|text=|trigger=button}{sub-section}{sub-section:3F2DC601293D1B5E-6C158910-4DE14D0C-95F6AA5A-BEA08E2547C8977B282F8EED_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3F2DC601293D1B5E-6C158910-4DE14D0C-95F6AA5A-BEA08E2547C8977B282F8EED_sam|text=|trigger=button}{sub-section}{sub-section:3F2DC601293D1B5E-6C158910-4DE14D0C-95F6AA5A-BEA08E2547C8977B282F8EED_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=CDF3602907D0BB77-ADC04135-4330420F-AC06A09C-57E4236148FB1D97E056B7EC}{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:CDF3602907D0BB77-ADC04135-4330420F-AC06A09C-57E4236148FB1D97E056B7EC_des|text=|trigger=button}{sub-section}{sub-section:CDF3602907D0BB77-ADC04135-4330420F-AC06A09C-57E4236148FB1D97E056B7EC_des|trigger=none|class=sIndent}Writes data into an XML file. The file is saved with the encoding specified by the XML itself. (Web Enabled){sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:CDF3602907D0BB77-ADC04135-4330420F-AC06A09C-57E4236148FB1D97E056B7EC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:CDF3602907D0BB77-ADC04135-4330420F-AC06A09C-57E4236148FB1D97E056B7EC_prs|trigger=none}file
xml_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:CDF3602907D0BB77-ADC04135-4330420F-AC06A09C-57E4236148FB1D97E056B7EC_ret|text=|trigger=button}{sub-section}{sub-section:CDF3602907D0BB77-ADC04135-4330420F-AC06A09C-57E4236148FB1D97E056B7EC_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:CDF3602907D0BB77-ADC04135-4330420F-AC06A09C-57E4236148FB1D97E056B7EC_see|text=|trigger=button}{sub-section}{sub-section:CDF3602907D0BB77-ADC04135-4330420F-AC06A09C-57E4236148FB1D97E056B7EC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:CDF3602907D0BB77-ADC04135-4330420F-AC06A09C-57E4236148FB1D97E056B7EC_see|text=|trigger=button}{sub-section}{sub-section:CDF3602907D0BB77-ADC04135-4330420F-AC06A09C-57E4236148FB1D97E056B7EC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:CDF3602907D0BB77-ADC04135-4330420F-AC06A09C-57E4236148FB1D97E056B7EC_sam|text=|trigger=button}{sub-section}{sub-section:CDF3602907D0BB77-ADC04135-4330420F-AC06A09C-57E4236148FB1D97E056B7EC_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}