Page History

Wiki Markup
{hidden}
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden}
{sub-section:description|text=}{sub-section}\\{table:class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Return Types{th}{tr}{tr}{td}{span:class=sWordList}[JSFile]{span}{td}{tr}{table}\\{table:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[JSFile]{td}{td}[#convertToJSFile]\(file)
Returns a JSFile instance corresponding to an alternative representation of a file (for example a string).{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#copyFile]\(sourceFile, destinationFile)
Copies the sourcefile to the destination file.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#copyFolder]\(sourceFolder, destinationFolder)
Copies the sourcefolder to the destination folder, recursively.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#createFile]\(targetFile)
Creates a JSFile instance.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#createFolder]\(targetFolder)
Creates a folder on disk.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#createTempFile]\(filePrefix, fileSuffix)
Creates a temporary file on disk.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#deleteFile]\(targetFile)
Removes a file from disk.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#deleteFolder]\(targetFolder, showWarning)
Deletes a folder from disk recursively.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#getDesktopFolder]\()
Returns a JSFile instance that corresponds to the Desktop folder of the currently logged in user.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]\[]{td}{td}[#getDiskList]\()
Returns an Array of JSFile instances correponding to the file system root folders.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getFileSize]\(targetFile)
Returns the size of the specified file.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]\[]{td}{td}[#getFolderContents]\(targetFolder, fileFilter, fileOption(1=files,2=dirs), visibleOption(1=visible,2=nonvisible), lockedOption(1=locked,2=nonlocked))
Returns an array of JSFile instances corresponding to content of the specified folder.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#getHomeDirectory]\()
Returns a JSFile instance corresponding to the home folder of the logged in used.{td}{tr}{tbody}{tbody}{tr}{td}[Date]{td}{td}[#getModificationDate]\(targetFile)
Returns the modification date of a file.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#moveFile]\(sourceFile, destinationFile)
Moves the file from the source to the destination place.{td}{tr}{tbody}{tbody}{tr}{td}byte[]{td}{td}[#readFile]\(file, size)
Reads all or part of the content from a binary file.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#readTXTFile]\(file, charsetname)
Read all content from a text file.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#showDirectorySelectDialog]\(directory suggestion)
Shows a directory selector dialog.{td}{tr}{tbody}{tbody}{tr}{td}Object{td}{td}[#showFileOpenDialog]\(selectionMode(0=both,1=Files,2=Dirs), startDirectory(null=default/previous), multiselect(true/false), filterarray)
Shows a file open dialog.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#showFileSaveDialog]\(fileName/dir suggestion)
Shows a file save dialog.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#writeFile]\(file, binary_data)
Writes data into a binary file.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#writeTXTFile]\(file, text_data, charsetname)
Writes data into a text file.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#writeXMLFile]\(file, xml_data)
Writes data into an XML file.{td}{tr}{tbody}{table}\\{table:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=DA7C67731CDDE858-0538B720-46BF4EFD-AC9A93B7-1085D6A8D4ACBE14A5BB51DE}{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:DA7C67731CDDE858-0538B720-46BF4EFD-AC9A93B7-1085D6A8D4ACBE14A5BB51DE_des|text=|trigger=button}{sub-section}{sub-section:DA7C67731CDDE858-0538B720-46BF4EFD-AC9A93B7-1085D6A8D4ACBE14A5BB51DE_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:DA7C67731CDDE858-0538B720-46BF4EFD-AC9A93B7-1085D6A8D4ACBE14A5BB51DE_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DA7C67731CDDE858-0538B720-46BF4EFD-AC9A93B7-1085D6A8D4ACBE14A5BB51DE_prs|trigger=none}file
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:DA7C67731CDDE858-0538B720-46BF4EFD-AC9A93B7-1085D6A8D4ACBE14A5BB51DE_ret|text=|trigger=button}{sub-section}{sub-section:DA7C67731CDDE858-0538B720-46BF4EFD-AC9A93B7-1085D6A8D4ACBE14A5BB51DE_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:DA7C67731CDDE858-0538B720-46BF4EFD-AC9A93B7-1085D6A8D4ACBE14A5BB51DE_see|text=|trigger=button}{sub-section}{sub-section:DA7C67731CDDE858-0538B720-46BF4EFD-AC9A93B7-1085D6A8D4ACBE14A5BB51DE_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DA7C67731CDDE858-0538B720-46BF4EFD-AC9A93B7-1085D6A8D4ACBE14A5BB51DE_see|text=|trigger=button}{sub-section}{sub-section:DA7C67731CDDE858-0538B720-46BF4EFD-AC9A93B7-1085D6A8D4ACBE14A5BB51DE_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DA7C67731CDDE858-0538B720-46BF4EFD-AC9A93B7-1085D6A8D4ACBE14A5BB51DE_sam|text=|trigger=button}{sub-section}{sub-section:DA7C67731CDDE858-0538B720-46BF4EFD-AC9A93B7-1085D6A8D4ACBE14A5BB51DE_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=A35ED65961FBA5E3-331DBA69-47484706-851C9BE4-5A1EB9C423A2917CF20DE8A2}{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:A35ED65961FBA5E3-331DBA69-47484706-851C9BE4-5A1EB9C423A2917CF20DE8A2_des|text=|trigger=button}{sub-section}{sub-section:A35ED65961FBA5E3-331DBA69-47484706-851C9BE4-5A1EB9C423A2917CF20DE8A2_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:A35ED65961FBA5E3-331DBA69-47484706-851C9BE4-5A1EB9C423A2917CF20DE8A2_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A35ED65961FBA5E3-331DBA69-47484706-851C9BE4-5A1EB9C423A2917CF20DE8A2_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:A35ED65961FBA5E3-331DBA69-47484706-851C9BE4-5A1EB9C423A2917CF20DE8A2_ret|text=|trigger=button}{sub-section}{sub-section:A35ED65961FBA5E3-331DBA69-47484706-851C9BE4-5A1EB9C423A2917CF20DE8A2_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:A35ED65961FBA5E3-331DBA69-47484706-851C9BE4-5A1EB9C423A2917CF20DE8A2_see|text=|trigger=button}{sub-section}{sub-section:A35ED65961FBA5E3-331DBA69-47484706-851C9BE4-5A1EB9C423A2917CF20DE8A2_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:A35ED65961FBA5E3-331DBA69-47484706-851C9BE4-5A1EB9C423A2917CF20DE8A2_see|text=|trigger=button}{sub-section}{sub-section:A35ED65961FBA5E3-331DBA69-47484706-851C9BE4-5A1EB9C423A2917CF20DE8A2_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:A35ED65961FBA5E3-331DBA69-47484706-851C9BE4-5A1EB9C423A2917CF20DE8A2_sam|text=|trigger=button}{sub-section}{sub-section:A35ED65961FBA5E3-331DBA69-47484706-851C9BE4-5A1EB9C423A2917CF20DE8A2_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=F0BE16D40C3A0717-B1FF98D0-43A24A6D-93B6BEFC-A7A69C58E3C60F3C58D0A6E9}{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:F0BE16D40C3A0717-B1FF98D0-43A24A6D-93B6BEFC-A7A69C58E3C60F3C58D0A6E9_des|text=|trigger=button}{sub-section}{sub-section:F0BE16D40C3A0717-B1FF98D0-43A24A6D-93B6BEFC-A7A69C58E3C60F3C58D0A6E9_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:F0BE16D40C3A0717-B1FF98D0-43A24A6D-93B6BEFC-A7A69C58E3C60F3C58D0A6E9_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F0BE16D40C3A0717-B1FF98D0-43A24A6D-93B6BEFC-A7A69C58E3C60F3C58D0A6E9_prs|trigger=none}sourceFolder
destinationFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:F0BE16D40C3A0717-B1FF98D0-43A24A6D-93B6BEFC-A7A69C58E3C60F3C58D0A6E9_ret|text=|trigger=button}{sub-section}{sub-section:F0BE16D40C3A0717-B1FF98D0-43A24A6D-93B6BEFC-A7A69C58E3C60F3C58D0A6E9_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F0BE16D40C3A0717-B1FF98D0-43A24A6D-93B6BEFC-A7A69C58E3C60F3C58D0A6E9_see|text=|trigger=button}{sub-section}{sub-section:F0BE16D40C3A0717-B1FF98D0-43A24A6D-93B6BEFC-A7A69C58E3C60F3C58D0A6E9_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F0BE16D40C3A0717-B1FF98D0-43A24A6D-93B6BEFC-A7A69C58E3C60F3C58D0A6E9_see|text=|trigger=button}{sub-section}{sub-section:F0BE16D40C3A0717-B1FF98D0-43A24A6D-93B6BEFC-A7A69C58E3C60F3C58D0A6E9_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F0BE16D40C3A0717-B1FF98D0-43A24A6D-93B6BEFC-A7A69C58E3C60F3C58D0A6E9_sam|text=|trigger=button}{sub-section}{sub-section:F0BE16D40C3A0717-B1FF98D0-43A24A6D-93B6BEFC-A7A69C58E3C60F3C58D0A6E9_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=D128E10AF5A5DDA8-012C3B83-41AA40DC-967286ED-4A16F447CE13C4A86A37495E}{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:D128E10AF5A5DDA8-012C3B83-41AA40DC-967286ED-4A16F447CE13C4A86A37495E_des|text=|trigger=button}{sub-section}{sub-section:D128E10AF5A5DDA8-012C3B83-41AA40DC-967286ED-4A16F447CE13C4A86A37495E_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:D128E10AF5A5DDA8-012C3B83-41AA40DC-967286ED-4A16F447CE13C4A86A37495E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D128E10AF5A5DDA8-012C3B83-41AA40DC-967286ED-4A16F447CE13C4A86A37495E_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:D128E10AF5A5DDA8-012C3B83-41AA40DC-967286ED-4A16F447CE13C4A86A37495E_ret|text=|trigger=button}{sub-section}{sub-section:D128E10AF5A5DDA8-012C3B83-41AA40DC-967286ED-4A16F447CE13C4A86A37495E_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D128E10AF5A5DDA8-012C3B83-41AA40DC-967286ED-4A16F447CE13C4A86A37495E_see|text=|trigger=button}{sub-section}{sub-section:D128E10AF5A5DDA8-012C3B83-41AA40DC-967286ED-4A16F447CE13C4A86A37495E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D128E10AF5A5DDA8-012C3B83-41AA40DC-967286ED-4A16F447CE13C4A86A37495E_see|text=|trigger=button}{sub-section}{sub-section:D128E10AF5A5DDA8-012C3B83-41AA40DC-967286ED-4A16F447CE13C4A86A37495E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D128E10AF5A5DDA8-012C3B83-41AA40DC-967286ED-4A16F447CE13C4A86A37495E_sam|text=|trigger=button}{sub-section}{sub-section:D128E10AF5A5DDA8-012C3B83-41AA40DC-967286ED-4A16F447CE13C4A86A37495E_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=81D722DAD58857F5-C4C30628-45FD401C-A65A8B08-0D3F5DD6EB2361858F997B1C}{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:81D722DAD58857F5-C4C30628-45FD401C-A65A8B08-0D3F5DD6EB2361858F997B1C_des|text=|trigger=button}{sub-section}{sub-section:81D722DAD58857F5-C4C30628-45FD401C-A65A8B08-0D3F5DD6EB2361858F997B1C_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:81D722DAD58857F5-C4C30628-45FD401C-A65A8B08-0D3F5DD6EB2361858F997B1C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:81D722DAD58857F5-C4C30628-45FD401C-A65A8B08-0D3F5DD6EB2361858F997B1C_prs|trigger=none}targetFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:81D722DAD58857F5-C4C30628-45FD401C-A65A8B08-0D3F5DD6EB2361858F997B1C_ret|text=|trigger=button}{sub-section}{sub-section:81D722DAD58857F5-C4C30628-45FD401C-A65A8B08-0D3F5DD6EB2361858F997B1C_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:81D722DAD58857F5-C4C30628-45FD401C-A65A8B08-0D3F5DD6EB2361858F997B1C_see|text=|trigger=button}{sub-section}{sub-section:81D722DAD58857F5-C4C30628-45FD401C-A65A8B08-0D3F5DD6EB2361858F997B1C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:81D722DAD58857F5-C4C30628-45FD401C-A65A8B08-0D3F5DD6EB2361858F997B1C_see|text=|trigger=button}{sub-section}{sub-section:81D722DAD58857F5-C4C30628-45FD401C-A65A8B08-0D3F5DD6EB2361858F997B1C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:81D722DAD58857F5-C4C30628-45FD401C-A65A8B08-0D3F5DD6EB2361858F997B1C_sam|text=|trigger=button}{sub-section}{sub-section:81D722DAD58857F5-C4C30628-45FD401C-A65A8B08-0D3F5DD6EB2361858F997B1C_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=4BCCDA21958D1556-F0F2930E-4C784361-92F08CA4-2A76EACB70AD63858263619B}{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:4BCCDA21958D1556-F0F2930E-4C784361-92F08CA4-2A76EACB70AD63858263619B_des|text=|trigger=button}{sub-section}{sub-section:4BCCDA21958D1556-F0F2930E-4C784361-92F08CA4-2A76EACB70AD63858263619B_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:4BCCDA21958D1556-F0F2930E-4C784361-92F08CA4-2A76EACB70AD63858263619B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:4BCCDA21958D1556-F0F2930E-4C784361-92F08CA4-2A76EACB70AD63858263619B_prs|trigger=none}filePrefix
fileSuffix
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:4BCCDA21958D1556-F0F2930E-4C784361-92F08CA4-2A76EACB70AD63858263619B_ret|text=|trigger=button}{sub-section}{sub-section:4BCCDA21958D1556-F0F2930E-4C784361-92F08CA4-2A76EACB70AD63858263619B_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:4BCCDA21958D1556-F0F2930E-4C784361-92F08CA4-2A76EACB70AD63858263619B_see|text=|trigger=button}{sub-section}{sub-section:4BCCDA21958D1556-F0F2930E-4C784361-92F08CA4-2A76EACB70AD63858263619B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:4BCCDA21958D1556-F0F2930E-4C784361-92F08CA4-2A76EACB70AD63858263619B_see|text=|trigger=button}{sub-section}{sub-section:4BCCDA21958D1556-F0F2930E-4C784361-92F08CA4-2A76EACB70AD63858263619B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:4BCCDA21958D1556-F0F2930E-4C784361-92F08CA4-2A76EACB70AD63858263619B_sam|text=|trigger=button}{sub-section}{sub-section:4BCCDA21958D1556-F0F2930E-4C784361-92F08CA4-2A76EACB70AD63858263619B_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=5E77424891607541-3542EAAB-4BCB486C-911AB433-09835B6C2AB81C9A982A0313}{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:5E77424891607541-3542EAAB-4BCB486C-911AB433-09835B6C2AB81C9A982A0313_des|text=|trigger=button}{sub-section}{sub-section:5E77424891607541-3542EAAB-4BCB486C-911AB433-09835B6C2AB81C9A982A0313_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:5E77424891607541-3542EAAB-4BCB486C-911AB433-09835B6C2AB81C9A982A0313_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5E77424891607541-3542EAAB-4BCB486C-911AB433-09835B6C2AB81C9A982A0313_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:5E77424891607541-3542EAAB-4BCB486C-911AB433-09835B6C2AB81C9A982A0313_ret|text=|trigger=button}{sub-section}{sub-section:5E77424891607541-3542EAAB-4BCB486C-911AB433-09835B6C2AB81C9A982A0313_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:5E77424891607541-3542EAAB-4BCB486C-911AB433-09835B6C2AB81C9A982A0313_see|text=|trigger=button}{sub-section}{sub-section:5E77424891607541-3542EAAB-4BCB486C-911AB433-09835B6C2AB81C9A982A0313_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:5E77424891607541-3542EAAB-4BCB486C-911AB433-09835B6C2AB81C9A982A0313_see|text=|trigger=button}{sub-section}{sub-section:5E77424891607541-3542EAAB-4BCB486C-911AB433-09835B6C2AB81C9A982A0313_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:5E77424891607541-3542EAAB-4BCB486C-911AB433-09835B6C2AB81C9A982A0313_sam|text=|trigger=button}{sub-section}{sub-section:5E77424891607541-3542EAAB-4BCB486C-911AB433-09835B6C2AB81C9A982A0313_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=9BF37AB33F601527-7877F225-443A4579-8379AF74-7A018263233596C417061227}{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:9BF37AB33F601527-7877F225-443A4579-8379AF74-7A018263233596C417061227_des|text=|trigger=button}{sub-section}{sub-section:9BF37AB33F601527-7877F225-443A4579-8379AF74-7A018263233596C417061227_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:9BF37AB33F601527-7877F225-443A4579-8379AF74-7A018263233596C417061227_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9BF37AB33F601527-7877F225-443A4579-8379AF74-7A018263233596C417061227_prs|trigger=none}targetFolder
showWarning
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:9BF37AB33F601527-7877F225-443A4579-8379AF74-7A018263233596C417061227_ret|text=|trigger=button}{sub-section}{sub-section:9BF37AB33F601527-7877F225-443A4579-8379AF74-7A018263233596C417061227_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:9BF37AB33F601527-7877F225-443A4579-8379AF74-7A018263233596C417061227_see|text=|trigger=button}{sub-section}{sub-section:9BF37AB33F601527-7877F225-443A4579-8379AF74-7A018263233596C417061227_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9BF37AB33F601527-7877F225-443A4579-8379AF74-7A018263233596C417061227_see|text=|trigger=button}{sub-section}{sub-section:9BF37AB33F601527-7877F225-443A4579-8379AF74-7A018263233596C417061227_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9BF37AB33F601527-7877F225-443A4579-8379AF74-7A018263233596C417061227_sam|text=|trigger=button}{sub-section}{sub-section:9BF37AB33F601527-7877F225-443A4579-8379AF74-7A018263233596C417061227_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=7E715C78FC8B5628-41194834-4A884A0C-827AB28A-632CCC21F50F886A9FB60650}{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:7E715C78FC8B5628-41194834-4A884A0C-827AB28A-632CCC21F50F886A9FB60650_des|text=|trigger=button}{sub-section}{sub-section:7E715C78FC8B5628-41194834-4A884A0C-827AB28A-632CCC21F50F886A9FB60650_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:7E715C78FC8B5628-41194834-4A884A0C-827AB28A-632CCC21F50F886A9FB60650_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7E715C78FC8B5628-41194834-4A884A0C-827AB28A-632CCC21F50F886A9FB60650_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:7E715C78FC8B5628-41194834-4A884A0C-827AB28A-632CCC21F50F886A9FB60650_ret|text=|trigger=button}{sub-section}{sub-section:7E715C78FC8B5628-41194834-4A884A0C-827AB28A-632CCC21F50F886A9FB60650_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:7E715C78FC8B5628-41194834-4A884A0C-827AB28A-632CCC21F50F886A9FB60650_see|text=|trigger=button}{sub-section}{sub-section:7E715C78FC8B5628-41194834-4A884A0C-827AB28A-632CCC21F50F886A9FB60650_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:7E715C78FC8B5628-41194834-4A884A0C-827AB28A-632CCC21F50F886A9FB60650_see|text=|trigger=button}{sub-section}{sub-section:7E715C78FC8B5628-41194834-4A884A0C-827AB28A-632CCC21F50F886A9FB60650_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:7E715C78FC8B5628-41194834-4A884A0C-827AB28A-632CCC21F50F886A9FB60650_sam|text=|trigger=button}{sub-section}{sub-section:7E715C78FC8B5628-41194834-4A884A0C-827AB28A-632CCC21F50F886A9FB60650_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=D39C2880E1010C0E-A4F05483-43934AEC-BB92950E-F46DCA55E8B9EC5E07E3DCC8}{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:D39C2880E1010C0E-A4F05483-43934AEC-BB92950E-F46DCA55E8B9EC5E07E3DCC8_des|text=|trigger=button}{sub-section}{sub-section:D39C2880E1010C0E-A4F05483-43934AEC-BB92950E-F46DCA55E8B9EC5E07E3DCC8_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:D39C2880E1010C0E-A4F05483-43934AEC-BB92950E-F46DCA55E8B9EC5E07E3DCC8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D39C2880E1010C0E-A4F05483-43934AEC-BB92950E-F46DCA55E8B9EC5E07E3DCC8_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:D39C2880E1010C0E-A4F05483-43934AEC-BB92950E-F46DCA55E8B9EC5E07E3DCC8_ret|text=|trigger=button}{sub-section}{sub-section:D39C2880E1010C0E-A4F05483-43934AEC-BB92950E-F46DCA55E8B9EC5E07E3DCC8_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D39C2880E1010C0E-A4F05483-43934AEC-BB92950E-F46DCA55E8B9EC5E07E3DCC8_see|text=|trigger=button}{sub-section}{sub-section:D39C2880E1010C0E-A4F05483-43934AEC-BB92950E-F46DCA55E8B9EC5E07E3DCC8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D39C2880E1010C0E-A4F05483-43934AEC-BB92950E-F46DCA55E8B9EC5E07E3DCC8_see|text=|trigger=button}{sub-section}{sub-section:D39C2880E1010C0E-A4F05483-43934AEC-BB92950E-F46DCA55E8B9EC5E07E3DCC8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D39C2880E1010C0E-A4F05483-43934AEC-BB92950E-F46DCA55E8B9EC5E07E3DCC8_sam|text=|trigger=button}{sub-section}{sub-section:D39C2880E1010C0E-A4F05483-43934AEC-BB92950E-F46DCA55E8B9EC5E07E3DCC8_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=36AFE76684D5DB65-CA4AFFF7-4FD14DFC-816DBCC6-5803C424497B6F9B08A09840}{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:36AFE76684D5DB65-CA4AFFF7-4FD14DFC-816DBCC6-5803C424497B6F9B08A09840_des|text=|trigger=button}{sub-section}{sub-section:36AFE76684D5DB65-CA4AFFF7-4FD14DFC-816DBCC6-5803C424497B6F9B08A09840_des|trigger=none|class=sIndent}Returns the size of the specified file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:36AFE76684D5DB65-CA4AFFF7-4FD14DFC-816DBCC6-5803C424497B6F9B08A09840_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:36AFE76684D5DB65-CA4AFFF7-4FD14DFC-816DBCC6-5803C424497B6F9B08A09840_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:36AFE76684D5DB65-CA4AFFF7-4FD14DFC-816DBCC6-5803C424497B6F9B08A09840_ret|text=|trigger=button}{sub-section}{sub-section:36AFE76684D5DB65-CA4AFFF7-4FD14DFC-816DBCC6-5803C424497B6F9B08A09840_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:36AFE76684D5DB65-CA4AFFF7-4FD14DFC-816DBCC6-5803C424497B6F9B08A09840_see|text=|trigger=button}{sub-section}{sub-section:36AFE76684D5DB65-CA4AFFF7-4FD14DFC-816DBCC6-5803C424497B6F9B08A09840_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:36AFE76684D5DB65-CA4AFFF7-4FD14DFC-816DBCC6-5803C424497B6F9B08A09840_see|text=|trigger=button}{sub-section}{sub-section:36AFE76684D5DB65-CA4AFFF7-4FD14DFC-816DBCC6-5803C424497B6F9B08A09840_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:36AFE76684D5DB65-CA4AFFF7-4FD14DFC-816DBCC6-5803C424497B6F9B08A09840_sam|text=|trigger=button}{sub-section}{sub-section:36AFE76684D5DB65-CA4AFFF7-4FD14DFC-816DBCC6-5803C424497B6F9B08A09840_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=D964432BDF9506D4-D77EAB21-467B49A4-A594BD20-A574F154B960021C305DD80D}{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:D964432BDF9506D4-D77EAB21-467B49A4-A594BD20-A574F154B960021C305DD80D_des|text=|trigger=button}{sub-section}{sub-section:D964432BDF9506D4-D77EAB21-467B49A4-A594BD20-A574F154B960021C305DD80D_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:D964432BDF9506D4-D77EAB21-467B49A4-A594BD20-A574F154B960021C305DD80D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D964432BDF9506D4-D77EAB21-467B49A4-A594BD20-A574F154B960021C305DD80D_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:D964432BDF9506D4-D77EAB21-467B49A4-A594BD20-A574F154B960021C305DD80D_ret|text=|trigger=button}{sub-section}{sub-section:D964432BDF9506D4-D77EAB21-467B49A4-A594BD20-A574F154B960021C305DD80D_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D964432BDF9506D4-D77EAB21-467B49A4-A594BD20-A574F154B960021C305DD80D_see|text=|trigger=button}{sub-section}{sub-section:D964432BDF9506D4-D77EAB21-467B49A4-A594BD20-A574F154B960021C305DD80D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D964432BDF9506D4-D77EAB21-467B49A4-A594BD20-A574F154B960021C305DD80D_see|text=|trigger=button}{sub-section}{sub-section:D964432BDF9506D4-D77EAB21-467B49A4-A594BD20-A574F154B960021C305DD80D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D964432BDF9506D4-D77EAB21-467B49A4-A594BD20-A574F154B960021C305DD80D_sam|text=|trigger=button}{sub-section}{sub-section:D964432BDF9506D4-D77EAB21-467B49A4-A594BD20-A574F154B960021C305DD80D_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=0D379DE3AA7D3D58-873A51EB-40BD45FD-BEF2A2E3-28684B43164895066CAD48E5}{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:0D379DE3AA7D3D58-873A51EB-40BD45FD-BEF2A2E3-28684B43164895066CAD48E5_des|text=|trigger=button}{sub-section}{sub-section:0D379DE3AA7D3D58-873A51EB-40BD45FD-BEF2A2E3-28684B43164895066CAD48E5_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:0D379DE3AA7D3D58-873A51EB-40BD45FD-BEF2A2E3-28684B43164895066CAD48E5_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0D379DE3AA7D3D58-873A51EB-40BD45FD-BEF2A2E3-28684B43164895066CAD48E5_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:0D379DE3AA7D3D58-873A51EB-40BD45FD-BEF2A2E3-28684B43164895066CAD48E5_ret|text=|trigger=button}{sub-section}{sub-section:0D379DE3AA7D3D58-873A51EB-40BD45FD-BEF2A2E3-28684B43164895066CAD48E5_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:0D379DE3AA7D3D58-873A51EB-40BD45FD-BEF2A2E3-28684B43164895066CAD48E5_see|text=|trigger=button}{sub-section}{sub-section:0D379DE3AA7D3D58-873A51EB-40BD45FD-BEF2A2E3-28684B43164895066CAD48E5_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:0D379DE3AA7D3D58-873A51EB-40BD45FD-BEF2A2E3-28684B43164895066CAD48E5_see|text=|trigger=button}{sub-section}{sub-section:0D379DE3AA7D3D58-873A51EB-40BD45FD-BEF2A2E3-28684B43164895066CAD48E5_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:0D379DE3AA7D3D58-873A51EB-40BD45FD-BEF2A2E3-28684B43164895066CAD48E5_sam|text=|trigger=button}{sub-section}{sub-section:0D379DE3AA7D3D58-873A51EB-40BD45FD-BEF2A2E3-28684B43164895066CAD48E5_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=1D3701FCCDD5A428-1C9271EE-4BDE4D05-934595FA-95476715905E84D7EBC08DC7}{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:1D3701FCCDD5A428-1C9271EE-4BDE4D05-934595FA-95476715905E84D7EBC08DC7_des|text=|trigger=button}{sub-section}{sub-section:1D3701FCCDD5A428-1C9271EE-4BDE4D05-934595FA-95476715905E84D7EBC08DC7_des|trigger=none|class=sIndent}Returns the modification date of a file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:1D3701FCCDD5A428-1C9271EE-4BDE4D05-934595FA-95476715905E84D7EBC08DC7_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:1D3701FCCDD5A428-1C9271EE-4BDE4D05-934595FA-95476715905E84D7EBC08DC7_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:1D3701FCCDD5A428-1C9271EE-4BDE4D05-934595FA-95476715905E84D7EBC08DC7_ret|text=|trigger=button}{sub-section}{sub-section:1D3701FCCDD5A428-1C9271EE-4BDE4D05-934595FA-95476715905E84D7EBC08DC7_ret|trigger=none|class=sIndent}[Date]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:1D3701FCCDD5A428-1C9271EE-4BDE4D05-934595FA-95476715905E84D7EBC08DC7_see|text=|trigger=button}{sub-section}{sub-section:1D3701FCCDD5A428-1C9271EE-4BDE4D05-934595FA-95476715905E84D7EBC08DC7_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:1D3701FCCDD5A428-1C9271EE-4BDE4D05-934595FA-95476715905E84D7EBC08DC7_see|text=|trigger=button}{sub-section}{sub-section:1D3701FCCDD5A428-1C9271EE-4BDE4D05-934595FA-95476715905E84D7EBC08DC7_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:1D3701FCCDD5A428-1C9271EE-4BDE4D05-934595FA-95476715905E84D7EBC08DC7_sam|text=|trigger=button}{sub-section}{sub-section:1D3701FCCDD5A428-1C9271EE-4BDE4D05-934595FA-95476715905E84D7EBC08DC7_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=1D6F0A7B0BBD8F07-B80C54DF-48554F99-8BDC8993-097BFA6DCCD2789CBD6E40A8}{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:1D6F0A7B0BBD8F07-B80C54DF-48554F99-8BDC8993-097BFA6DCCD2789CBD6E40A8_des|text=|trigger=button}{sub-section}{sub-section:1D6F0A7B0BBD8F07-B80C54DF-48554F99-8BDC8993-097BFA6DCCD2789CBD6E40A8_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:1D6F0A7B0BBD8F07-B80C54DF-48554F99-8BDC8993-097BFA6DCCD2789CBD6E40A8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:1D6F0A7B0BBD8F07-B80C54DF-48554F99-8BDC8993-097BFA6DCCD2789CBD6E40A8_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:1D6F0A7B0BBD8F07-B80C54DF-48554F99-8BDC8993-097BFA6DCCD2789CBD6E40A8_ret|text=|trigger=button}{sub-section}{sub-section:1D6F0A7B0BBD8F07-B80C54DF-48554F99-8BDC8993-097BFA6DCCD2789CBD6E40A8_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:1D6F0A7B0BBD8F07-B80C54DF-48554F99-8BDC8993-097BFA6DCCD2789CBD6E40A8_see|text=|trigger=button}{sub-section}{sub-section:1D6F0A7B0BBD8F07-B80C54DF-48554F99-8BDC8993-097BFA6DCCD2789CBD6E40A8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:1D6F0A7B0BBD8F07-B80C54DF-48554F99-8BDC8993-097BFA6DCCD2789CBD6E40A8_see|text=|trigger=button}{sub-section}{sub-section:1D6F0A7B0BBD8F07-B80C54DF-48554F99-8BDC8993-097BFA6DCCD2789CBD6E40A8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:1D6F0A7B0BBD8F07-B80C54DF-48554F99-8BDC8993-097BFA6DCCD2789CBD6E40A8_sam|text=|trigger=button}{sub-section}{sub-section:1D6F0A7B0BBD8F07-B80C54DF-48554F99-8BDC8993-097BFA6DCCD2789CBD6E40A8_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=71DCD5E74DCD055D-42B11A6C-471348D1-8D4D94E1-38B28D199BF37021D7982BB1}{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:71DCD5E74DCD055D-42B11A6C-471348D1-8D4D94E1-38B28D199BF37021D7982BB1_des|text=|trigger=button}{sub-section}{sub-section:71DCD5E74DCD055D-42B11A6C-471348D1-8D4D94E1-38B28D199BF37021D7982BB1_des|trigger=none|class=sIndent}Reads all or part of the content from a binary file. If a file name is not specified, then a file selection dialog pops up for selecting a file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:71DCD5E74DCD055D-42B11A6C-471348D1-8D4D94E1-38B28D199BF37021D7982BB1_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:71DCD5E74DCD055D-42B11A6C-471348D1-8D4D94E1-38B28D199BF37021D7982BB1_prs|trigger=none}\[file\]
\[size\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:71DCD5E74DCD055D-42B11A6C-471348D1-8D4D94E1-38B28D199BF37021D7982BB1_ret|text=|trigger=button}{sub-section}{sub-section:71DCD5E74DCD055D-42B11A6C-471348D1-8D4D94E1-38B28D199BF37021D7982BB1_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:71DCD5E74DCD055D-42B11A6C-471348D1-8D4D94E1-38B28D199BF37021D7982BB1_see|text=|trigger=button}{sub-section}{sub-section:71DCD5E74DCD055D-42B11A6C-471348D1-8D4D94E1-38B28D199BF37021D7982BB1_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:71DCD5E74DCD055D-42B11A6C-471348D1-8D4D94E1-38B28D199BF37021D7982BB1_see|text=|trigger=button}{sub-section}{sub-section:71DCD5E74DCD055D-42B11A6C-471348D1-8D4D94E1-38B28D199BF37021D7982BB1_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:71DCD5E74DCD055D-42B11A6C-471348D1-8D4D94E1-38B28D199BF37021D7982BB1_sam|text=|trigger=button}{sub-section}{sub-section:71DCD5E74DCD055D-42B11A6C-471348D1-8D4D94E1-38B28D199BF37021D7982BB1_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=FB29158F9162BE88-DB1169AF-417247C2-BFC8B0C6-178D746ACB1C1A048F672026}{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:FB29158F9162BE88-DB1169AF-417247C2-BFC8B0C6-178D746ACB1C1A048F672026_des|text=|trigger=button}{sub-section}{sub-section:FB29158F9162BE88-DB1169AF-417247C2-BFC8B0C6-178D746ACB1C1A048F672026_des|trigger=none|class=sIndent}Read all content from a text file. If a file name is not specified, then a file selection dialog pops up for selecting a file. The encoding can be also specified.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:FB29158F9162BE88-DB1169AF-417247C2-BFC8B0C6-178D746ACB1C1A048F672026_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FB29158F9162BE88-DB1169AF-417247C2-BFC8B0C6-178D746ACB1C1A048F672026_prs|trigger=none}\[file\]
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:FB29158F9162BE88-DB1169AF-417247C2-BFC8B0C6-178D746ACB1C1A048F672026_ret|text=|trigger=button}{sub-section}{sub-section:FB29158F9162BE88-DB1169AF-417247C2-BFC8B0C6-178D746ACB1C1A048F672026_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FB29158F9162BE88-DB1169AF-417247C2-BFC8B0C6-178D746ACB1C1A048F672026_see|text=|trigger=button}{sub-section}{sub-section:FB29158F9162BE88-DB1169AF-417247C2-BFC8B0C6-178D746ACB1C1A048F672026_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FB29158F9162BE88-DB1169AF-417247C2-BFC8B0C6-178D746ACB1C1A048F672026_see|text=|trigger=button}{sub-section}{sub-section:FB29158F9162BE88-DB1169AF-417247C2-BFC8B0C6-178D746ACB1C1A048F672026_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FB29158F9162BE88-DB1169AF-417247C2-BFC8B0C6-178D746ACB1C1A048F672026_sam|text=|trigger=button}{sub-section}{sub-section:FB29158F9162BE88-DB1169AF-417247C2-BFC8B0C6-178D746ACB1C1A048F672026_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=3EAD6483BB92562B-853FB921-47344208-90A09FAB-B6309CC7F8F632D4BED63FC5}{tr:id=name}{td}h6.showDirectorySelectDialog{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}showDirectorySelectDialog{span}{span:id=iets|style=float: left;}\(directory suggestion){span}{td}{tr}{tr:id=des}{td}{sub-section:3EAD6483BB92562B-853FB921-47344208-90A09FAB-B6309CC7F8F632D4BED63FC5_des|text=|trigger=button}{sub-section}{sub-section:3EAD6483BB92562B-853FB921-47344208-90A09FAB-B6309CC7F8F632D4BED63FC5_des|trigger=none|class=sIndent}Shows a directory selector dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:3EAD6483BB92562B-853FB921-47344208-90A09FAB-B6309CC7F8F632D4BED63FC5_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3EAD6483BB92562B-853FB921-47344208-90A09FAB-B6309CC7F8F632D4BED63FC5_prs|trigger=none}\[directory suggestion\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:3EAD6483BB92562B-853FB921-47344208-90A09FAB-B6309CC7F8F632D4BED63FC5_ret|text=|trigger=button}{sub-section}{sub-section:3EAD6483BB92562B-853FB921-47344208-90A09FAB-B6309CC7F8F632D4BED63FC5_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3EAD6483BB92562B-853FB921-47344208-90A09FAB-B6309CC7F8F632D4BED63FC5_see|text=|trigger=button}{sub-section}{sub-section:3EAD6483BB92562B-853FB921-47344208-90A09FAB-B6309CC7F8F632D4BED63FC5_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3EAD6483BB92562B-853FB921-47344208-90A09FAB-B6309CC7F8F632D4BED63FC5_see|text=|trigger=button}{sub-section}{sub-section:3EAD6483BB92562B-853FB921-47344208-90A09FAB-B6309CC7F8F632D4BED63FC5_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3EAD6483BB92562B-853FB921-47344208-90A09FAB-B6309CC7F8F632D4BED63FC5_sam|text=|trigger=button}{sub-section}{sub-section:3EAD6483BB92562B-853FB921-47344208-90A09FAB-B6309CC7F8F632D4BED63FC5_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=0C47563A0F24E478-D6037C3E-417F45E3-B058A010-94F4466AB87ED13D7F20BE8A}{tr:id=name}{td}h6.showFileOpenDialog{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}Object{span}{span:id=iets|style=float: left; font-weight: bold;}showFileOpenDialog{span}{span:id=iets|style=float: left;}\(selectionMode(0=both,1=Files,2=Dirs), startDirectory(null=default/previous), multiselect(true/false), filterarray){span}{td}{tr}{tr:id=des}{td}{sub-section:0C47563A0F24E478-D6037C3E-417F45E3-B058A010-94F4466AB87ED13D7F20BE8A_des|text=|trigger=button}{sub-section}{sub-section:0C47563A0F24E478-D6037C3E-417F45E3-B058A010-94F4466AB87ED13D7F20BE8A_des|trigger=none|class=sIndent}Shows a file open dialog. Filters can be applied on what type of files can be selected.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:0C47563A0F24E478-D6037C3E-417F45E3-B058A010-94F4466AB87ED13D7F20BE8A_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0C47563A0F24E478-D6037C3E-417F45E3-B058A010-94F4466AB87ED13D7F20BE8A_prs|trigger=none}\[selectionMode(0=both,1=Files,2=Dirs)\]
\[startDirectory(null=default/previous)\]
\[multiselect(true/false)\]
\[filterarray\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:0C47563A0F24E478-D6037C3E-417F45E3-B058A010-94F4466AB87ED13D7F20BE8A_ret|text=|trigger=button}{sub-section}{sub-section:0C47563A0F24E478-D6037C3E-417F45E3-B058A010-94F4466AB87ED13D7F20BE8A_ret|trigger=none|class=sIndent}Object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:0C47563A0F24E478-D6037C3E-417F45E3-B058A010-94F4466AB87ED13D7F20BE8A_see|text=|trigger=button}{sub-section}{sub-section:0C47563A0F24E478-D6037C3E-417F45E3-B058A010-94F4466AB87ED13D7F20BE8A_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:0C47563A0F24E478-D6037C3E-417F45E3-B058A010-94F4466AB87ED13D7F20BE8A_see|text=|trigger=button}{sub-section}{sub-section:0C47563A0F24E478-D6037C3E-417F45E3-B058A010-94F4466AB87ED13D7F20BE8A_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:0C47563A0F24E478-D6037C3E-417F45E3-B058A010-94F4466AB87ED13D7F20BE8A_sam|text=|trigger=button}{sub-section}{sub-section:0C47563A0F24E478-D6037C3E-417F45E3-B058A010-94F4466AB87ED13D7F20BE8A_sam|class=sIndent|trigger=none}{code:language=javascript}
// This selects only files ('1'), previous dir must be used ('null'), no multiselect ('false') and
// the filter "JPG and GIF" should be used: ('new Array("JPG and GIF","jpg","gif")').
var file = plugins.file.showFileOpenDialog(1, null, false, new Array("JPG and GIF","jpg","gif"));
application.output("you've selected file: " + file.getAbsolutePath());
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=2D2ADC0CB4BE0987-D53A7D9D-4C894D22-B71CB25D-74AD8F30604C757F99E467B4}{tr:id=name}{td}h6.showFileSaveDialog{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSFile]{span}{span:id=iets|style=float: left; font-weight: bold;}showFileSaveDialog{span}{span:id=iets|style=float: left;}\(fileName/dir suggestion){span}{td}{tr}{tr:id=des}{td}{sub-section:2D2ADC0CB4BE0987-D53A7D9D-4C894D22-B71CB25D-74AD8F30604C757F99E467B4_des|text=|trigger=button}{sub-section}{sub-section:2D2ADC0CB4BE0987-D53A7D9D-4C894D22-B71CB25D-74AD8F30604C757F99E467B4_des|trigger=none|class=sIndent}Shows a file save dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:2D2ADC0CB4BE0987-D53A7D9D-4C894D22-B71CB25D-74AD8F30604C757F99E467B4_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2D2ADC0CB4BE0987-D53A7D9D-4C894D22-B71CB25D-74AD8F30604C757F99E467B4_prs|trigger=none}\[fileName/dir suggestion\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:2D2ADC0CB4BE0987-D53A7D9D-4C894D22-B71CB25D-74AD8F30604C757F99E467B4_ret|text=|trigger=button}{sub-section}{sub-section:2D2ADC0CB4BE0987-D53A7D9D-4C894D22-B71CB25D-74AD8F30604C757F99E467B4_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:2D2ADC0CB4BE0987-D53A7D9D-4C894D22-B71CB25D-74AD8F30604C757F99E467B4_see|text=|trigger=button}{sub-section}{sub-section:2D2ADC0CB4BE0987-D53A7D9D-4C894D22-B71CB25D-74AD8F30604C757F99E467B4_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2D2ADC0CB4BE0987-D53A7D9D-4C894D22-B71CB25D-74AD8F30604C757F99E467B4_see|text=|trigger=button}{sub-section}{sub-section:2D2ADC0CB4BE0987-D53A7D9D-4C894D22-B71CB25D-74AD8F30604C757F99E467B4_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2D2ADC0CB4BE0987-D53A7D9D-4C894D22-B71CB25D-74AD8F30604C757F99E467B4_sam|text=|trigger=button}{sub-section}{sub-section:2D2ADC0CB4BE0987-D53A7D9D-4C894D22-B71CB25D-74AD8F30604C757F99E467B4_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=33D38C34F838C712-F09DE73B-40FE4BD8-8C4F8A94-191BCF5CC20E815D5DEE101E}{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:33D38C34F838C712-F09DE73B-40FE4BD8-8C4F8A94-191BCF5CC20E815D5DEE101E_des|text=|trigger=button}{sub-section}{sub-section:33D38C34F838C712-F09DE73B-40FE4BD8-8C4F8A94-191BCF5CC20E815D5DEE101E_des|trigger=none|class=sIndent}Writes data into a binary file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:33D38C34F838C712-F09DE73B-40FE4BD8-8C4F8A94-191BCF5CC20E815D5DEE101E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:33D38C34F838C712-F09DE73B-40FE4BD8-8C4F8A94-191BCF5CC20E815D5DEE101E_prs|trigger=none}file
binary_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:33D38C34F838C712-F09DE73B-40FE4BD8-8C4F8A94-191BCF5CC20E815D5DEE101E_ret|text=|trigger=button}{sub-section}{sub-section:33D38C34F838C712-F09DE73B-40FE4BD8-8C4F8A94-191BCF5CC20E815D5DEE101E_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:33D38C34F838C712-F09DE73B-40FE4BD8-8C4F8A94-191BCF5CC20E815D5DEE101E_see|text=|trigger=button}{sub-section}{sub-section:33D38C34F838C712-F09DE73B-40FE4BD8-8C4F8A94-191BCF5CC20E815D5DEE101E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:33D38C34F838C712-F09DE73B-40FE4BD8-8C4F8A94-191BCF5CC20E815D5DEE101E_see|text=|trigger=button}{sub-section}{sub-section:33D38C34F838C712-F09DE73B-40FE4BD8-8C4F8A94-191BCF5CC20E815D5DEE101E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:33D38C34F838C712-F09DE73B-40FE4BD8-8C4F8A94-191BCF5CC20E815D5DEE101E_sam|text=|trigger=button}{sub-section}{sub-section:33D38C34F838C712-F09DE73B-40FE4BD8-8C4F8A94-191BCF5CC20E815D5DEE101E_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=1CFAFED1920A9D7D-BADC1845-4CBD4B57-A593BAA8-813C00057AB51FABD341F5FF}{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:1CFAFED1920A9D7D-BADC1845-4CBD4B57-A593BAA8-813C00057AB51FABD341F5FF_des|text=|trigger=button}{sub-section}{sub-section:1CFAFED1920A9D7D-BADC1845-4CBD4B57-A593BAA8-813C00057AB51FABD341F5FF_des|trigger=none|class=sIndent}Writes data into a text file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:1CFAFED1920A9D7D-BADC1845-4CBD4B57-A593BAA8-813C00057AB51FABD341F5FF_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:1CFAFED1920A9D7D-BADC1845-4CBD4B57-A593BAA8-813C00057AB51FABD341F5FF_prs|trigger=none}file
text_data
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:1CFAFED1920A9D7D-BADC1845-4CBD4B57-A593BAA8-813C00057AB51FABD341F5FF_ret|text=|trigger=button}{sub-section}{sub-section:1CFAFED1920A9D7D-BADC1845-4CBD4B57-A593BAA8-813C00057AB51FABD341F5FF_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:1CFAFED1920A9D7D-BADC1845-4CBD4B57-A593BAA8-813C00057AB51FABD341F5FF_see|text=|trigger=button}{sub-section}{sub-section:1CFAFED1920A9D7D-BADC1845-4CBD4B57-A593BAA8-813C00057AB51FABD341F5FF_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:1CFAFED1920A9D7D-BADC1845-4CBD4B57-A593BAA8-813C00057AB51FABD341F5FF_see|text=|trigger=button}{sub-section}{sub-section:1CFAFED1920A9D7D-BADC1845-4CBD4B57-A593BAA8-813C00057AB51FABD341F5FF_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:1CFAFED1920A9D7D-BADC1845-4CBD4B57-A593BAA8-813C00057AB51FABD341F5FF_sam|text=|trigger=button}{sub-section}{sub-section:1CFAFED1920A9D7D-BADC1845-4CBD4B57-A593BAA8-813C00057AB51FABD341F5FF_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=AE7BAFA3150C4E7A-B29A0BC1-4CBB4513-AB0E83B2-6DB0309D174D8470E558FDE2}{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:AE7BAFA3150C4E7A-B29A0BC1-4CBB4513-AB0E83B2-6DB0309D174D8470E558FDE2_des|text=|trigger=button}{sub-section}{sub-section:AE7BAFA3150C4E7A-B29A0BC1-4CBB4513-AB0E83B2-6DB0309D174D8470E558FDE2_des|trigger=none|class=sIndent}Writes data into an XML file. The file is saved with the encoding specified by the XML itself.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:AE7BAFA3150C4E7A-B29A0BC1-4CBB4513-AB0E83B2-6DB0309D174D8470E558FDE2_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:AE7BAFA3150C4E7A-B29A0BC1-4CBB4513-AB0E83B2-6DB0309D174D8470E558FDE2_prs|trigger=none}file
xml_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:AE7BAFA3150C4E7A-B29A0BC1-4CBB4513-AB0E83B2-6DB0309D174D8470E558FDE2_ret|text=|trigger=button}{sub-section}{sub-section:AE7BAFA3150C4E7A-B29A0BC1-4CBB4513-AB0E83B2-6DB0309D174D8470E558FDE2_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:AE7BAFA3150C4E7A-B29A0BC1-4CBB4513-AB0E83B2-6DB0309D174D8470E558FDE2_see|text=|trigger=button}{sub-section}{sub-section:AE7BAFA3150C4E7A-B29A0BC1-4CBB4513-AB0E83B2-6DB0309D174D8470E558FDE2_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:AE7BAFA3150C4E7A-B29A0BC1-4CBB4513-AB0E83B2-6DB0309D174D8470E558FDE2_see|text=|trigger=button}{sub-section}{sub-section:AE7BAFA3150C4E7A-B29A0BC1-4CBB4513-AB0E83B2-6DB0309D174D8470E558FDE2_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:AE7BAFA3150C4E7A-B29A0BC1-4CBB4513-AB0E83B2-6DB0309D174D8470E558FDE2_sam|text=|trigger=button}{sub-section}{sub-section:AE7BAFA3150C4E7A-B29A0BC1-4CBB4513-AB0E83B2-6DB0309D174D8470E558FDE2_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}
Child pages

Versions Compared

Old Version 4

New Version 5

Key
