Servoy 7.x.x Documentation
Child pages
  • file

Versions Compared

Old Version 9

changes.mady.by.user Servoy Docs

Saved on

compared with

New Version 10

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=AFFE60243EC9EACB-916D4962-47E544E0-97CEA55A-0E9EA0901AE221D2199B77D3}{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:AFFE60243EC9EACB-916D4962-47E544E0-97CEA55A-0E9EA0901AE221D2199B77D3_des|text=|trigger=button}{sub-section}{sub-section:AFFE60243EC9EACB-916D4962-47E544E0-97CEA55A-0E9EA0901AE221D2199B77D3_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:AFFE60243EC9EACB-916D4962-47E544E0-97CEA55A-0E9EA0901AE221D2199B77D3_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:AFFE60243EC9EACB-916D4962-47E544E0-97CEA55A-0E9EA0901AE221D2199B77D3_prs|trigger=none}file
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:AFFE60243EC9EACB-916D4962-47E544E0-97CEA55A-0E9EA0901AE221D2199B77D3_ret|text=|trigger=button}{sub-section}{sub-section:AFFE60243EC9EACB-916D4962-47E544E0-97CEA55A-0E9EA0901AE221D2199B77D3_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:AFFE60243EC9EACB-916D4962-47E544E0-97CEA55A-0E9EA0901AE221D2199B77D3_see|text=|trigger=button}{sub-section}{sub-section:AFFE60243EC9EACB-916D4962-47E544E0-97CEA55A-0E9EA0901AE221D2199B77D3_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:AFFE60243EC9EACB-916D4962-47E544E0-97CEA55A-0E9EA0901AE221D2199B77D3_see|text=|trigger=button}{sub-section}{sub-section:AFFE60243EC9EACB-916D4962-47E544E0-97CEA55A-0E9EA0901AE221D2199B77D3_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:AFFE60243EC9EACB-916D4962-47E544E0-97CEA55A-0E9EA0901AE221D2199B77D3_sam|text=|trigger=button}{sub-section}{sub-section:AFFE60243EC9EACB-916D4962-47E544E0-97CEA55A-0E9EA0901AE221D2199B77D3_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=EA6E5EE198FBB2EB-EA6564A6-4EA240C5-B1BEA6A6-CB2EF587F05D727FD45C45C5}{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:EA6E5EE198FBB2EB-EA6564A6-4EA240C5-B1BEA6A6-CB2EF587F05D727FD45C45C5_des|text=|trigger=button}{sub-section}{sub-section:EA6E5EE198FBB2EB-EA6564A6-4EA240C5-B1BEA6A6-CB2EF587F05D727FD45C45C5_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:EA6E5EE198FBB2EB-EA6564A6-4EA240C5-B1BEA6A6-CB2EF587F05D727FD45C45C5_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EA6E5EE198FBB2EB-EA6564A6-4EA240C5-B1BEA6A6-CB2EF587F05D727FD45C45C5_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:EA6E5EE198FBB2EB-EA6564A6-4EA240C5-B1BEA6A6-CB2EF587F05D727FD45C45C5_ret|text=|trigger=button}{sub-section}{sub-section:EA6E5EE198FBB2EB-EA6564A6-4EA240C5-B1BEA6A6-CB2EF587F05D727FD45C45C5_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:EA6E5EE198FBB2EB-EA6564A6-4EA240C5-B1BEA6A6-CB2EF587F05D727FD45C45C5_see|text=|trigger=button}{sub-section}{sub-section:EA6E5EE198FBB2EB-EA6564A6-4EA240C5-B1BEA6A6-CB2EF587F05D727FD45C45C5_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:EA6E5EE198FBB2EB-EA6564A6-4EA240C5-B1BEA6A6-CB2EF587F05D727FD45C45C5_see|text=|trigger=button}{sub-section}{sub-section:EA6E5EE198FBB2EB-EA6564A6-4EA240C5-B1BEA6A6-CB2EF587F05D727FD45C45C5_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:EA6E5EE198FBB2EB-EA6564A6-4EA240C5-B1BEA6A6-CB2EF587F05D727FD45C45C5_sam|text=|trigger=button}{sub-section}{sub-section:EA6E5EE198FBB2EB-EA6564A6-4EA240C5-B1BEA6A6-CB2EF587F05D727FD45C45C5_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=636FBB7E09893269-AC37CA7F-416F4C69-A03586A7-A8D56C7FE0778D371CED61AD}{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:636FBB7E09893269-AC37CA7F-416F4C69-A03586A7-A8D56C7FE0778D371CED61AD_des|text=|trigger=button}{sub-section}{sub-section:636FBB7E09893269-AC37CA7F-416F4C69-A03586A7-A8D56C7FE0778D371CED61AD_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:636FBB7E09893269-AC37CA7F-416F4C69-A03586A7-A8D56C7FE0778D371CED61AD_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:636FBB7E09893269-AC37CA7F-416F4C69-A03586A7-A8D56C7FE0778D371CED61AD_prs|trigger=none}sourceFolder
destinationFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:636FBB7E09893269-AC37CA7F-416F4C69-A03586A7-A8D56C7FE0778D371CED61AD_ret|text=|trigger=button}{sub-section}{sub-section:636FBB7E09893269-AC37CA7F-416F4C69-A03586A7-A8D56C7FE0778D371CED61AD_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:636FBB7E09893269-AC37CA7F-416F4C69-A03586A7-A8D56C7FE0778D371CED61AD_see|text=|trigger=button}{sub-section}{sub-section:636FBB7E09893269-AC37CA7F-416F4C69-A03586A7-A8D56C7FE0778D371CED61AD_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:636FBB7E09893269-AC37CA7F-416F4C69-A03586A7-A8D56C7FE0778D371CED61AD_see|text=|trigger=button}{sub-section}{sub-section:636FBB7E09893269-AC37CA7F-416F4C69-A03586A7-A8D56C7FE0778D371CED61AD_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:636FBB7E09893269-AC37CA7F-416F4C69-A03586A7-A8D56C7FE0778D371CED61AD_sam|text=|trigger=button}{sub-section}{sub-section:636FBB7E09893269-AC37CA7F-416F4C69-A03586A7-A8D56C7FE0778D371CED61AD_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=F33D4347C1B8DA66-EAA22496-4EE8492D-9B488900-A77F144483E8DC4011670900}{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:F33D4347C1B8DA66-EAA22496-4EE8492D-9B488900-A77F144483E8DC4011670900_des|text=|trigger=button}{sub-section}{sub-section:F33D4347C1B8DA66-EAA22496-4EE8492D-9B488900-A77F144483E8DC4011670900_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:F33D4347C1B8DA66-EAA22496-4EE8492D-9B488900-A77F144483E8DC4011670900_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F33D4347C1B8DA66-EAA22496-4EE8492D-9B488900-A77F144483E8DC4011670900_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:F33D4347C1B8DA66-EAA22496-4EE8492D-9B488900-A77F144483E8DC4011670900_ret|text=|trigger=button}{sub-section}{sub-section:F33D4347C1B8DA66-EAA22496-4EE8492D-9B488900-A77F144483E8DC4011670900_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F33D4347C1B8DA66-EAA22496-4EE8492D-9B488900-A77F144483E8DC4011670900_see|text=|trigger=button}{sub-section}{sub-section:F33D4347C1B8DA66-EAA22496-4EE8492D-9B488900-A77F144483E8DC4011670900_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F33D4347C1B8DA66-EAA22496-4EE8492D-9B488900-A77F144483E8DC4011670900_see|text=|trigger=button}{sub-section}{sub-section:F33D4347C1B8DA66-EAA22496-4EE8492D-9B488900-A77F144483E8DC4011670900_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F33D4347C1B8DA66-EAA22496-4EE8492D-9B488900-A77F144483E8DC4011670900_sam|text=|trigger=button}{sub-section}{sub-section:F33D4347C1B8DA66-EAA22496-4EE8492D-9B488900-A77F144483E8DC4011670900_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=9EB9E80543AA1903-ACBD00BA-47C94804-8BDC83CC-47FF364DA6F0AD45867D70A9}{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:9EB9E80543AA1903-ACBD00BA-47C94804-8BDC83CC-47FF364DA6F0AD45867D70A9_des|text=|trigger=button}{sub-section}{sub-section:9EB9E80543AA1903-ACBD00BA-47C94804-8BDC83CC-47FF364DA6F0AD45867D70A9_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:9EB9E80543AA1903-ACBD00BA-47C94804-8BDC83CC-47FF364DA6F0AD45867D70A9_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9EB9E80543AA1903-ACBD00BA-47C94804-8BDC83CC-47FF364DA6F0AD45867D70A9_prs|trigger=none}targetFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:9EB9E80543AA1903-ACBD00BA-47C94804-8BDC83CC-47FF364DA6F0AD45867D70A9_ret|text=|trigger=button}{sub-section}{sub-section:9EB9E80543AA1903-ACBD00BA-47C94804-8BDC83CC-47FF364DA6F0AD45867D70A9_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:9EB9E80543AA1903-ACBD00BA-47C94804-8BDC83CC-47FF364DA6F0AD45867D70A9_see|text=|trigger=button}{sub-section}{sub-section:9EB9E80543AA1903-ACBD00BA-47C94804-8BDC83CC-47FF364DA6F0AD45867D70A9_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9EB9E80543AA1903-ACBD00BA-47C94804-8BDC83CC-47FF364DA6F0AD45867D70A9_see|text=|trigger=button}{sub-section}{sub-section:9EB9E80543AA1903-ACBD00BA-47C94804-8BDC83CC-47FF364DA6F0AD45867D70A9_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9EB9E80543AA1903-ACBD00BA-47C94804-8BDC83CC-47FF364DA6F0AD45867D70A9_sam|text=|trigger=button}{sub-section}{sub-section:9EB9E80543AA1903-ACBD00BA-47C94804-8BDC83CC-47FF364DA6F0AD45867D70A9_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=3F52524D7C4D4AF3-B1D6D6B1-48C64E1C-84C99A33-37E0BEE031DF93D7941E37BC}{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:3F52524D7C4D4AF3-B1D6D6B1-48C64E1C-84C99A33-37E0BEE031DF93D7941E37BC_des|text=|trigger=button}{sub-section}{sub-section:3F52524D7C4D4AF3-B1D6D6B1-48C64E1C-84C99A33-37E0BEE031DF93D7941E37BC_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:3F52524D7C4D4AF3-B1D6D6B1-48C64E1C-84C99A33-37E0BEE031DF93D7941E37BC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3F52524D7C4D4AF3-B1D6D6B1-48C64E1C-84C99A33-37E0BEE031DF93D7941E37BC_prs|trigger=none}filePrefix
fileSuffix
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:3F52524D7C4D4AF3-B1D6D6B1-48C64E1C-84C99A33-37E0BEE031DF93D7941E37BC_ret|text=|trigger=button}{sub-section}{sub-section:3F52524D7C4D4AF3-B1D6D6B1-48C64E1C-84C99A33-37E0BEE031DF93D7941E37BC_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3F52524D7C4D4AF3-B1D6D6B1-48C64E1C-84C99A33-37E0BEE031DF93D7941E37BC_see|text=|trigger=button}{sub-section}{sub-section:3F52524D7C4D4AF3-B1D6D6B1-48C64E1C-84C99A33-37E0BEE031DF93D7941E37BC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3F52524D7C4D4AF3-B1D6D6B1-48C64E1C-84C99A33-37E0BEE031DF93D7941E37BC_see|text=|trigger=button}{sub-section}{sub-section:3F52524D7C4D4AF3-B1D6D6B1-48C64E1C-84C99A33-37E0BEE031DF93D7941E37BC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3F52524D7C4D4AF3-B1D6D6B1-48C64E1C-84C99A33-37E0BEE031DF93D7941E37BC_sam|text=|trigger=button}{sub-section}{sub-section:3F52524D7C4D4AF3-B1D6D6B1-48C64E1C-84C99A33-37E0BEE031DF93D7941E37BC_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=F674A99BBFFA5DB2-83EE0CB4-4B12461A-BBFD82C2-385C9FDA9499C5B46EB107F8}{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:F674A99BBFFA5DB2-83EE0CB4-4B12461A-BBFD82C2-385C9FDA9499C5B46EB107F8_des|text=|trigger=button}{sub-section}{sub-section:F674A99BBFFA5DB2-83EE0CB4-4B12461A-BBFD82C2-385C9FDA9499C5B46EB107F8_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:F674A99BBFFA5DB2-83EE0CB4-4B12461A-BBFD82C2-385C9FDA9499C5B46EB107F8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F674A99BBFFA5DB2-83EE0CB4-4B12461A-BBFD82C2-385C9FDA9499C5B46EB107F8_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:F674A99BBFFA5DB2-83EE0CB4-4B12461A-BBFD82C2-385C9FDA9499C5B46EB107F8_ret|text=|trigger=button}{sub-section}{sub-section:F674A99BBFFA5DB2-83EE0CB4-4B12461A-BBFD82C2-385C9FDA9499C5B46EB107F8_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F674A99BBFFA5DB2-83EE0CB4-4B12461A-BBFD82C2-385C9FDA9499C5B46EB107F8_see|text=|trigger=button}{sub-section}{sub-section:F674A99BBFFA5DB2-83EE0CB4-4B12461A-BBFD82C2-385C9FDA9499C5B46EB107F8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F674A99BBFFA5DB2-83EE0CB4-4B12461A-BBFD82C2-385C9FDA9499C5B46EB107F8_see|text=|trigger=button}{sub-section}{sub-section:F674A99BBFFA5DB2-83EE0CB4-4B12461A-BBFD82C2-385C9FDA9499C5B46EB107F8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F674A99BBFFA5DB2-83EE0CB4-4B12461A-BBFD82C2-385C9FDA9499C5B46EB107F8_sam|text=|trigger=button}{sub-section}{sub-section:F674A99BBFFA5DB2-83EE0CB4-4B12461A-BBFD82C2-385C9FDA9499C5B46EB107F8_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=E298F05825997931-E5A0E773-452643AE-84F1B6BE-B11DE873C694FFBA967B1A89}{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:E298F05825997931-E5A0E773-452643AE-84F1B6BE-B11DE873C694FFBA967B1A89_des|text=|trigger=button}{sub-section}{sub-section:E298F05825997931-E5A0E773-452643AE-84F1B6BE-B11DE873C694FFBA967B1A89_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:E298F05825997931-E5A0E773-452643AE-84F1B6BE-B11DE873C694FFBA967B1A89_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E298F05825997931-E5A0E773-452643AE-84F1B6BE-B11DE873C694FFBA967B1A89_prs|trigger=none}targetFolder
showWarning
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:E298F05825997931-E5A0E773-452643AE-84F1B6BE-B11DE873C694FFBA967B1A89_ret|text=|trigger=button}{sub-section}{sub-section:E298F05825997931-E5A0E773-452643AE-84F1B6BE-B11DE873C694FFBA967B1A89_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:E298F05825997931-E5A0E773-452643AE-84F1B6BE-B11DE873C694FFBA967B1A89_see|text=|trigger=button}{sub-section}{sub-section:E298F05825997931-E5A0E773-452643AE-84F1B6BE-B11DE873C694FFBA967B1A89_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E298F05825997931-E5A0E773-452643AE-84F1B6BE-B11DE873C694FFBA967B1A89_see|text=|trigger=button}{sub-section}{sub-section:E298F05825997931-E5A0E773-452643AE-84F1B6BE-B11DE873C694FFBA967B1A89_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E298F05825997931-E5A0E773-452643AE-84F1B6BE-B11DE873C694FFBA967B1A89_sam|text=|trigger=button}{sub-section}{sub-section:E298F05825997931-E5A0E773-452643AE-84F1B6BE-B11DE873C694FFBA967B1A89_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=C3783B8A50F778F5-FDD69FA9-4B3C414A-BE94ACB5-485D9227AEFFA18146F62B98}{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:C3783B8A50F778F5-FDD69FA9-4B3C414A-BE94ACB5-485D9227AEFFA18146F62B98_des|text=|trigger=button}{sub-section}{sub-section:C3783B8A50F778F5-FDD69FA9-4B3C414A-BE94ACB5-485D9227AEFFA18146F62B98_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:C3783B8A50F778F5-FDD69FA9-4B3C414A-BE94ACB5-485D9227AEFFA18146F62B98_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C3783B8A50F778F5-FDD69FA9-4B3C414A-BE94ACB5-485D9227AEFFA18146F62B98_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:C3783B8A50F778F5-FDD69FA9-4B3C414A-BE94ACB5-485D9227AEFFA18146F62B98_ret|text=|trigger=button}{sub-section}{sub-section:C3783B8A50F778F5-FDD69FA9-4B3C414A-BE94ACB5-485D9227AEFFA18146F62B98_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C3783B8A50F778F5-FDD69FA9-4B3C414A-BE94ACB5-485D9227AEFFA18146F62B98_see|text=|trigger=button}{sub-section}{sub-section:C3783B8A50F778F5-FDD69FA9-4B3C414A-BE94ACB5-485D9227AEFFA18146F62B98_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C3783B8A50F778F5-FDD69FA9-4B3C414A-BE94ACB5-485D9227AEFFA18146F62B98_see|text=|trigger=button}{sub-section}{sub-section:C3783B8A50F778F5-FDD69FA9-4B3C414A-BE94ACB5-485D9227AEFFA18146F62B98_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C3783B8A50F778F5-FDD69FA9-4B3C414A-BE94ACB5-485D9227AEFFA18146F62B98_sam|text=|trigger=button}{sub-section}{sub-section:C3783B8A50F778F5-FDD69FA9-4B3C414A-BE94ACB5-485D9227AEFFA18146F62B98_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=5FAA20CAF8091A25-10AEC2F8-49BC4455-86F5B299-13C58A354C979DDB52EC5FEB}{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:5FAA20CAF8091A25-10AEC2F8-49BC4455-86F5B299-13C58A354C979DDB52EC5FEB_des|text=|trigger=button}{sub-section}{sub-section:5FAA20CAF8091A25-10AEC2F8-49BC4455-86F5B299-13C58A354C979DDB52EC5FEB_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:5FAA20CAF8091A25-10AEC2F8-49BC4455-86F5B299-13C58A354C979DDB52EC5FEB_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5FAA20CAF8091A25-10AEC2F8-49BC4455-86F5B299-13C58A354C979DDB52EC5FEB_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:5FAA20CAF8091A25-10AEC2F8-49BC4455-86F5B299-13C58A354C979DDB52EC5FEB_ret|text=|trigger=button}{sub-section}{sub-section:5FAA20CAF8091A25-10AEC2F8-49BC4455-86F5B299-13C58A354C979DDB52EC5FEB_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:5FAA20CAF8091A25-10AEC2F8-49BC4455-86F5B299-13C58A354C979DDB52EC5FEB_see|text=|trigger=button}{sub-section}{sub-section:5FAA20CAF8091A25-10AEC2F8-49BC4455-86F5B299-13C58A354C979DDB52EC5FEB_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:5FAA20CAF8091A25-10AEC2F8-49BC4455-86F5B299-13C58A354C979DDB52EC5FEB_see|text=|trigger=button}{sub-section}{sub-section:5FAA20CAF8091A25-10AEC2F8-49BC4455-86F5B299-13C58A354C979DDB52EC5FEB_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:5FAA20CAF8091A25-10AEC2F8-49BC4455-86F5B299-13C58A354C979DDB52EC5FEB_sam|text=|trigger=button}{sub-section}{sub-section:5FAA20CAF8091A25-10AEC2F8-49BC4455-86F5B299-13C58A354C979DDB52EC5FEB_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=246D6879E4E85E8B-70EAE9D2-40614C28-9DBC81F6-6A886E349BD800B3BA23CDEE}{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:246D6879E4E85E8B-70EAE9D2-40614C28-9DBC81F6-6A886E349BD800B3BA23CDEE_des|text=|trigger=button}{sub-section}{sub-section:246D6879E4E85E8B-70EAE9D2-40614C28-9DBC81F6-6A886E349BD800B3BA23CDEE_des|trigger=none|class=sIndent}Returns the size of the specified file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:246D6879E4E85E8B-70EAE9D2-40614C28-9DBC81F6-6A886E349BD800B3BA23CDEE_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:246D6879E4E85E8B-70EAE9D2-40614C28-9DBC81F6-6A886E349BD800B3BA23CDEE_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:246D6879E4E85E8B-70EAE9D2-40614C28-9DBC81F6-6A886E349BD800B3BA23CDEE_ret|text=|trigger=button}{sub-section}{sub-section:246D6879E4E85E8B-70EAE9D2-40614C28-9DBC81F6-6A886E349BD800B3BA23CDEE_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:246D6879E4E85E8B-70EAE9D2-40614C28-9DBC81F6-6A886E349BD800B3BA23CDEE_see|text=|trigger=button}{sub-section}{sub-section:246D6879E4E85E8B-70EAE9D2-40614C28-9DBC81F6-6A886E349BD800B3BA23CDEE_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:246D6879E4E85E8B-70EAE9D2-40614C28-9DBC81F6-6A886E349BD800B3BA23CDEE_see|text=|trigger=button}{sub-section}{sub-section:246D6879E4E85E8B-70EAE9D2-40614C28-9DBC81F6-6A886E349BD800B3BA23CDEE_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:246D6879E4E85E8B-70EAE9D2-40614C28-9DBC81F6-6A886E349BD800B3BA23CDEE_sam|text=|trigger=button}{sub-section}{sub-section:246D6879E4E85E8B-70EAE9D2-40614C28-9DBC81F6-6A886E349BD800B3BA23CDEE_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=FA95CC53A26AC66B-6CB4C186-40A440D4-89B5BBB0-9C6268C0182CBA8EF12F03F1}{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:FA95CC53A26AC66B-6CB4C186-40A440D4-89B5BBB0-9C6268C0182CBA8EF12F03F1_des|text=|trigger=button}{sub-section}{sub-section:FA95CC53A26AC66B-6CB4C186-40A440D4-89B5BBB0-9C6268C0182CBA8EF12F03F1_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:FA95CC53A26AC66B-6CB4C186-40A440D4-89B5BBB0-9C6268C0182CBA8EF12F03F1_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FA95CC53A26AC66B-6CB4C186-40A440D4-89B5BBB0-9C6268C0182CBA8EF12F03F1_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:FA95CC53A26AC66B-6CB4C186-40A440D4-89B5BBB0-9C6268C0182CBA8EF12F03F1_ret|text=|trigger=button}{sub-section}{sub-section:FA95CC53A26AC66B-6CB4C186-40A440D4-89B5BBB0-9C6268C0182CBA8EF12F03F1_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FA95CC53A26AC66B-6CB4C186-40A440D4-89B5BBB0-9C6268C0182CBA8EF12F03F1_see|text=|trigger=button}{sub-section}{sub-section:FA95CC53A26AC66B-6CB4C186-40A440D4-89B5BBB0-9C6268C0182CBA8EF12F03F1_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FA95CC53A26AC66B-6CB4C186-40A440D4-89B5BBB0-9C6268C0182CBA8EF12F03F1_see|text=|trigger=button}{sub-section}{sub-section:FA95CC53A26AC66B-6CB4C186-40A440D4-89B5BBB0-9C6268C0182CBA8EF12F03F1_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FA95CC53A26AC66B-6CB4C186-40A440D4-89B5BBB0-9C6268C0182CBA8EF12F03F1_sam|text=|trigger=button}{sub-section}{sub-section:FA95CC53A26AC66B-6CB4C186-40A440D4-89B5BBB0-9C6268C0182CBA8EF12F03F1_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=638321AE21EE890A-9FEAD8F2-43C44B78-B3D190B1-CBADC489EC18E54861EB2733}{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:638321AE21EE890A-9FEAD8F2-43C44B78-B3D190B1-CBADC489EC18E54861EB2733_des|text=|trigger=button}{sub-section}{sub-section:638321AE21EE890A-9FEAD8F2-43C44B78-B3D190B1-CBADC489EC18E54861EB2733_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:638321AE21EE890A-9FEAD8F2-43C44B78-B3D190B1-CBADC489EC18E54861EB2733_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:638321AE21EE890A-9FEAD8F2-43C44B78-B3D190B1-CBADC489EC18E54861EB2733_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:638321AE21EE890A-9FEAD8F2-43C44B78-B3D190B1-CBADC489EC18E54861EB2733_ret|text=|trigger=button}{sub-section}{sub-section:638321AE21EE890A-9FEAD8F2-43C44B78-B3D190B1-CBADC489EC18E54861EB2733_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:638321AE21EE890A-9FEAD8F2-43C44B78-B3D190B1-CBADC489EC18E54861EB2733_see|text=|trigger=button}{sub-section}{sub-section:638321AE21EE890A-9FEAD8F2-43C44B78-B3D190B1-CBADC489EC18E54861EB2733_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:638321AE21EE890A-9FEAD8F2-43C44B78-B3D190B1-CBADC489EC18E54861EB2733_see|text=|trigger=button}{sub-section}{sub-section:638321AE21EE890A-9FEAD8F2-43C44B78-B3D190B1-CBADC489EC18E54861EB2733_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:638321AE21EE890A-9FEAD8F2-43C44B78-B3D190B1-CBADC489EC18E54861EB2733_sam|text=|trigger=button}{sub-section}{sub-section:638321AE21EE890A-9FEAD8F2-43C44B78-B3D190B1-CBADC489EC18E54861EB2733_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=3F0DB285029696D0-53E5D364-42BB4687-9BAFB797-2BA7CCB9BC95FFA9A9002D64}{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:3F0DB285029696D0-53E5D364-42BB4687-9BAFB797-2BA7CCB9BC95FFA9A9002D64_des|text=|trigger=button}{sub-section}{sub-section:3F0DB285029696D0-53E5D364-42BB4687-9BAFB797-2BA7CCB9BC95FFA9A9002D64_des|trigger=none|class=sIndent}Returns the modification date of a file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:3F0DB285029696D0-53E5D364-42BB4687-9BAFB797-2BA7CCB9BC95FFA9A9002D64_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3F0DB285029696D0-53E5D364-42BB4687-9BAFB797-2BA7CCB9BC95FFA9A9002D64_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:3F0DB285029696D0-53E5D364-42BB4687-9BAFB797-2BA7CCB9BC95FFA9A9002D64_ret|text=|trigger=button}{sub-section}{sub-section:3F0DB285029696D0-53E5D364-42BB4687-9BAFB797-2BA7CCB9BC95FFA9A9002D64_ret|trigger=none|class=sIndent}[Date]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3F0DB285029696D0-53E5D364-42BB4687-9BAFB797-2BA7CCB9BC95FFA9A9002D64_see|text=|trigger=button}{sub-section}{sub-section:3F0DB285029696D0-53E5D364-42BB4687-9BAFB797-2BA7CCB9BC95FFA9A9002D64_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3F0DB285029696D0-53E5D364-42BB4687-9BAFB797-2BA7CCB9BC95FFA9A9002D64_see|text=|trigger=button}{sub-section}{sub-section:3F0DB285029696D0-53E5D364-42BB4687-9BAFB797-2BA7CCB9BC95FFA9A9002D64_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3F0DB285029696D0-53E5D364-42BB4687-9BAFB797-2BA7CCB9BC95FFA9A9002D64_sam|text=|trigger=button}{sub-section}{sub-section:3F0DB285029696D0-53E5D364-42BB4687-9BAFB797-2BA7CCB9BC95FFA9A9002D64_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=3F9680EED21B2C0F-3FFC8C74-44A74916-A493BEA2-CA2DD58C0604BE9496529026}{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:3F9680EED21B2C0F-3FFC8C74-44A74916-A493BEA2-CA2DD58C0604BE9496529026_des|text=|trigger=button}{sub-section}{sub-section:3F9680EED21B2C0F-3FFC8C74-44A74916-A493BEA2-CA2DD58C0604BE9496529026_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:3F9680EED21B2C0F-3FFC8C74-44A74916-A493BEA2-CA2DD58C0604BE9496529026_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3F9680EED21B2C0F-3FFC8C74-44A74916-A493BEA2-CA2DD58C0604BE9496529026_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:3F9680EED21B2C0F-3FFC8C74-44A74916-A493BEA2-CA2DD58C0604BE9496529026_ret|text=|trigger=button}{sub-section}{sub-section:3F9680EED21B2C0F-3FFC8C74-44A74916-A493BEA2-CA2DD58C0604BE9496529026_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3F9680EED21B2C0F-3FFC8C74-44A74916-A493BEA2-CA2DD58C0604BE9496529026_see|text=|trigger=button}{sub-section}{sub-section:3F9680EED21B2C0F-3FFC8C74-44A74916-A493BEA2-CA2DD58C0604BE9496529026_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3F9680EED21B2C0F-3FFC8C74-44A74916-A493BEA2-CA2DD58C0604BE9496529026_see|text=|trigger=button}{sub-section}{sub-section:3F9680EED21B2C0F-3FFC8C74-44A74916-A493BEA2-CA2DD58C0604BE9496529026_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3F9680EED21B2C0F-3FFC8C74-44A74916-A493BEA2-CA2DD58C0604BE9496529026_sam|text=|trigger=button}{sub-section}{sub-section:3F9680EED21B2C0F-3FFC8C74-44A74916-A493BEA2-CA2DD58C0604BE9496529026_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=282E96C82546D0F6-4AB7E601-4D1D4510-B82595D9-762C219585F635DED36EFCC7}{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:282E96C82546D0F6-4AB7E601-4D1D4510-B82595D9-762C219585F635DED36EFCC7_des|text=|trigger=button}{sub-section}{sub-section:282E96C82546D0F6-4AB7E601-4D1D4510-B82595D9-762C219585F635DED36EFCC7_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:282E96C82546D0F6-4AB7E601-4D1D4510-B82595D9-762C219585F635DED36EFCC7_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:282E96C82546D0F6-4AB7E601-4D1D4510-B82595D9-762C219585F635DED36EFCC7_prs|trigger=none}\[file\]
\[size\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:282E96C82546D0F6-4AB7E601-4D1D4510-B82595D9-762C219585F635DED36EFCC7_ret|text=|trigger=button}{sub-section}{sub-section:282E96C82546D0F6-4AB7E601-4D1D4510-B82595D9-762C219585F635DED36EFCC7_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:282E96C82546D0F6-4AB7E601-4D1D4510-B82595D9-762C219585F635DED36EFCC7_see|text=|trigger=button}{sub-section}{sub-section:282E96C82546D0F6-4AB7E601-4D1D4510-B82595D9-762C219585F635DED36EFCC7_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:282E96C82546D0F6-4AB7E601-4D1D4510-B82595D9-762C219585F635DED36EFCC7_see|text=|trigger=button}{sub-section}{sub-section:282E96C82546D0F6-4AB7E601-4D1D4510-B82595D9-762C219585F635DED36EFCC7_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:282E96C82546D0F6-4AB7E601-4D1D4510-B82595D9-762C219585F635DED36EFCC7_sam|text=|trigger=button}{sub-section}{sub-section:282E96C82546D0F6-4AB7E601-4D1D4510-B82595D9-762C219585F635DED36EFCC7_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=5D33EBDF44528FBB-5B409D1A-4ED04FFE-861BBA3D-DB3D81FDAF337F4B7DBAD942}{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:5D33EBDF44528FBB-5B409D1A-4ED04FFE-861BBA3D-DB3D81FDAF337F4B7DBAD942_des|text=|trigger=button}{sub-section}{sub-section:5D33EBDF44528FBB-5B409D1A-4ED04FFE-861BBA3D-DB3D81FDAF337F4B7DBAD942_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:5D33EBDF44528FBB-5B409D1A-4ED04FFE-861BBA3D-DB3D81FDAF337F4B7DBAD942_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5D33EBDF44528FBB-5B409D1A-4ED04FFE-861BBA3D-DB3D81FDAF337F4B7DBAD942_prs|trigger=none}\[file\]
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:5D33EBDF44528FBB-5B409D1A-4ED04FFE-861BBA3D-DB3D81FDAF337F4B7DBAD942_ret|text=|trigger=button}{sub-section}{sub-section:5D33EBDF44528FBB-5B409D1A-4ED04FFE-861BBA3D-DB3D81FDAF337F4B7DBAD942_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:5D33EBDF44528FBB-5B409D1A-4ED04FFE-861BBA3D-DB3D81FDAF337F4B7DBAD942_see|text=|trigger=button}{sub-section}{sub-section:5D33EBDF44528FBB-5B409D1A-4ED04FFE-861BBA3D-DB3D81FDAF337F4B7DBAD942_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:5D33EBDF44528FBB-5B409D1A-4ED04FFE-861BBA3D-DB3D81FDAF337F4B7DBAD942_see|text=|trigger=button}{sub-section}{sub-section:5D33EBDF44528FBB-5B409D1A-4ED04FFE-861BBA3D-DB3D81FDAF337F4B7DBAD942_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:5D33EBDF44528FBB-5B409D1A-4ED04FFE-861BBA3D-DB3D81FDAF337F4B7DBAD942_sam|text=|trigger=button}{sub-section}{sub-section:5D33EBDF44528FBB-5B409D1A-4ED04FFE-861BBA3D-DB3D81FDAF337F4B7DBAD942_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=84AA56F941394DD6-3351F5C8-458D4F6E-BD7DBEDB-F2FBCFFB07792B67B977870F}{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:84AA56F941394DD6-3351F5C8-458D4F6E-BD7DBEDB-F2FBCFFB07792B67B977870F_des|text=|trigger=button}{sub-section}{sub-section:84AA56F941394DD6-3351F5C8-458D4F6E-BD7DBEDB-F2FBCFFB07792B67B977870F_des|trigger=none|class=sIndent}Shows a directory selector dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:84AA56F941394DD6-3351F5C8-458D4F6E-BD7DBEDB-F2FBCFFB07792B67B977870F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:84AA56F941394DD6-3351F5C8-458D4F6E-BD7DBEDB-F2FBCFFB07792B67B977870F_prs|trigger=none}\[directory suggestion\]
\[dialog title text\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:84AA56F941394DD6-3351F5C8-458D4F6E-BD7DBEDB-F2FBCFFB07792B67B977870F_ret|text=|trigger=button}{sub-section}{sub-section:84AA56F941394DD6-3351F5C8-458D4F6E-BD7DBEDB-F2FBCFFB07792B67B977870F_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:84AA56F941394DD6-3351F5C8-458D4F6E-BD7DBEDB-F2FBCFFB07792B67B977870F_see|text=|trigger=button}{sub-section}{sub-section:84AA56F941394DD6-3351F5C8-458D4F6E-BD7DBEDB-F2FBCFFB07792B67B977870F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:84AA56F941394DD6-3351F5C8-458D4F6E-BD7DBEDB-F2FBCFFB07792B67B977870F_see|text=|trigger=button}{sub-section}{sub-section:84AA56F941394DD6-3351F5C8-458D4F6E-BD7DBEDB-F2FBCFFB07792B67B977870F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:84AA56F941394DD6-3351F5C8-458D4F6E-BD7DBEDB-F2FBCFFB07792B67B977870F_sam|text=|trigger=button}{sub-section}{sub-section:84AA56F941394DD6-3351F5C8-458D4F6E-BD7DBEDB-F2FBCFFB07792B67B977870F_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=0D654245EBF422D5-CB5DEC4C-40594C7E-94B49FA6-11B9ADC955EDC89FAA5F967D}{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:0D654245EBF422D5-CB5DEC4C-40594C7E-94B49FA6-11B9ADC955EDC89FAA5F967D_des|text=|trigger=button}{sub-section}{sub-section:0D654245EBF422D5-CB5DEC4C-40594C7E-94B49FA6-11B9ADC955EDC89FAA5F967D_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:0D654245EBF422D5-CB5DEC4C-40594C7E-94B49FA6-11B9ADC955EDC89FAA5F967D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0D654245EBF422D5-CB5DEC4C-40594C7E-94B49FA6-11B9ADC955EDC89FAA5F967D_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:0D654245EBF422D5-CB5DEC4C-40594C7E-94B49FA6-11B9ADC955EDC89FAA5F967D_ret|text=|trigger=button}{sub-section}{sub-section:0D654245EBF422D5-CB5DEC4C-40594C7E-94B49FA6-11B9ADC955EDC89FAA5F967D_ret|trigger=none|class=sIndent}Object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:0D654245EBF422D5-CB5DEC4C-40594C7E-94B49FA6-11B9ADC955EDC89FAA5F967D_see|text=|trigger=button}{sub-section}{sub-section:0D654245EBF422D5-CB5DEC4C-40594C7E-94B49FA6-11B9ADC955EDC89FAA5F967D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:0D654245EBF422D5-CB5DEC4C-40594C7E-94B49FA6-11B9ADC955EDC89FAA5F967D_see|text=|trigger=button}{sub-section}{sub-section:0D654245EBF422D5-CB5DEC4C-40594C7E-94B49FA6-11B9ADC955EDC89FAA5F967D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:0D654245EBF422D5-CB5DEC4C-40594C7E-94B49FA6-11B9ADC955EDC89FAA5F967D_sam|text=|trigger=button}{sub-section}{sub-section:0D654245EBF422D5-CB5DEC4C-40594C7E-94B49FA6-11B9ADC955EDC89FAA5F967D_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=89C302C19D226C19-6DB826DB-46134101-A4179BA6-A10500A6C5327FE54D724C48}{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:89C302C19D226C19-6DB826DB-46134101-A4179BA6-A10500A6C5327FE54D724C48_des|text=|trigger=button}{sub-section}{sub-section:89C302C19D226C19-6DB826DB-46134101-A4179BA6-A10500A6C5327FE54D724C48_des|trigger=none|class=sIndent}Shows a file save dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:89C302C19D226C19-6DB826DB-46134101-A4179BA6-A10500A6C5327FE54D724C48_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:89C302C19D226C19-6DB826DB-46134101-A4179BA6-A10500A6C5327FE54D724C48_prs|trigger=none}\[fileName/dir suggestion\]
\[dialog title text\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:89C302C19D226C19-6DB826DB-46134101-A4179BA6-A10500A6C5327FE54D724C48_ret|text=|trigger=button}{sub-section}{sub-section:89C302C19D226C19-6DB826DB-46134101-A4179BA6-A10500A6C5327FE54D724C48_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:89C302C19D226C19-6DB826DB-46134101-A4179BA6-A10500A6C5327FE54D724C48_see|text=|trigger=button}{sub-section}{sub-section:89C302C19D226C19-6DB826DB-46134101-A4179BA6-A10500A6C5327FE54D724C48_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:89C302C19D226C19-6DB826DB-46134101-A4179BA6-A10500A6C5327FE54D724C48_see|text=|trigger=button}{sub-section}{sub-section:89C302C19D226C19-6DB826DB-46134101-A4179BA6-A10500A6C5327FE54D724C48_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:89C302C19D226C19-6DB826DB-46134101-A4179BA6-A10500A6C5327FE54D724C48_sam|text=|trigger=button}{sub-section}{sub-section:89C302C19D226C19-6DB826DB-46134101-A4179BA6-A10500A6C5327FE54D724C48_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=CBE726FFBD975EB9-F1A54CAA-45284F65-9749A071-6DF7ED594B3680286149DD74}{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:CBE726FFBD975EB9-F1A54CAA-45284F65-9749A071-6DF7ED594B3680286149DD74_des|text=|trigger=button}{sub-section}{sub-section:CBE726FFBD975EB9-F1A54CAA-45284F65-9749A071-6DF7ED594B3680286149DD74_des|trigger=none|class=sIndent}Writes data into a binary file. (Web Enabled){sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:CBE726FFBD975EB9-F1A54CAA-45284F65-9749A071-6DF7ED594B3680286149DD74_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:CBE726FFBD975EB9-F1A54CAA-45284F65-9749A071-6DF7ED594B3680286149DD74_prs|trigger=none}file
binary_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:CBE726FFBD975EB9-F1A54CAA-45284F65-9749A071-6DF7ED594B3680286149DD74_ret|text=|trigger=button}{sub-section}{sub-section:CBE726FFBD975EB9-F1A54CAA-45284F65-9749A071-6DF7ED594B3680286149DD74_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:CBE726FFBD975EB9-F1A54CAA-45284F65-9749A071-6DF7ED594B3680286149DD74_see|text=|trigger=button}{sub-section}{sub-section:CBE726FFBD975EB9-F1A54CAA-45284F65-9749A071-6DF7ED594B3680286149DD74_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:CBE726FFBD975EB9-F1A54CAA-45284F65-9749A071-6DF7ED594B3680286149DD74_see|text=|trigger=button}{sub-section}{sub-section:CBE726FFBD975EB9-F1A54CAA-45284F65-9749A071-6DF7ED594B3680286149DD74_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:CBE726FFBD975EB9-F1A54CAA-45284F65-9749A071-6DF7ED594B3680286149DD74_sam|text=|trigger=button}{sub-section}{sub-section:CBE726FFBD975EB9-F1A54CAA-45284F65-9749A071-6DF7ED594B3680286149DD74_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=A797C3A83F2DC601-F40F6C15-48464DE1-A0DA95F6-511ADB80F174BEA08E2547C8}{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:A797C3A83F2DC601-F40F6C15-48464DE1-A0DA95F6-511ADB80F174BEA08E2547C8_des|text=|trigger=button}{sub-section}{sub-section:A797C3A83F2DC601-F40F6C15-48464DE1-A0DA95F6-511ADB80F174BEA08E2547C8_des|trigger=none|class=sIndent}Writes data into a text file. (Web Enabled){sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:A797C3A83F2DC601-F40F6C15-48464DE1-A0DA95F6-511ADB80F174BEA08E2547C8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A797C3A83F2DC601-F40F6C15-48464DE1-A0DA95F6-511ADB80F174BEA08E2547C8_prs|trigger=none}file
text_data
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:A797C3A83F2DC601-F40F6C15-48464DE1-A0DA95F6-511ADB80F174BEA08E2547C8_ret|text=|trigger=button}{sub-section}{sub-section:A797C3A83F2DC601-F40F6C15-48464DE1-A0DA95F6-511ADB80F174BEA08E2547C8_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:A797C3A83F2DC601-F40F6C15-48464DE1-A0DA95F6-511ADB80F174BEA08E2547C8_see|text=|trigger=button}{sub-section}{sub-section:A797C3A83F2DC601-F40F6C15-48464DE1-A0DA95F6-511ADB80F174BEA08E2547C8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:A797C3A83F2DC601-F40F6C15-48464DE1-A0DA95F6-511ADB80F174BEA08E2547C8_see|text=|trigger=button}{sub-section}{sub-section:A797C3A83F2DC601-F40F6C15-48464DE1-A0DA95F6-511ADB80F174BEA08E2547C8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:A797C3A83F2DC601-F40F6C15-48464DE1-A0DA95F6-511ADB80F174BEA08E2547C8_sam|text=|trigger=button}{sub-section}{sub-section:A797C3A83F2DC601-F40F6C15-48464DE1-A0DA95F6-511ADB80F174BEA08E2547C8_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=7DEC875BCDF36029-9962ADC0-43F24330-8FBFAC06-F6A085BC011C57E4236148FB}{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:7DEC875BCDF36029-9962ADC0-43F24330-8FBFAC06-F6A085BC011C57E4236148FB_des|text=|trigger=button}{sub-section}{sub-section:7DEC875BCDF36029-9962ADC0-43F24330-8FBFAC06-F6A085BC011C57E4236148FB_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:7DEC875BCDF36029-9962ADC0-43F24330-8FBFAC06-F6A085BC011C57E4236148FB_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7DEC875BCDF36029-9962ADC0-43F24330-8FBFAC06-F6A085BC011C57E4236148FB_prs|trigger=none}file
xml_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:7DEC875BCDF36029-9962ADC0-43F24330-8FBFAC06-F6A085BC011C57E4236148FB_ret|text=|trigger=button}{sub-section}{sub-section:7DEC875BCDF36029-9962ADC0-43F24330-8FBFAC06-F6A085BC011C57E4236148FB_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:7DEC875BCDF36029-9962ADC0-43F24330-8FBFAC06-F6A085BC011C57E4236148FB_see|text=|trigger=button}{sub-section}{sub-section:7DEC875BCDF36029-9962ADC0-43F24330-8FBFAC06-F6A085BC011C57E4236148FB_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:7DEC875BCDF36029-9962ADC0-43F24330-8FBFAC06-F6A085BC011C57E4236148FB_see|text=|trigger=button}{sub-section}{sub-section:7DEC875BCDF36029-9962ADC0-43F24330-8FBFAC06-F6A085BC011C57E4236148FB_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:7DEC875BCDF36029-9962ADC0-43F24330-8FBFAC06-F6A085BC011C57E4236148FB_sam|text=|trigger=button}{sub-section}{sub-section:7DEC875BCDF36029-9962ADC0-43F24330-8FBFAC06-F6A085BC011C57E4236148FB_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}