Servoy 7.x.x Documentation
Child pages
  • file

Versions Compared

Old Version 8

changes.mady.by.user Servoy Docs

Saved on

compared with

New Version 9

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=BE4BF2B6AFFE6024-36B6916D-4F0147E5-BE4397CE-767C78FE04730E9EA0901AE2}{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:BE4BF2B6AFFE6024-36B6916D-4F0147E5-BE4397CE-767C78FE04730E9EA0901AE2_des|text=|trigger=button}{sub-section}{sub-section:BE4BF2B6AFFE6024-36B6916D-4F0147E5-BE4397CE-767C78FE04730E9EA0901AE2_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:BE4BF2B6AFFE6024-36B6916D-4F0147E5-BE4397CE-767C78FE04730E9EA0901AE2_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BE4BF2B6AFFE6024-36B6916D-4F0147E5-BE4397CE-767C78FE04730E9EA0901AE2_prs|trigger=none}file
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:BE4BF2B6AFFE6024-36B6916D-4F0147E5-BE4397CE-767C78FE04730E9EA0901AE2_ret|text=|trigger=button}{sub-section}{sub-section:BE4BF2B6AFFE6024-36B6916D-4F0147E5-BE4397CE-767C78FE04730E9EA0901AE2_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BE4BF2B6AFFE6024-36B6916D-4F0147E5-BE4397CE-767C78FE04730E9EA0901AE2_see|text=|trigger=button}{sub-section}{sub-section:BE4BF2B6AFFE6024-36B6916D-4F0147E5-BE4397CE-767C78FE04730E9EA0901AE2_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BE4BF2B6AFFE6024-36B6916D-4F0147E5-BE4397CE-767C78FE04730E9EA0901AE2_see|text=|trigger=button}{sub-section}{sub-section:BE4BF2B6AFFE6024-36B6916D-4F0147E5-BE4397CE-767C78FE04730E9EA0901AE2_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BE4BF2B6AFFE6024-36B6916D-4F0147E5-BE4397CE-767C78FE04730E9EA0901AE2_sam|text=|trigger=button}{sub-section}{sub-section:BE4BF2B6AFFE6024-36B6916D-4F0147E5-BE4397CE-767C78FE04730E9EA0901AE2_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=49FE11CFEA6E5EE1-9A80EA65-4A9C4EA2-994FB1BE-51F95F35EE7ECB2EF587F05D}{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:49FE11CFEA6E5EE1-9A80EA65-4A9C4EA2-994FB1BE-51F95F35EE7ECB2EF587F05D_des|text=|trigger=button}{sub-section}{sub-section:49FE11CFEA6E5EE1-9A80EA65-4A9C4EA2-994FB1BE-51F95F35EE7ECB2EF587F05D_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:49FE11CFEA6E5EE1-9A80EA65-4A9C4EA2-994FB1BE-51F95F35EE7ECB2EF587F05D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:49FE11CFEA6E5EE1-9A80EA65-4A9C4EA2-994FB1BE-51F95F35EE7ECB2EF587F05D_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:49FE11CFEA6E5EE1-9A80EA65-4A9C4EA2-994FB1BE-51F95F35EE7ECB2EF587F05D_ret|text=|trigger=button}{sub-section}{sub-section:49FE11CFEA6E5EE1-9A80EA65-4A9C4EA2-994FB1BE-51F95F35EE7ECB2EF587F05D_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:49FE11CFEA6E5EE1-9A80EA65-4A9C4EA2-994FB1BE-51F95F35EE7ECB2EF587F05D_see|text=|trigger=button}{sub-section}{sub-section:49FE11CFEA6E5EE1-9A80EA65-4A9C4EA2-994FB1BE-51F95F35EE7ECB2EF587F05D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:49FE11CFEA6E5EE1-9A80EA65-4A9C4EA2-994FB1BE-51F95F35EE7ECB2EF587F05D_see|text=|trigger=button}{sub-section}{sub-section:49FE11CFEA6E5EE1-9A80EA65-4A9C4EA2-994FB1BE-51F95F35EE7ECB2EF587F05D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:49FE11CFEA6E5EE1-9A80EA65-4A9C4EA2-994FB1BE-51F95F35EE7ECB2EF587F05D_sam|text=|trigger=button}{sub-section}{sub-section:49FE11CFEA6E5EE1-9A80EA65-4A9C4EA2-994FB1BE-51F95F35EE7ECB2EF587F05D_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=C94CE97F636FBB7E-BACFAC37-467B416F-BA04A035-845E3912C629A8D56C7FE077}{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:C94CE97F636FBB7E-BACFAC37-467B416F-BA04A035-845E3912C629A8D56C7FE077_des|text=|trigger=button}{sub-section}{sub-section:C94CE97F636FBB7E-BACFAC37-467B416F-BA04A035-845E3912C629A8D56C7FE077_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:C94CE97F636FBB7E-BACFAC37-467B416F-BA04A035-845E3912C629A8D56C7FE077_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C94CE97F636FBB7E-BACFAC37-467B416F-BA04A035-845E3912C629A8D56C7FE077_prs|trigger=none}sourceFolder
destinationFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C94CE97F636FBB7E-BACFAC37-467B416F-BA04A035-845E3912C629A8D56C7FE077_ret|text=|trigger=button}{sub-section}{sub-section:C94CE97F636FBB7E-BACFAC37-467B416F-BA04A035-845E3912C629A8D56C7FE077_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C94CE97F636FBB7E-BACFAC37-467B416F-BA04A035-845E3912C629A8D56C7FE077_see|text=|trigger=button}{sub-section}{sub-section:C94CE97F636FBB7E-BACFAC37-467B416F-BA04A035-845E3912C629A8D56C7FE077_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C94CE97F636FBB7E-BACFAC37-467B416F-BA04A035-845E3912C629A8D56C7FE077_see|text=|trigger=button}{sub-section}{sub-section:C94CE97F636FBB7E-BACFAC37-467B416F-BA04A035-845E3912C629A8D56C7FE077_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C94CE97F636FBB7E-BACFAC37-467B416F-BA04A035-845E3912C629A8D56C7FE077_sam|text=|trigger=button}{sub-section}{sub-section:C94CE97F636FBB7E-BACFAC37-467B416F-BA04A035-845E3912C629A8D56C7FE077_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=2BEAD824F33D4347-AD3DEAA2-4E824EE8-9EF29B48-91A1DC7F2A7AA77F144483E8}{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:2BEAD824F33D4347-AD3DEAA2-4E824EE8-9EF29B48-91A1DC7F2A7AA77F144483E8_des|text=|trigger=button}{sub-section}{sub-section:2BEAD824F33D4347-AD3DEAA2-4E824EE8-9EF29B48-91A1DC7F2A7AA77F144483E8_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:2BEAD824F33D4347-AD3DEAA2-4E824EE8-9EF29B48-91A1DC7F2A7AA77F144483E8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2BEAD824F33D4347-AD3DEAA2-4E824EE8-9EF29B48-91A1DC7F2A7AA77F144483E8_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:2BEAD824F33D4347-AD3DEAA2-4E824EE8-9EF29B48-91A1DC7F2A7AA77F144483E8_ret|text=|trigger=button}{sub-section}{sub-section:2BEAD824F33D4347-AD3DEAA2-4E824EE8-9EF29B48-91A1DC7F2A7AA77F144483E8_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:2BEAD824F33D4347-AD3DEAA2-4E824EE8-9EF29B48-91A1DC7F2A7AA77F144483E8_see|text=|trigger=button}{sub-section}{sub-section:2BEAD824F33D4347-AD3DEAA2-4E824EE8-9EF29B48-91A1DC7F2A7AA77F144483E8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2BEAD824F33D4347-AD3DEAA2-4E824EE8-9EF29B48-91A1DC7F2A7AA77F144483E8_see|text=|trigger=button}{sub-section}{sub-section:2BEAD824F33D4347-AD3DEAA2-4E824EE8-9EF29B48-91A1DC7F2A7AA77F144483E8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2BEAD824F33D4347-AD3DEAA2-4E824EE8-9EF29B48-91A1DC7F2A7AA77F144483E8_sam|text=|trigger=button}{sub-section}{sub-section:2BEAD824F33D4347-AD3DEAA2-4E824EE8-9EF29B48-91A1DC7F2A7AA77F144483E8_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=48356DDB9EB9E805-0F78ACBD-4C1E47C9-ABD08BDC-FE04BC05FAD247FF364DA6F0}{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:48356DDB9EB9E805-0F78ACBD-4C1E47C9-ABD08BDC-FE04BC05FAD247FF364DA6F0_des|text=|trigger=button}{sub-section}{sub-section:48356DDB9EB9E805-0F78ACBD-4C1E47C9-ABD08BDC-FE04BC05FAD247FF364DA6F0_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:48356DDB9EB9E805-0F78ACBD-4C1E47C9-ABD08BDC-FE04BC05FAD247FF364DA6F0_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:48356DDB9EB9E805-0F78ACBD-4C1E47C9-ABD08BDC-FE04BC05FAD247FF364DA6F0_prs|trigger=none}targetFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:48356DDB9EB9E805-0F78ACBD-4C1E47C9-ABD08BDC-FE04BC05FAD247FF364DA6F0_ret|text=|trigger=button}{sub-section}{sub-section:48356DDB9EB9E805-0F78ACBD-4C1E47C9-ABD08BDC-FE04BC05FAD247FF364DA6F0_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:48356DDB9EB9E805-0F78ACBD-4C1E47C9-ABD08BDC-FE04BC05FAD247FF364DA6F0_see|text=|trigger=button}{sub-section}{sub-section:48356DDB9EB9E805-0F78ACBD-4C1E47C9-ABD08BDC-FE04BC05FAD247FF364DA6F0_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:48356DDB9EB9E805-0F78ACBD-4C1E47C9-ABD08BDC-FE04BC05FAD247FF364DA6F0_see|text=|trigger=button}{sub-section}{sub-section:48356DDB9EB9E805-0F78ACBD-4C1E47C9-ABD08BDC-FE04BC05FAD247FF364DA6F0_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:48356DDB9EB9E805-0F78ACBD-4C1E47C9-ABD08BDC-FE04BC05FAD247FF364DA6F0_sam|text=|trigger=button}{sub-section}{sub-section:48356DDB9EB9E805-0F78ACBD-4C1E47C9-ABD08BDC-FE04BC05FAD247FF364DA6F0_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=1770F15A3F52524D-3CE2B1D6-4FF548C6-B97C84C9-94AE1400B02F37E0BEE031DF}{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:1770F15A3F52524D-3CE2B1D6-4FF548C6-B97C84C9-94AE1400B02F37E0BEE031DF_des|text=|trigger=button}{sub-section}{sub-section:1770F15A3F52524D-3CE2B1D6-4FF548C6-B97C84C9-94AE1400B02F37E0BEE031DF_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:1770F15A3F52524D-3CE2B1D6-4FF548C6-B97C84C9-94AE1400B02F37E0BEE031DF_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:1770F15A3F52524D-3CE2B1D6-4FF548C6-B97C84C9-94AE1400B02F37E0BEE031DF_prs|trigger=none}filePrefix
fileSuffix
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:1770F15A3F52524D-3CE2B1D6-4FF548C6-B97C84C9-94AE1400B02F37E0BEE031DF_ret|text=|trigger=button}{sub-section}{sub-section:1770F15A3F52524D-3CE2B1D6-4FF548C6-B97C84C9-94AE1400B02F37E0BEE031DF_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:1770F15A3F52524D-3CE2B1D6-4FF548C6-B97C84C9-94AE1400B02F37E0BEE031DF_see|text=|trigger=button}{sub-section}{sub-section:1770F15A3F52524D-3CE2B1D6-4FF548C6-B97C84C9-94AE1400B02F37E0BEE031DF_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:1770F15A3F52524D-3CE2B1D6-4FF548C6-B97C84C9-94AE1400B02F37E0BEE031DF_see|text=|trigger=button}{sub-section}{sub-section:1770F15A3F52524D-3CE2B1D6-4FF548C6-B97C84C9-94AE1400B02F37E0BEE031DF_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:1770F15A3F52524D-3CE2B1D6-4FF548C6-B97C84C9-94AE1400B02F37E0BEE031DF_sam|text=|trigger=button}{sub-section}{sub-section:1770F15A3F52524D-3CE2B1D6-4FF548C6-B97C84C9-94AE1400B02F37E0BEE031DF_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=EBC40218F674A99B-4B8A83EE-404B4B12-BBBCBBFD-F05D3E9962FD385C9FDA9499}{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:EBC40218F674A99B-4B8A83EE-404B4B12-BBBCBBFD-F05D3E9962FD385C9FDA9499_des|text=|trigger=button}{sub-section}{sub-section:EBC40218F674A99B-4B8A83EE-404B4B12-BBBCBBFD-F05D3E9962FD385C9FDA9499_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:EBC40218F674A99B-4B8A83EE-404B4B12-BBBCBBFD-F05D3E9962FD385C9FDA9499_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EBC40218F674A99B-4B8A83EE-404B4B12-BBBCBBFD-F05D3E9962FD385C9FDA9499_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:EBC40218F674A99B-4B8A83EE-404B4B12-BBBCBBFD-F05D3E9962FD385C9FDA9499_ret|text=|trigger=button}{sub-section}{sub-section:EBC40218F674A99B-4B8A83EE-404B4B12-BBBCBBFD-F05D3E9962FD385C9FDA9499_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:EBC40218F674A99B-4B8A83EE-404B4B12-BBBCBBFD-F05D3E9962FD385C9FDA9499_see|text=|trigger=button}{sub-section}{sub-section:EBC40218F674A99B-4B8A83EE-404B4B12-BBBCBBFD-F05D3E9962FD385C9FDA9499_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:EBC40218F674A99B-4B8A83EE-404B4B12-BBBCBBFD-F05D3E9962FD385C9FDA9499_see|text=|trigger=button}{sub-section}{sub-section:EBC40218F674A99B-4B8A83EE-404B4B12-BBBCBBFD-F05D3E9962FD385C9FDA9499_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:EBC40218F674A99B-4B8A83EE-404B4B12-BBBCBBFD-F05D3E9962FD385C9FDA9499_sam|text=|trigger=button}{sub-section}{sub-section:EBC40218F674A99B-4B8A83EE-404B4B12-BBBCBBFD-F05D3E9962FD385C9FDA9499_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=4D3F644BE298F058-22E3E5A0-44534526-950384F1-C427E0AC9945B11DE873C694}{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:4D3F644BE298F058-22E3E5A0-44534526-950384F1-C427E0AC9945B11DE873C694_des|text=|trigger=button}{sub-section}{sub-section:4D3F644BE298F058-22E3E5A0-44534526-950384F1-C427E0AC9945B11DE873C694_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:4D3F644BE298F058-22E3E5A0-44534526-950384F1-C427E0AC9945B11DE873C694_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:4D3F644BE298F058-22E3E5A0-44534526-950384F1-C427E0AC9945B11DE873C694_prs|trigger=none}targetFolder
showWarning
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:4D3F644BE298F058-22E3E5A0-44534526-950384F1-C427E0AC9945B11DE873C694_ret|text=|trigger=button}{sub-section}{sub-section:4D3F644BE298F058-22E3E5A0-44534526-950384F1-C427E0AC9945B11DE873C694_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:4D3F644BE298F058-22E3E5A0-44534526-950384F1-C427E0AC9945B11DE873C694_see|text=|trigger=button}{sub-section}{sub-section:4D3F644BE298F058-22E3E5A0-44534526-950384F1-C427E0AC9945B11DE873C694_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:4D3F644BE298F058-22E3E5A0-44534526-950384F1-C427E0AC9945B11DE873C694_see|text=|trigger=button}{sub-section}{sub-section:4D3F644BE298F058-22E3E5A0-44534526-950384F1-C427E0AC9945B11DE873C694_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:4D3F644BE298F058-22E3E5A0-44534526-950384F1-C427E0AC9945B11DE873C694_sam|text=|trigger=button}{sub-section}{sub-section:4D3F644BE298F058-22E3E5A0-44534526-950384F1-C427E0AC9945B11DE873C694_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=CA118F39C3783B8A-077CFDD6-48974B3C-B87DBE94-D2008A37A60A485D9227AEFF}{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:CA118F39C3783B8A-077CFDD6-48974B3C-B87DBE94-D2008A37A60A485D9227AEFF_des|text=|trigger=button}{sub-section}{sub-section:CA118F39C3783B8A-077CFDD6-48974B3C-B87DBE94-D2008A37A60A485D9227AEFF_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:CA118F39C3783B8A-077CFDD6-48974B3C-B87DBE94-D2008A37A60A485D9227AEFF_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:CA118F39C3783B8A-077CFDD6-48974B3C-B87DBE94-D2008A37A60A485D9227AEFF_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:CA118F39C3783B8A-077CFDD6-48974B3C-B87DBE94-D2008A37A60A485D9227AEFF_ret|text=|trigger=button}{sub-section}{sub-section:CA118F39C3783B8A-077CFDD6-48974B3C-B87DBE94-D2008A37A60A485D9227AEFF_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:CA118F39C3783B8A-077CFDD6-48974B3C-B87DBE94-D2008A37A60A485D9227AEFF_see|text=|trigger=button}{sub-section}{sub-section:CA118F39C3783B8A-077CFDD6-48974B3C-B87DBE94-D2008A37A60A485D9227AEFF_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:CA118F39C3783B8A-077CFDD6-48974B3C-B87DBE94-D2008A37A60A485D9227AEFF_see|text=|trigger=button}{sub-section}{sub-section:CA118F39C3783B8A-077CFDD6-48974B3C-B87DBE94-D2008A37A60A485D9227AEFF_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:CA118F39C3783B8A-077CFDD6-48974B3C-B87DBE94-D2008A37A60A485D9227AEFF_sam|text=|trigger=button}{sub-section}{sub-section:CA118F39C3783B8A-077CFDD6-48974B3C-B87DBE94-D2008A37A60A485D9227AEFF_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=FD1F844B5FAA20CA-434910AE-49E049BC-A49886F5-9DF043115A8B13C58A354C97}{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:FD1F844B5FAA20CA-434910AE-49E049BC-A49886F5-9DF043115A8B13C58A354C97_des|text=|trigger=button}{sub-section}{sub-section:FD1F844B5FAA20CA-434910AE-49E049BC-A49886F5-9DF043115A8B13C58A354C97_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:FD1F844B5FAA20CA-434910AE-49E049BC-A49886F5-9DF043115A8B13C58A354C97_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FD1F844B5FAA20CA-434910AE-49E049BC-A49886F5-9DF043115A8B13C58A354C97_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:FD1F844B5FAA20CA-434910AE-49E049BC-A49886F5-9DF043115A8B13C58A354C97_ret|text=|trigger=button}{sub-section}{sub-section:FD1F844B5FAA20CA-434910AE-49E049BC-A49886F5-9DF043115A8B13C58A354C97_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FD1F844B5FAA20CA-434910AE-49E049BC-A49886F5-9DF043115A8B13C58A354C97_see|text=|trigger=button}{sub-section}{sub-section:FD1F844B5FAA20CA-434910AE-49E049BC-A49886F5-9DF043115A8B13C58A354C97_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FD1F844B5FAA20CA-434910AE-49E049BC-A49886F5-9DF043115A8B13C58A354C97_see|text=|trigger=button}{sub-section}{sub-section:FD1F844B5FAA20CA-434910AE-49E049BC-A49886F5-9DF043115A8B13C58A354C97_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FD1F844B5FAA20CA-434910AE-49E049BC-A49886F5-9DF043115A8B13C58A354C97_sam|text=|trigger=button}{sub-section}{sub-section:FD1F844B5FAA20CA-434910AE-49E049BC-A49886F5-9DF043115A8B13C58A354C97_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=8BCD441F246D6879-C44570EA-4F144061-81179DBC-5C6034605B0D6A886E349BD8}{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:8BCD441F246D6879-C44570EA-4F144061-81179DBC-5C6034605B0D6A886E349BD8_des|text=|trigger=button}{sub-section}{sub-section:8BCD441F246D6879-C44570EA-4F144061-81179DBC-5C6034605B0D6A886E349BD8_des|trigger=none|class=sIndent}Returns the size of the specified file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:8BCD441F246D6879-C44570EA-4F144061-81179DBC-5C6034605B0D6A886E349BD8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8BCD441F246D6879-C44570EA-4F144061-81179DBC-5C6034605B0D6A886E349BD8_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:8BCD441F246D6879-C44570EA-4F144061-81179DBC-5C6034605B0D6A886E349BD8_ret|text=|trigger=button}{sub-section}{sub-section:8BCD441F246D6879-C44570EA-4F144061-81179DBC-5C6034605B0D6A886E349BD8_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:8BCD441F246D6879-C44570EA-4F144061-81179DBC-5C6034605B0D6A886E349BD8_see|text=|trigger=button}{sub-section}{sub-section:8BCD441F246D6879-C44570EA-4F144061-81179DBC-5C6034605B0D6A886E349BD8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:8BCD441F246D6879-C44570EA-4F144061-81179DBC-5C6034605B0D6A886E349BD8_see|text=|trigger=button}{sub-section}{sub-section:8BCD441F246D6879-C44570EA-4F144061-81179DBC-5C6034605B0D6A886E349BD8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:8BCD441F246D6879-C44570EA-4F144061-81179DBC-5C6034605B0D6A886E349BD8_sam|text=|trigger=button}{sub-section}{sub-section:8BCD441F246D6879-C44570EA-4F144061-81179DBC-5C6034605B0D6A886E349BD8_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=45DFF727FA95CC53-061F6CB4-4E2940A4-B90089B5-01E98ADB19449C6268C0182C}{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:45DFF727FA95CC53-061F6CB4-4E2940A4-B90089B5-01E98ADB19449C6268C0182C_des|text=|trigger=button}{sub-section}{sub-section:45DFF727FA95CC53-061F6CB4-4E2940A4-B90089B5-01E98ADB19449C6268C0182C_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:45DFF727FA95CC53-061F6CB4-4E2940A4-B90089B5-01E98ADB19449C6268C0182C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:45DFF727FA95CC53-061F6CB4-4E2940A4-B90089B5-01E98ADB19449C6268C0182C_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:45DFF727FA95CC53-061F6CB4-4E2940A4-B90089B5-01E98ADB19449C6268C0182C_ret|text=|trigger=button}{sub-section}{sub-section:45DFF727FA95CC53-061F6CB4-4E2940A4-B90089B5-01E98ADB19449C6268C0182C_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:45DFF727FA95CC53-061F6CB4-4E2940A4-B90089B5-01E98ADB19449C6268C0182C_see|text=|trigger=button}{sub-section}{sub-section:45DFF727FA95CC53-061F6CB4-4E2940A4-B90089B5-01E98ADB19449C6268C0182C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:45DFF727FA95CC53-061F6CB4-4E2940A4-B90089B5-01E98ADB19449C6268C0182C_see|text=|trigger=button}{sub-section}{sub-section:45DFF727FA95CC53-061F6CB4-4E2940A4-B90089B5-01E98ADB19449C6268C0182C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:45DFF727FA95CC53-061F6CB4-4E2940A4-B90089B5-01E98ADB19449C6268C0182C_sam|text=|trigger=button}{sub-section}{sub-section:45DFF727FA95CC53-061F6CB4-4E2940A4-B90089B5-01E98ADB19449C6268C0182C_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=6FF76219638321AE-A9F39FEA-4DF943C4-A59FB3D1-EADCB960AB31CBADC489EC18}{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:6FF76219638321AE-A9F39FEA-4DF943C4-A59FB3D1-EADCB960AB31CBADC489EC18_des|text=|trigger=button}{sub-section}{sub-section:6FF76219638321AE-A9F39FEA-4DF943C4-A59FB3D1-EADCB960AB31CBADC489EC18_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:6FF76219638321AE-A9F39FEA-4DF943C4-A59FB3D1-EADCB960AB31CBADC489EC18_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6FF76219638321AE-A9F39FEA-4DF943C4-A59FB3D1-EADCB960AB31CBADC489EC18_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:6FF76219638321AE-A9F39FEA-4DF943C4-A59FB3D1-EADCB960AB31CBADC489EC18_ret|text=|trigger=button}{sub-section}{sub-section:6FF76219638321AE-A9F39FEA-4DF943C4-A59FB3D1-EADCB960AB31CBADC489EC18_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:6FF76219638321AE-A9F39FEA-4DF943C4-A59FB3D1-EADCB960AB31CBADC489EC18_see|text=|trigger=button}{sub-section}{sub-section:6FF76219638321AE-A9F39FEA-4DF943C4-A59FB3D1-EADCB960AB31CBADC489EC18_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:6FF76219638321AE-A9F39FEA-4DF943C4-A59FB3D1-EADCB960AB31CBADC489EC18_see|text=|trigger=button}{sub-section}{sub-section:6FF76219638321AE-A9F39FEA-4DF943C4-A59FB3D1-EADCB960AB31CBADC489EC18_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:6FF76219638321AE-A9F39FEA-4DF943C4-A59FB3D1-EADCB960AB31CBADC489EC18_sam|text=|trigger=button}{sub-section}{sub-section:6FF76219638321AE-A9F39FEA-4DF943C4-A59FB3D1-EADCB960AB31CBADC489EC18_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=8AD925EE3F0DB285-45C853E5-4D5042BB-874D9BAF-5EB3014045172BA7CCB9BC95}{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:8AD925EE3F0DB285-45C853E5-4D5042BB-874D9BAF-5EB3014045172BA7CCB9BC95_des|text=|trigger=button}{sub-section}{sub-section:8AD925EE3F0DB285-45C853E5-4D5042BB-874D9BAF-5EB3014045172BA7CCB9BC95_des|trigger=none|class=sIndent}Returns the modification date of a file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:8AD925EE3F0DB285-45C853E5-4D5042BB-874D9BAF-5EB3014045172BA7CCB9BC95_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8AD925EE3F0DB285-45C853E5-4D5042BB-874D9BAF-5EB3014045172BA7CCB9BC95_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:8AD925EE3F0DB285-45C853E5-4D5042BB-874D9BAF-5EB3014045172BA7CCB9BC95_ret|text=|trigger=button}{sub-section}{sub-section:8AD925EE3F0DB285-45C853E5-4D5042BB-874D9BAF-5EB3014045172BA7CCB9BC95_ret|trigger=none|class=sIndent}[Date]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:8AD925EE3F0DB285-45C853E5-4D5042BB-874D9BAF-5EB3014045172BA7CCB9BC95_see|text=|trigger=button}{sub-section}{sub-section:8AD925EE3F0DB285-45C853E5-4D5042BB-874D9BAF-5EB3014045172BA7CCB9BC95_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:8AD925EE3F0DB285-45C853E5-4D5042BB-874D9BAF-5EB3014045172BA7CCB9BC95_see|text=|trigger=button}{sub-section}{sub-section:8AD925EE3F0DB285-45C853E5-4D5042BB-874D9BAF-5EB3014045172BA7CCB9BC95_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:8AD925EE3F0DB285-45C853E5-4D5042BB-874D9BAF-5EB3014045172BA7CCB9BC95_sam|text=|trigger=button}{sub-section}{sub-section:8AD925EE3F0DB285-45C853E5-4D5042BB-874D9BAF-5EB3014045172BA7CCB9BC95_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=BAD816053F9680EE-079B3FFC-40CD44A7-B141A493-6BB05133C24DCA2DD58C0604}{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:BAD816053F9680EE-079B3FFC-40CD44A7-B141A493-6BB05133C24DCA2DD58C0604_des|text=|trigger=button}{sub-section}{sub-section:BAD816053F9680EE-079B3FFC-40CD44A7-B141A493-6BB05133C24DCA2DD58C0604_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:BAD816053F9680EE-079B3FFC-40CD44A7-B141A493-6BB05133C24DCA2DD58C0604_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BAD816053F9680EE-079B3FFC-40CD44A7-B141A493-6BB05133C24DCA2DD58C0604_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:BAD816053F9680EE-079B3FFC-40CD44A7-B141A493-6BB05133C24DCA2DD58C0604_ret|text=|trigger=button}{sub-section}{sub-section:BAD816053F9680EE-079B3FFC-40CD44A7-B141A493-6BB05133C24DCA2DD58C0604_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BAD816053F9680EE-079B3FFC-40CD44A7-B141A493-6BB05133C24DCA2DD58C0604_see|text=|trigger=button}{sub-section}{sub-section:BAD816053F9680EE-079B3FFC-40CD44A7-B141A493-6BB05133C24DCA2DD58C0604_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BAD816053F9680EE-079B3FFC-40CD44A7-B141A493-6BB05133C24DCA2DD58C0604_see|text=|trigger=button}{sub-section}{sub-section:BAD816053F9680EE-079B3FFC-40CD44A7-B141A493-6BB05133C24DCA2DD58C0604_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BAD816053F9680EE-079B3FFC-40CD44A7-B141A493-6BB05133C24DCA2DD58C0604_sam|text=|trigger=button}{sub-section}{sub-section:BAD816053F9680EE-079B3FFC-40CD44A7-B141A493-6BB05133C24DCA2DD58C0604_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=76D19F73282E96C8-6C524AB7-4B304D1D-8538B825-596BDB056BC7762C219585F6}{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:76D19F73282E96C8-6C524AB7-4B304D1D-8538B825-596BDB056BC7762C219585F6_des|text=|trigger=button}{sub-section}{sub-section:76D19F73282E96C8-6C524AB7-4B304D1D-8538B825-596BDB056BC7762C219585F6_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:76D19F73282E96C8-6C524AB7-4B304D1D-8538B825-596BDB056BC7762C219585F6_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:76D19F73282E96C8-6C524AB7-4B304D1D-8538B825-596BDB056BC7762C219585F6_prs|trigger=none}\[file\]
\[size\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:76D19F73282E96C8-6C524AB7-4B304D1D-8538B825-596BDB056BC7762C219585F6_ret|text=|trigger=button}{sub-section}{sub-section:76D19F73282E96C8-6C524AB7-4B304D1D-8538B825-596BDB056BC7762C219585F6_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:76D19F73282E96C8-6C524AB7-4B304D1D-8538B825-596BDB056BC7762C219585F6_see|text=|trigger=button}{sub-section}{sub-section:76D19F73282E96C8-6C524AB7-4B304D1D-8538B825-596BDB056BC7762C219585F6_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:76D19F73282E96C8-6C524AB7-4B304D1D-8538B825-596BDB056BC7762C219585F6_see|text=|trigger=button}{sub-section}{sub-section:76D19F73282E96C8-6C524AB7-4B304D1D-8538B825-596BDB056BC7762C219585F6_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:76D19F73282E96C8-6C524AB7-4B304D1D-8538B825-596BDB056BC7762C219585F6_sam|text=|trigger=button}{sub-section}{sub-section:76D19F73282E96C8-6C524AB7-4B304D1D-8538B825-596BDB056BC7762C219585F6_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=09A862B65D33EBDF-23D85B40-42BB4ED0-8F20861B-20B7F2046561DB3D81FDAF33}{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:09A862B65D33EBDF-23D85B40-42BB4ED0-8F20861B-20B7F2046561DB3D81FDAF33_des|text=|trigger=button}{sub-section}{sub-section:09A862B65D33EBDF-23D85B40-42BB4ED0-8F20861B-20B7F2046561DB3D81FDAF33_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:09A862B65D33EBDF-23D85B40-42BB4ED0-8F20861B-20B7F2046561DB3D81FDAF33_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:09A862B65D33EBDF-23D85B40-42BB4ED0-8F20861B-20B7F2046561DB3D81FDAF33_prs|trigger=none}\[file\]
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:09A862B65D33EBDF-23D85B40-42BB4ED0-8F20861B-20B7F2046561DB3D81FDAF33_ret|text=|trigger=button}{sub-section}{sub-section:09A862B65D33EBDF-23D85B40-42BB4ED0-8F20861B-20B7F2046561DB3D81FDAF33_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:09A862B65D33EBDF-23D85B40-42BB4ED0-8F20861B-20B7F2046561DB3D81FDAF33_see|text=|trigger=button}{sub-section}{sub-section:09A862B65D33EBDF-23D85B40-42BB4ED0-8F20861B-20B7F2046561DB3D81FDAF33_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:09A862B65D33EBDF-23D85B40-42BB4ED0-8F20861B-20B7F2046561DB3D81FDAF33_see|text=|trigger=button}{sub-section}{sub-section:09A862B65D33EBDF-23D85B40-42BB4ED0-8F20861B-20B7F2046561DB3D81FDAF33_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:09A862B65D33EBDF-23D85B40-42BB4ED0-8F20861B-20B7F2046561DB3D81FDAF33_sam|text=|trigger=button}{sub-section}{sub-section:09A862B65D33EBDF-23D85B40-42BB4ED0-8F20861B-20B7F2046561DB3D81FDAF33_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=ABBB2B4984AA56F9-EC443351-437B458D-A3A7BD7D-70CC584F823BF2FBCFFB0779}{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:ABBB2B4984AA56F9-EC443351-437B458D-A3A7BD7D-70CC584F823BF2FBCFFB0779_des|text=|trigger=button}{sub-section}{sub-section:ABBB2B4984AA56F9-EC443351-437B458D-A3A7BD7D-70CC584F823BF2FBCFFB0779_des|trigger=none|class=sIndent}Shows a directory selector dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:ABBB2B4984AA56F9-EC443351-437B458D-A3A7BD7D-70CC584F823BF2FBCFFB0779_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ABBB2B4984AA56F9-EC443351-437B458D-A3A7BD7D-70CC584F823BF2FBCFFB0779_prs|trigger=none}\[directory suggestion\]
\[dialog title text\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:ABBB2B4984AA56F9-EC443351-437B458D-A3A7BD7D-70CC584F823BF2FBCFFB0779_ret|text=|trigger=button}{sub-section}{sub-section:ABBB2B4984AA56F9-EC443351-437B458D-A3A7BD7D-70CC584F823BF2FBCFFB0779_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:ABBB2B4984AA56F9-EC443351-437B458D-A3A7BD7D-70CC584F823BF2FBCFFB0779_see|text=|trigger=button}{sub-section}{sub-section:ABBB2B4984AA56F9-EC443351-437B458D-A3A7BD7D-70CC584F823BF2FBCFFB0779_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:ABBB2B4984AA56F9-EC443351-437B458D-A3A7BD7D-70CC584F823BF2FBCFFB0779_see|text=|trigger=button}{sub-section}{sub-section:ABBB2B4984AA56F9-EC443351-437B458D-A3A7BD7D-70CC584F823BF2FBCFFB0779_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:ABBB2B4984AA56F9-EC443351-437B458D-A3A7BD7D-70CC584F823BF2FBCFFB0779_sam|text=|trigger=button}{sub-section}{sub-section:ABBB2B4984AA56F9-EC443351-437B458D-A3A7BD7D-70CC584F823BF2FBCFFB0779_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=07DF39F40D654245-2D38CB5D-4E054059-A47894B4-B840DF997E3211B9ADC955ED}{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:07DF39F40D654245-2D38CB5D-4E054059-A47894B4-B840DF997E3211B9ADC955ED_des|text=|trigger=button}{sub-section}{sub-section:07DF39F40D654245-2D38CB5D-4E054059-A47894B4-B840DF997E3211B9ADC955ED_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:07DF39F40D654245-2D38CB5D-4E054059-A47894B4-B840DF997E3211B9ADC955ED_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:07DF39F40D654245-2D38CB5D-4E054059-A47894B4-B840DF997E3211B9ADC955ED_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:07DF39F40D654245-2D38CB5D-4E054059-A47894B4-B840DF997E3211B9ADC955ED_ret|text=|trigger=button}{sub-section}{sub-section:07DF39F40D654245-2D38CB5D-4E054059-A47894B4-B840DF997E3211B9ADC955ED_ret|trigger=none|class=sIndent}Object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:07DF39F40D654245-2D38CB5D-4E054059-A47894B4-B840DF997E3211B9ADC955ED_see|text=|trigger=button}{sub-section}{sub-section:07DF39F40D654245-2D38CB5D-4E054059-A47894B4-B840DF997E3211B9ADC955ED_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:07DF39F40D654245-2D38CB5D-4E054059-A47894B4-B840DF997E3211B9ADC955ED_see|text=|trigger=button}{sub-section}{sub-section:07DF39F40D654245-2D38CB5D-4E054059-A47894B4-B840DF997E3211B9ADC955ED_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:07DF39F40D654245-2D38CB5D-4E054059-A47894B4-B840DF997E3211B9ADC955ED_sam|text=|trigger=button}{sub-section}{sub-section:07DF39F40D654245-2D38CB5D-4E054059-A47894B4-B840DF997E3211B9ADC955ED_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=6667353489C302C1-B8CE6DB8-41BA4613-A51CA417-E04F221845C3A10500A6C532}{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:6667353489C302C1-B8CE6DB8-41BA4613-A51CA417-E04F221845C3A10500A6C532_des|text=|trigger=button}{sub-section}{sub-section:6667353489C302C1-B8CE6DB8-41BA4613-A51CA417-E04F221845C3A10500A6C532_des|trigger=none|class=sIndent}Shows a file save dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:6667353489C302C1-B8CE6DB8-41BA4613-A51CA417-E04F221845C3A10500A6C532_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6667353489C302C1-B8CE6DB8-41BA4613-A51CA417-E04F221845C3A10500A6C532_prs|trigger=none}\[fileName/dir suggestion\]
\[dialog title text\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:6667353489C302C1-B8CE6DB8-41BA4613-A51CA417-E04F221845C3A10500A6C532_ret|text=|trigger=button}{sub-section}{sub-section:6667353489C302C1-B8CE6DB8-41BA4613-A51CA417-E04F221845C3A10500A6C532_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:6667353489C302C1-B8CE6DB8-41BA4613-A51CA417-E04F221845C3A10500A6C532_see|text=|trigger=button}{sub-section}{sub-section:6667353489C302C1-B8CE6DB8-41BA4613-A51CA417-E04F221845C3A10500A6C532_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:6667353489C302C1-B8CE6DB8-41BA4613-A51CA417-E04F221845C3A10500A6C532_see|text=|trigger=button}{sub-section}{sub-section:6667353489C302C1-B8CE6DB8-41BA4613-A51CA417-E04F221845C3A10500A6C532_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:6667353489C302C1-B8CE6DB8-41BA4613-A51CA417-E04F221845C3A10500A6C532_sam|text=|trigger=button}{sub-section}{sub-section:6667353489C302C1-B8CE6DB8-41BA4613-A51CA417-E04F221845C3A10500A6C532_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=D3D75521CBE726FF-6CCCF1A5-45F44528-AA1C9749-293B012551386DF7ED594B36}{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:D3D75521CBE726FF-6CCCF1A5-45F44528-AA1C9749-293B012551386DF7ED594B36_des|text=|trigger=button}{sub-section}{sub-section:D3D75521CBE726FF-6CCCF1A5-45F44528-AA1C9749-293B012551386DF7ED594B36_des|trigger=none|class=sIndent}Writes data into a binary file. (Web Enabled){sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:D3D75521CBE726FF-6CCCF1A5-45F44528-AA1C9749-293B012551386DF7ED594B36_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D3D75521CBE726FF-6CCCF1A5-45F44528-AA1C9749-293B012551386DF7ED594B36_prs|trigger=none}file
binary_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:D3D75521CBE726FF-6CCCF1A5-45F44528-AA1C9749-293B012551386DF7ED594B36_ret|text=|trigger=button}{sub-section}{sub-section:D3D75521CBE726FF-6CCCF1A5-45F44528-AA1C9749-293B012551386DF7ED594B36_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D3D75521CBE726FF-6CCCF1A5-45F44528-AA1C9749-293B012551386DF7ED594B36_see|text=|trigger=button}{sub-section}{sub-section:D3D75521CBE726FF-6CCCF1A5-45F44528-AA1C9749-293B012551386DF7ED594B36_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D3D75521CBE726FF-6CCCF1A5-45F44528-AA1C9749-293B012551386DF7ED594B36_see|text=|trigger=button}{sub-section}{sub-section:D3D75521CBE726FF-6CCCF1A5-45F44528-AA1C9749-293B012551386DF7ED594B36_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D3D75521CBE726FF-6CCCF1A5-45F44528-AA1C9749-293B012551386DF7ED594B36_sam|text=|trigger=button}{sub-section}{sub-section:D3D75521CBE726FF-6CCCF1A5-45F44528-AA1C9749-293B012551386DF7ED594B36_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=4948A294A797C3A8-8B83F40F-42D14846-A9DEA0DA-8F258AD2BED2511ADB80F174}{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:4948A294A797C3A8-8B83F40F-42D14846-A9DEA0DA-8F258AD2BED2511ADB80F174_des|text=|trigger=button}{sub-section}{sub-section:4948A294A797C3A8-8B83F40F-42D14846-A9DEA0DA-8F258AD2BED2511ADB80F174_des|trigger=none|class=sIndent}Writes data into a text file. (Web Enabled){sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:4948A294A797C3A8-8B83F40F-42D14846-A9DEA0DA-8F258AD2BED2511ADB80F174_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:4948A294A797C3A8-8B83F40F-42D14846-A9DEA0DA-8F258AD2BED2511ADB80F174_prs|trigger=none}file
text_data
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:4948A294A797C3A8-8B83F40F-42D14846-A9DEA0DA-8F258AD2BED2511ADB80F174_ret|text=|trigger=button}{sub-section}{sub-section:4948A294A797C3A8-8B83F40F-42D14846-A9DEA0DA-8F258AD2BED2511ADB80F174_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:4948A294A797C3A8-8B83F40F-42D14846-A9DEA0DA-8F258AD2BED2511ADB80F174_see|text=|trigger=button}{sub-section}{sub-section:4948A294A797C3A8-8B83F40F-42D14846-A9DEA0DA-8F258AD2BED2511ADB80F174_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:4948A294A797C3A8-8B83F40F-42D14846-A9DEA0DA-8F258AD2BED2511ADB80F174_see|text=|trigger=button}{sub-section}{sub-section:4948A294A797C3A8-8B83F40F-42D14846-A9DEA0DA-8F258AD2BED2511ADB80F174_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:4948A294A797C3A8-8B83F40F-42D14846-A9DEA0DA-8F258AD2BED2511ADB80F174_sam|text=|trigger=button}{sub-section}{sub-section:4948A294A797C3A8-8B83F40F-42D14846-A9DEA0DA-8F258AD2BED2511ADB80F174_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=52977F8E7DEC875B-39479962-42E043F2-B6408FBF-404C78C676D8F6A085BC011C}{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:52977F8E7DEC875B-39479962-42E043F2-B6408FBF-404C78C676D8F6A085BC011C_des|text=|trigger=button}{sub-section}{sub-section:52977F8E7DEC875B-39479962-42E043F2-B6408FBF-404C78C676D8F6A085BC011C_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:52977F8E7DEC875B-39479962-42E043F2-B6408FBF-404C78C676D8F6A085BC011C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:52977F8E7DEC875B-39479962-42E043F2-B6408FBF-404C78C676D8F6A085BC011C_prs|trigger=none}file
xml_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:52977F8E7DEC875B-39479962-42E043F2-B6408FBF-404C78C676D8F6A085BC011C_ret|text=|trigger=button}{sub-section}{sub-section:52977F8E7DEC875B-39479962-42E043F2-B6408FBF-404C78C676D8F6A085BC011C_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:52977F8E7DEC875B-39479962-42E043F2-B6408FBF-404C78C676D8F6A085BC011C_see|text=|trigger=button}{sub-section}{sub-section:52977F8E7DEC875B-39479962-42E043F2-B6408FBF-404C78C676D8F6A085BC011C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:52977F8E7DEC875B-39479962-42E043F2-B6408FBF-404C78C676D8F6A085BC011C_see|text=|trigger=button}{sub-section}{sub-section:52977F8E7DEC875B-39479962-42E043F2-B6408FBF-404C78C676D8F6A085BC011C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:52977F8E7DEC875B-39479962-42E043F2-B6408FBF-404C78C676D8F6A085BC011C_sam|text=|trigger=button}{sub-section}{sub-section:52977F8E7DEC875B-39479962-42E043F2-B6408FBF-404C78C676D8F6A085BC011C_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}