Servoy 7.x.x Documentation
Child pages
  • file

Versions Compared

Old Version 6

changes.mady.by.user Servoy Docs

Saved on

compared with

New Version 7

changes.mady.by.user Servoy Docs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{hidden}
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden}
{sub-section:description|text=}{sub-section}\\{table:class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Return Types{th}{tr}{tr}{td}{span:class=sWordList}[JSFile]{span}{td}{tr}{table}\\{table:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[JSFile]{td}{td}[#convertToJSFile]\(file)
Returns a JSFile instance corresponding to an alternative representation of a file (for example a string).{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#copyFile]\(sourceFile, destinationFile)
Copies the sourcefile to the destination file.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#copyFolder]\(sourceFolder, destinationFolder)
Copies the sourcefolder to the destination folder, recursively.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#createFile]\(targetFile)
Creates a JSFile instance.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#createFolder]\(targetFolder)
Creates a folder on disk.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#createTempFile]\(filePrefix, fileSuffix)
Creates a temporary file on disk.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#deleteFile]\(targetFile)
Removes a file from disk.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#deleteFolder]\(targetFolder, showWarning)
Deletes a folder from disk recursively.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#getDesktopFolder]\()
Returns a JSFile instance that corresponds to the Desktop folder of the currently logged in user.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]\[]{td}{td}[#getDiskList]\()
Returns an Array of JSFile instances correponding to the file system root folders.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getFileSize]\(targetFile)
Returns the size of the specified file.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]\[]{td}{td}[#getFolderContents]\(targetFolder, fileFilter, fileOption(1=files,2=dirs), visibleOption(1=visible,2=nonvisible), lockedOption(1=locked,2=nonlocked))
Returns an array of JSFile instances corresponding to content of the specified folder.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#getHomeDirectory]\()
Returns a JSFile instance corresponding to the home folder of the logged in used.{td}{tr}{tbody}{tbody}{tr}{td}[Date]{td}{td}[#getModificationDate]\(targetFile)
Returns the modification date of a file.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#moveFile]\(sourceFile, destinationFile)
Moves the file from the source to the destination place.{td}{tr}{tbody}{tbody}{tr}{td}byte[]{td}{td}[#readFile]\(file, size)
Reads all or part of the content from a binary file.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#readTXTFile]\(file, charsetname)
Read all content from a text file.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#showDirectorySelectDialog]\(directory suggestion)
Shows a directory selector dialog.{td}{tr}{tbody}{tbody}{tr}{td}Object{td}{td}[#showFileOpenDialog]\(selectionMode(0=both,1=Files,2=Dirs), startDirectory(null=default/previous), multiselect(true/false), filterarray)
Shows a file open dialog.{td}{tr}{tbody}{tbody}{tr}{td}[JSFile]{td}{td}[#showFileSaveDialog]\(fileName/dir suggestion)
Shows a file save dialog.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#writeFile]\(file, binary_data)
Writes data into a binary file.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#writeTXTFile]\(file, text_data, charsetname)
Writes data into a text file.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#writeXMLFile]\(file, xml_data)
Writes data into an XML file.{td}{tr}{tbody}{table}\\{table:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=82FA2338CA8F91E5-A68F08D8-4F934076-B00C9E85-1C5886196577EBF473457621}{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:82FA2338CA8F91E5-A68F08D8-4F934076-B00C9E85-1C5886196577EBF473457621_des|text=|trigger=button}{sub-section}{sub-section:82FA2338CA8F91E5-A68F08D8-4F934076-B00C9E85-1C5886196577EBF473457621_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:82FA2338CA8F91E5-A68F08D8-4F934076-B00C9E85-1C5886196577EBF473457621_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:82FA2338CA8F91E5-A68F08D8-4F934076-B00C9E85-1C5886196577EBF473457621_prs|trigger=none}file
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:82FA2338CA8F91E5-A68F08D8-4F934076-B00C9E85-1C5886196577EBF473457621_ret|text=|trigger=button}{sub-section}{sub-section:82FA2338CA8F91E5-A68F08D8-4F934076-B00C9E85-1C5886196577EBF473457621_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:82FA2338CA8F91E5-A68F08D8-4F934076-B00C9E85-1C5886196577EBF473457621_see|text=|trigger=button}{sub-section}{sub-section:82FA2338CA8F91E5-A68F08D8-4F934076-B00C9E85-1C5886196577EBF473457621_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:82FA2338CA8F91E5-A68F08D8-4F934076-B00C9E85-1C5886196577EBF473457621_see|text=|trigger=button}{sub-section}{sub-section:82FA2338CA8F91E5-A68F08D8-4F934076-B00C9E85-1C5886196577EBF473457621_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:82FA2338CA8F91E5-A68F08D8-4F934076-B00C9E85-1C5886196577EBF473457621_sam|text=|trigger=button}{sub-section}{sub-section:82FA2338CA8F91E5-A68F08D8-4F934076-B00C9E85-1C5886196577EBF473457621_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=55C6D44AB41D5E5E-E6D951CA-4D844029-99A6B175-E107FD2198897E0BD4A0B99C}{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:55C6D44AB41D5E5E-E6D951CA-4D844029-99A6B175-E107FD2198897E0BD4A0B99C_des|text=|trigger=button}{sub-section}{sub-section:55C6D44AB41D5E5E-E6D951CA-4D844029-99A6B175-E107FD2198897E0BD4A0B99C_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:55C6D44AB41D5E5E-E6D951CA-4D844029-99A6B175-E107FD2198897E0BD4A0B99C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:55C6D44AB41D5E5E-E6D951CA-4D844029-99A6B175-E107FD2198897E0BD4A0B99C_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:55C6D44AB41D5E5E-E6D951CA-4D844029-99A6B175-E107FD2198897E0BD4A0B99C_ret|text=|trigger=button}{sub-section}{sub-section:55C6D44AB41D5E5E-E6D951CA-4D844029-99A6B175-E107FD2198897E0BD4A0B99C_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:55C6D44AB41D5E5E-E6D951CA-4D844029-99A6B175-E107FD2198897E0BD4A0B99C_see|text=|trigger=button}{sub-section}{sub-section:55C6D44AB41D5E5E-E6D951CA-4D844029-99A6B175-E107FD2198897E0BD4A0B99C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:55C6D44AB41D5E5E-E6D951CA-4D844029-99A6B175-E107FD2198897E0BD4A0B99C_see|text=|trigger=button}{sub-section}{sub-section:55C6D44AB41D5E5E-E6D951CA-4D844029-99A6B175-E107FD2198897E0BD4A0B99C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:55C6D44AB41D5E5E-E6D951CA-4D844029-99A6B175-E107FD2198897E0BD4A0B99C_sam|text=|trigger=button}{sub-section}{sub-section:55C6D44AB41D5E5E-E6D951CA-4D844029-99A6B175-E107FD2198897E0BD4A0B99C_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=92D8EA8462ADEEE1-B9BB4D3A-48254998-A4B3A94E-6F1DABB05F6742F544E2C347}{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:92D8EA8462ADEEE1-B9BB4D3A-48254998-A4B3A94E-6F1DABB05F6742F544E2C347_des|text=|trigger=button}{sub-section}{sub-section:92D8EA8462ADEEE1-B9BB4D3A-48254998-A4B3A94E-6F1DABB05F6742F544E2C347_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:92D8EA8462ADEEE1-B9BB4D3A-48254998-A4B3A94E-6F1DABB05F6742F544E2C347_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:92D8EA8462ADEEE1-B9BB4D3A-48254998-A4B3A94E-6F1DABB05F6742F544E2C347_prs|trigger=none}sourceFolder
destinationFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:92D8EA8462ADEEE1-B9BB4D3A-48254998-A4B3A94E-6F1DABB05F6742F544E2C347_ret|text=|trigger=button}{sub-section}{sub-section:92D8EA8462ADEEE1-B9BB4D3A-48254998-A4B3A94E-6F1DABB05F6742F544E2C347_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:92D8EA8462ADEEE1-B9BB4D3A-48254998-A4B3A94E-6F1DABB05F6742F544E2C347_see|text=|trigger=button}{sub-section}{sub-section:92D8EA8462ADEEE1-B9BB4D3A-48254998-A4B3A94E-6F1DABB05F6742F544E2C347_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:92D8EA8462ADEEE1-B9BB4D3A-48254998-A4B3A94E-6F1DABB05F6742F544E2C347_see|text=|trigger=button}{sub-section}{sub-section:92D8EA8462ADEEE1-B9BB4D3A-48254998-A4B3A94E-6F1DABB05F6742F544E2C347_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:92D8EA8462ADEEE1-B9BB4D3A-48254998-A4B3A94E-6F1DABB05F6742F544E2C347_sam|text=|trigger=button}{sub-section}{sub-section:92D8EA8462ADEEE1-B9BB4D3A-48254998-A4B3A94E-6F1DABB05F6742F544E2C347_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=CAF1C3FD973BC3AE-1ACDD0F9-4CF84D92-9224A1F2-351B30368EDD78B75E75FFBE}{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:CAF1C3FD973BC3AE-1ACDD0F9-4CF84D92-9224A1F2-351B30368EDD78B75E75FFBE_des|text=|trigger=button}{sub-section}{sub-section:CAF1C3FD973BC3AE-1ACDD0F9-4CF84D92-9224A1F2-351B30368EDD78B75E75FFBE_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:CAF1C3FD973BC3AE-1ACDD0F9-4CF84D92-9224A1F2-351B30368EDD78B75E75FFBE_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:CAF1C3FD973BC3AE-1ACDD0F9-4CF84D92-9224A1F2-351B30368EDD78B75E75FFBE_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:CAF1C3FD973BC3AE-1ACDD0F9-4CF84D92-9224A1F2-351B30368EDD78B75E75FFBE_ret|text=|trigger=button}{sub-section}{sub-section:CAF1C3FD973BC3AE-1ACDD0F9-4CF84D92-9224A1F2-351B30368EDD78B75E75FFBE_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:CAF1C3FD973BC3AE-1ACDD0F9-4CF84D92-9224A1F2-351B30368EDD78B75E75FFBE_see|text=|trigger=button}{sub-section}{sub-section:CAF1C3FD973BC3AE-1ACDD0F9-4CF84D92-9224A1F2-351B30368EDD78B75E75FFBE_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:CAF1C3FD973BC3AE-1ACDD0F9-4CF84D92-9224A1F2-351B30368EDD78B75E75FFBE_see|text=|trigger=button}{sub-section}{sub-section:CAF1C3FD973BC3AE-1ACDD0F9-4CF84D92-9224A1F2-351B30368EDD78B75E75FFBE_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:CAF1C3FD973BC3AE-1ACDD0F9-4CF84D92-9224A1F2-351B30368EDD78B75E75FFBE_sam|text=|trigger=button}{sub-section}{sub-section:CAF1C3FD973BC3AE-1ACDD0F9-4CF84D92-9224A1F2-351B30368EDD78B75E75FFBE_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=9376127349F45B27-7659992E-40774B79-B7BFB4E4-E7004C05BBE555F1331630FE}{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:9376127349F45B27-7659992E-40774B79-B7BFB4E4-E7004C05BBE555F1331630FE_des|text=|trigger=button}{sub-section}{sub-section:9376127349F45B27-7659992E-40774B79-B7BFB4E4-E7004C05BBE555F1331630FE_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:9376127349F45B27-7659992E-40774B79-B7BFB4E4-E7004C05BBE555F1331630FE_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9376127349F45B27-7659992E-40774B79-B7BFB4E4-E7004C05BBE555F1331630FE_prs|trigger=none}targetFolder
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:9376127349F45B27-7659992E-40774B79-B7BFB4E4-E7004C05BBE555F1331630FE_ret|text=|trigger=button}{sub-section}{sub-section:9376127349F45B27-7659992E-40774B79-B7BFB4E4-E7004C05BBE555F1331630FE_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:9376127349F45B27-7659992E-40774B79-B7BFB4E4-E7004C05BBE555F1331630FE_see|text=|trigger=button}{sub-section}{sub-section:9376127349F45B27-7659992E-40774B79-B7BFB4E4-E7004C05BBE555F1331630FE_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9376127349F45B27-7659992E-40774B79-B7BFB4E4-E7004C05BBE555F1331630FE_see|text=|trigger=button}{sub-section}{sub-section:9376127349F45B27-7659992E-40774B79-B7BFB4E4-E7004C05BBE555F1331630FE_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9376127349F45B27-7659992E-40774B79-B7BFB4E4-E7004C05BBE555F1331630FE_sam|text=|trigger=button}{sub-section}{sub-section:9376127349F45B27-7659992E-40774B79-B7BFB4E4-E7004C05BBE555F1331630FE_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=4872CE02615DEBEC-68376A4E-4DF04572-898E80E3-1BFD6C124CBC7B50868AE829}{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:4872CE02615DEBEC-68376A4E-4DF04572-898E80E3-1BFD6C124CBC7B50868AE829_des|text=|trigger=button}{sub-section}{sub-section:4872CE02615DEBEC-68376A4E-4DF04572-898E80E3-1BFD6C124CBC7B50868AE829_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:4872CE02615DEBEC-68376A4E-4DF04572-898E80E3-1BFD6C124CBC7B50868AE829_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:4872CE02615DEBEC-68376A4E-4DF04572-898E80E3-1BFD6C124CBC7B50868AE829_prs|trigger=none}filePrefix
fileSuffix
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:4872CE02615DEBEC-68376A4E-4DF04572-898E80E3-1BFD6C124CBC7B50868AE829_ret|text=|trigger=button}{sub-section}{sub-section:4872CE02615DEBEC-68376A4E-4DF04572-898E80E3-1BFD6C124CBC7B50868AE829_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:4872CE02615DEBEC-68376A4E-4DF04572-898E80E3-1BFD6C124CBC7B50868AE829_see|text=|trigger=button}{sub-section}{sub-section:4872CE02615DEBEC-68376A4E-4DF04572-898E80E3-1BFD6C124CBC7B50868AE829_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:4872CE02615DEBEC-68376A4E-4DF04572-898E80E3-1BFD6C124CBC7B50868AE829_see|text=|trigger=button}{sub-section}{sub-section:4872CE02615DEBEC-68376A4E-4DF04572-898E80E3-1BFD6C124CBC7B50868AE829_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:4872CE02615DEBEC-68376A4E-4DF04572-898E80E3-1BFD6C124CBC7B50868AE829_sam|text=|trigger=button}{sub-section}{sub-section:4872CE02615DEBEC-68376A4E-4DF04572-898E80E3-1BFD6C124CBC7B50868AE829_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=BDD588B41F1C3668-7147FF47-428740FA-9BFEB1EE-087D8A8F482A3E4AFE11365E}{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:BDD588B41F1C3668-7147FF47-428740FA-9BFEB1EE-087D8A8F482A3E4AFE11365E_des|text=|trigger=button}{sub-section}{sub-section:BDD588B41F1C3668-7147FF47-428740FA-9BFEB1EE-087D8A8F482A3E4AFE11365E_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:BDD588B41F1C3668-7147FF47-428740FA-9BFEB1EE-087D8A8F482A3E4AFE11365E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BDD588B41F1C3668-7147FF47-428740FA-9BFEB1EE-087D8A8F482A3E4AFE11365E_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:BDD588B41F1C3668-7147FF47-428740FA-9BFEB1EE-087D8A8F482A3E4AFE11365E_ret|text=|trigger=button}{sub-section}{sub-section:BDD588B41F1C3668-7147FF47-428740FA-9BFEB1EE-087D8A8F482A3E4AFE11365E_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BDD588B41F1C3668-7147FF47-428740FA-9BFEB1EE-087D8A8F482A3E4AFE11365E_see|text=|trigger=button}{sub-section}{sub-section:BDD588B41F1C3668-7147FF47-428740FA-9BFEB1EE-087D8A8F482A3E4AFE11365E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BDD588B41F1C3668-7147FF47-428740FA-9BFEB1EE-087D8A8F482A3E4AFE11365E_see|text=|trigger=button}{sub-section}{sub-section:BDD588B41F1C3668-7147FF47-428740FA-9BFEB1EE-087D8A8F482A3E4AFE11365E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BDD588B41F1C3668-7147FF47-428740FA-9BFEB1EE-087D8A8F482A3E4AFE11365E_sam|text=|trigger=button}{sub-section}{sub-section:BDD588B41F1C3668-7147FF47-428740FA-9BFEB1EE-087D8A8F482A3E4AFE11365E_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=5984E003C358F267-892FA642-43734320-A175A8C2-BC4C3D8A429B442D275E2BBA}{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:5984E003C358F267-892FA642-43734320-A175A8C2-BC4C3D8A429B442D275E2BBA_des|text=|trigger=button}{sub-section}{sub-section:5984E003C358F267-892FA642-43734320-A175A8C2-BC4C3D8A429B442D275E2BBA_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:5984E003C358F267-892FA642-43734320-A175A8C2-BC4C3D8A429B442D275E2BBA_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5984E003C358F267-892FA642-43734320-A175A8C2-BC4C3D8A429B442D275E2BBA_prs|trigger=none}targetFolder
showWarning
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:5984E003C358F267-892FA642-43734320-A175A8C2-BC4C3D8A429B442D275E2BBA_ret|text=|trigger=button}{sub-section}{sub-section:5984E003C358F267-892FA642-43734320-A175A8C2-BC4C3D8A429B442D275E2BBA_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:5984E003C358F267-892FA642-43734320-A175A8C2-BC4C3D8A429B442D275E2BBA_see|text=|trigger=button}{sub-section}{sub-section:5984E003C358F267-892FA642-43734320-A175A8C2-BC4C3D8A429B442D275E2BBA_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:5984E003C358F267-892FA642-43734320-A175A8C2-BC4C3D8A429B442D275E2BBA_see|text=|trigger=button}{sub-section}{sub-section:5984E003C358F267-892FA642-43734320-A175A8C2-BC4C3D8A429B442D275E2BBA_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:5984E003C358F267-892FA642-43734320-A175A8C2-BC4C3D8A429B442D275E2BBA_sam|text=|trigger=button}{sub-section}{sub-section:5984E003C358F267-892FA642-43734320-A175A8C2-BC4C3D8A429B442D275E2BBA_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=05C60E9BC1D2D7EF-5FF4DD27-464B4E7E-98ACA25F-F38008D3675ADC034E24FAA0}{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:05C60E9BC1D2D7EF-5FF4DD27-464B4E7E-98ACA25F-F38008D3675ADC034E24FAA0_des|text=|trigger=button}{sub-section}{sub-section:05C60E9BC1D2D7EF-5FF4DD27-464B4E7E-98ACA25F-F38008D3675ADC034E24FAA0_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:05C60E9BC1D2D7EF-5FF4DD27-464B4E7E-98ACA25F-F38008D3675ADC034E24FAA0_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:05C60E9BC1D2D7EF-5FF4DD27-464B4E7E-98ACA25F-F38008D3675ADC034E24FAA0_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:05C60E9BC1D2D7EF-5FF4DD27-464B4E7E-98ACA25F-F38008D3675ADC034E24FAA0_ret|text=|trigger=button}{sub-section}{sub-section:05C60E9BC1D2D7EF-5FF4DD27-464B4E7E-98ACA25F-F38008D3675ADC034E24FAA0_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:05C60E9BC1D2D7EF-5FF4DD27-464B4E7E-98ACA25F-F38008D3675ADC034E24FAA0_see|text=|trigger=button}{sub-section}{sub-section:05C60E9BC1D2D7EF-5FF4DD27-464B4E7E-98ACA25F-F38008D3675ADC034E24FAA0_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:05C60E9BC1D2D7EF-5FF4DD27-464B4E7E-98ACA25F-F38008D3675ADC034E24FAA0_see|text=|trigger=button}{sub-section}{sub-section:05C60E9BC1D2D7EF-5FF4DD27-464B4E7E-98ACA25F-F38008D3675ADC034E24FAA0_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:05C60E9BC1D2D7EF-5FF4DD27-464B4E7E-98ACA25F-F38008D3675ADC034E24FAA0_sam|text=|trigger=button}{sub-section}{sub-section:05C60E9BC1D2D7EF-5FF4DD27-464B4E7E-98ACA25F-F38008D3675ADC034E24FAA0_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=DAB03EBA5C419307-AD153CB1-4413469D-853E9514-6F0C34A8A50D78C72393534A}{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:DAB03EBA5C419307-AD153CB1-4413469D-853E9514-6F0C34A8A50D78C72393534A_des|text=|trigger=button}{sub-section}{sub-section:DAB03EBA5C419307-AD153CB1-4413469D-853E9514-6F0C34A8A50D78C72393534A_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:DAB03EBA5C419307-AD153CB1-4413469D-853E9514-6F0C34A8A50D78C72393534A_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DAB03EBA5C419307-AD153CB1-4413469D-853E9514-6F0C34A8A50D78C72393534A_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:DAB03EBA5C419307-AD153CB1-4413469D-853E9514-6F0C34A8A50D78C72393534A_ret|text=|trigger=button}{sub-section}{sub-section:DAB03EBA5C419307-AD153CB1-4413469D-853E9514-6F0C34A8A50D78C72393534A_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:DAB03EBA5C419307-AD153CB1-4413469D-853E9514-6F0C34A8A50D78C72393534A_see|text=|trigger=button}{sub-section}{sub-section:DAB03EBA5C419307-AD153CB1-4413469D-853E9514-6F0C34A8A50D78C72393534A_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DAB03EBA5C419307-AD153CB1-4413469D-853E9514-6F0C34A8A50D78C72393534A_see|text=|trigger=button}{sub-section}{sub-section:DAB03EBA5C419307-AD153CB1-4413469D-853E9514-6F0C34A8A50D78C72393534A_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DAB03EBA5C419307-AD153CB1-4413469D-853E9514-6F0C34A8A50D78C72393534A_sam|text=|trigger=button}{sub-section}{sub-section:DAB03EBA5C419307-AD153CB1-4413469D-853E9514-6F0C34A8A50D78C72393534A_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=01BCC6A242610881-5C33DE87-4ADE47C3-BB3DA48B-D9441E3791479CDC304761C3}{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:01BCC6A242610881-5C33DE87-4ADE47C3-BB3DA48B-D9441E3791479CDC304761C3_des|text=|trigger=button}{sub-section}{sub-section:01BCC6A242610881-5C33DE87-4ADE47C3-BB3DA48B-D9441E3791479CDC304761C3_des|trigger=none|class=sIndent}Returns the size of the specified file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:01BCC6A242610881-5C33DE87-4ADE47C3-BB3DA48B-D9441E3791479CDC304761C3_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:01BCC6A242610881-5C33DE87-4ADE47C3-BB3DA48B-D9441E3791479CDC304761C3_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:01BCC6A242610881-5C33DE87-4ADE47C3-BB3DA48B-D9441E3791479CDC304761C3_ret|text=|trigger=button}{sub-section}{sub-section:01BCC6A242610881-5C33DE87-4ADE47C3-BB3DA48B-D9441E3791479CDC304761C3_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:01BCC6A242610881-5C33DE87-4ADE47C3-BB3DA48B-D9441E3791479CDC304761C3_see|text=|trigger=button}{sub-section}{sub-section:01BCC6A242610881-5C33DE87-4ADE47C3-BB3DA48B-D9441E3791479CDC304761C3_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:01BCC6A242610881-5C33DE87-4ADE47C3-BB3DA48B-D9441E3791479CDC304761C3_see|text=|trigger=button}{sub-section}{sub-section:01BCC6A242610881-5C33DE87-4ADE47C3-BB3DA48B-D9441E3791479CDC304761C3_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:01BCC6A242610881-5C33DE87-4ADE47C3-BB3DA48B-D9441E3791479CDC304761C3_sam|text=|trigger=button}{sub-section}{sub-section:01BCC6A242610881-5C33DE87-4ADE47C3-BB3DA48B-D9441E3791479CDC304761C3_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=F4978514520339A2-8C59BA6D-4C4F4380-8D068660-323616D2A4C351E856F9C484}{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:F4978514520339A2-8C59BA6D-4C4F4380-8D068660-323616D2A4C351E856F9C484_des|text=|trigger=button}{sub-section}{sub-section:F4978514520339A2-8C59BA6D-4C4F4380-8D068660-323616D2A4C351E856F9C484_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:F4978514520339A2-8C59BA6D-4C4F4380-8D068660-323616D2A4C351E856F9C484_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F4978514520339A2-8C59BA6D-4C4F4380-8D068660-323616D2A4C351E856F9C484_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:F4978514520339A2-8C59BA6D-4C4F4380-8D068660-323616D2A4C351E856F9C484_ret|text=|trigger=button}{sub-section}{sub-section:F4978514520339A2-8C59BA6D-4C4F4380-8D068660-323616D2A4C351E856F9C484_ret|trigger=none|class=sIndent}[JSFile]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F4978514520339A2-8C59BA6D-4C4F4380-8D068660-323616D2A4C351E856F9C484_see|text=|trigger=button}{sub-section}{sub-section:F4978514520339A2-8C59BA6D-4C4F4380-8D068660-323616D2A4C351E856F9C484_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F4978514520339A2-8C59BA6D-4C4F4380-8D068660-323616D2A4C351E856F9C484_see|text=|trigger=button}{sub-section}{sub-section:F4978514520339A2-8C59BA6D-4C4F4380-8D068660-323616D2A4C351E856F9C484_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F4978514520339A2-8C59BA6D-4C4F4380-8D068660-323616D2A4C351E856F9C484_sam|text=|trigger=button}{sub-section}{sub-section:F4978514520339A2-8C59BA6D-4C4F4380-8D068660-323616D2A4C351E856F9C484_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=BE6EA3313E246E44-9EB11854-454A4890-B0888067-A23E9D653708E1F404C0873E}{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:BE6EA3313E246E44-9EB11854-454A4890-B0888067-A23E9D653708E1F404C0873E_des|text=|trigger=button}{sub-section}{sub-section:BE6EA3313E246E44-9EB11854-454A4890-B0888067-A23E9D653708E1F404C0873E_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:BE6EA3313E246E44-9EB11854-454A4890-B0888067-A23E9D653708E1F404C0873E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BE6EA3313E246E44-9EB11854-454A4890-B0888067-A23E9D653708E1F404C0873E_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:BE6EA3313E246E44-9EB11854-454A4890-B0888067-A23E9D653708E1F404C0873E_ret|text=|trigger=button}{sub-section}{sub-section:BE6EA3313E246E44-9EB11854-454A4890-B0888067-A23E9D653708E1F404C0873E_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BE6EA3313E246E44-9EB11854-454A4890-B0888067-A23E9D653708E1F404C0873E_see|text=|trigger=button}{sub-section}{sub-section:BE6EA3313E246E44-9EB11854-454A4890-B0888067-A23E9D653708E1F404C0873E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BE6EA3313E246E44-9EB11854-454A4890-B0888067-A23E9D653708E1F404C0873E_see|text=|trigger=button}{sub-section}{sub-section:BE6EA3313E246E44-9EB11854-454A4890-B0888067-A23E9D653708E1F404C0873E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BE6EA3313E246E44-9EB11854-454A4890-B0888067-A23E9D653708E1F404C0873E_sam|text=|trigger=button}{sub-section}{sub-section:BE6EA3313E246E44-9EB11854-454A4890-B0888067-A23E9D653708E1F404C0873E_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=596BD4DD4F5ECCEE-D963713B-4AAB4833-A684AA7F-A0C9268C7F5CE35A42AD156B}{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:596BD4DD4F5ECCEE-D963713B-4AAB4833-A684AA7F-A0C9268C7F5CE35A42AD156B_des|text=|trigger=button}{sub-section}{sub-section:596BD4DD4F5ECCEE-D963713B-4AAB4833-A684AA7F-A0C9268C7F5CE35A42AD156B_des|trigger=none|class=sIndent}Returns the modification date of a file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:596BD4DD4F5ECCEE-D963713B-4AAB4833-A684AA7F-A0C9268C7F5CE35A42AD156B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:596BD4DD4F5ECCEE-D963713B-4AAB4833-A684AA7F-A0C9268C7F5CE35A42AD156B_prs|trigger=none}targetFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:596BD4DD4F5ECCEE-D963713B-4AAB4833-A684AA7F-A0C9268C7F5CE35A42AD156B_ret|text=|trigger=button}{sub-section}{sub-section:596BD4DD4F5ECCEE-D963713B-4AAB4833-A684AA7F-A0C9268C7F5CE35A42AD156B_ret|trigger=none|class=sIndent}[Date]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:596BD4DD4F5ECCEE-D963713B-4AAB4833-A684AA7F-A0C9268C7F5CE35A42AD156B_see|text=|trigger=button}{sub-section}{sub-section:596BD4DD4F5ECCEE-D963713B-4AAB4833-A684AA7F-A0C9268C7F5CE35A42AD156B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:596BD4DD4F5ECCEE-D963713B-4AAB4833-A684AA7F-A0C9268C7F5CE35A42AD156B_see|text=|trigger=button}{sub-section}{sub-section:596BD4DD4F5ECCEE-D963713B-4AAB4833-A684AA7F-A0C9268C7F5CE35A42AD156B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:596BD4DD4F5ECCEE-D963713B-4AAB4833-A684AA7F-A0C9268C7F5CE35A42AD156B_sam|text=|trigger=button}{sub-section}{sub-section:596BD4DD4F5ECCEE-D963713B-4AAB4833-A684AA7F-A0C9268C7F5CE35A42AD156B_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=E9BEA497758DE969-C05E4940-4EC3463E-A4FCB4C7-7F6BCBCBD7376300AD52AE71}{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:E9BEA497758DE969-C05E4940-4EC3463E-A4FCB4C7-7F6BCBCBD7376300AD52AE71_des|text=|trigger=button}{sub-section}{sub-section:E9BEA497758DE969-C05E4940-4EC3463E-A4FCB4C7-7F6BCBCBD7376300AD52AE71_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:E9BEA497758DE969-C05E4940-4EC3463E-A4FCB4C7-7F6BCBCBD7376300AD52AE71_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E9BEA497758DE969-C05E4940-4EC3463E-A4FCB4C7-7F6BCBCBD7376300AD52AE71_prs|trigger=none}sourceFile
destinationFile
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:E9BEA497758DE969-C05E4940-4EC3463E-A4FCB4C7-7F6BCBCBD7376300AD52AE71_ret|text=|trigger=button}{sub-section}{sub-section:E9BEA497758DE969-C05E4940-4EC3463E-A4FCB4C7-7F6BCBCBD7376300AD52AE71_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:E9BEA497758DE969-C05E4940-4EC3463E-A4FCB4C7-7F6BCBCBD7376300AD52AE71_see|text=|trigger=button}{sub-section}{sub-section:E9BEA497758DE969-C05E4940-4EC3463E-A4FCB4C7-7F6BCBCBD7376300AD52AE71_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E9BEA497758DE969-C05E4940-4EC3463E-A4FCB4C7-7F6BCBCBD7376300AD52AE71_see|text=|trigger=button}{sub-section}{sub-section:E9BEA497758DE969-C05E4940-4EC3463E-A4FCB4C7-7F6BCBCBD7376300AD52AE71_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E9BEA497758DE969-C05E4940-4EC3463E-A4FCB4C7-7F6BCBCBD7376300AD52AE71_sam|text=|trigger=button}{sub-section}{sub-section:E9BEA497758DE969-C05E4940-4EC3463E-A4FCB4C7-7F6BCBCBD7376300AD52AE71_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=9DD7BF60AEB4E86A-B9982124-43374A0A-AAD4B891-695EC06DFF5AF0FD79305B80}{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:9DD7BF60AEB4E86A-B9982124-43374A0A-AAD4B891-695EC06DFF5AF0FD79305B80_des|text=|trigger=button}{sub-section}{sub-section:9DD7BF60AEB4E86A-B9982124-43374A0A-AAD4B891-695EC06DFF5AF0FD79305B80_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:9DD7BF60AEB4E86A-B9982124-43374A0A-AAD4B891-695EC06DFF5AF0FD79305B80_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9DD7BF60AEB4E86A-B9982124-43374A0A-AAD4B891-695EC06DFF5AF0FD79305B80_prs|trigger=none}\[file\]
\[size\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:9DD7BF60AEB4E86A-B9982124-43374A0A-AAD4B891-695EC06DFF5AF0FD79305B80_ret|text=|trigger=button}{sub-section}{sub-section:9DD7BF60AEB4E86A-B9982124-43374A0A-AAD4B891-695EC06DFF5AF0FD79305B80_ret|trigger=none|class=sIndent}byte[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:9DD7BF60AEB4E86A-B9982124-43374A0A-AAD4B891-695EC06DFF5AF0FD79305B80_see|text=|trigger=button}{sub-section}{sub-section:9DD7BF60AEB4E86A-B9982124-43374A0A-AAD4B891-695EC06DFF5AF0FD79305B80_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9DD7BF60AEB4E86A-B9982124-43374A0A-AAD4B891-695EC06DFF5AF0FD79305B80_see|text=|trigger=button}{sub-section}{sub-section:9DD7BF60AEB4E86A-B9982124-43374A0A-AAD4B891-695EC06DFF5AF0FD79305B80_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9DD7BF60AEB4E86A-B9982124-43374A0A-AAD4B891-695EC06DFF5AF0FD79305B80_sam|text=|trigger=button}{sub-section}{sub-section:9DD7BF60AEB4E86A-B9982124-43374A0A-AAD4B891-695EC06DFF5AF0FD79305B80_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=EA6F75758004A5AC-CE28B8B7-4C40451D-8F01888C-EFA34B0F7CB1831ADC433A9E}{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:EA6F75758004A5AC-CE28B8B7-4C40451D-8F01888C-EFA34B0F7CB1831ADC433A9E_des|text=|trigger=button}{sub-section}{sub-section:EA6F75758004A5AC-CE28B8B7-4C40451D-8F01888C-EFA34B0F7CB1831ADC433A9E_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:EA6F75758004A5AC-CE28B8B7-4C40451D-8F01888C-EFA34B0F7CB1831ADC433A9E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EA6F75758004A5AC-CE28B8B7-4C40451D-8F01888C-EFA34B0F7CB1831ADC433A9E_prs|trigger=none}\[file\]
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:EA6F75758004A5AC-CE28B8B7-4C40451D-8F01888C-EFA34B0F7CB1831ADC433A9E_ret|text=|trigger=button}{sub-section}{sub-section:EA6F75758004A5AC-CE28B8B7-4C40451D-8F01888C-EFA34B0F7CB1831ADC433A9E_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:EA6F75758004A5AC-CE28B8B7-4C40451D-8F01888C-EFA34B0F7CB1831ADC433A9E_see|text=|trigger=button}{sub-section}{sub-section:EA6F75758004A5AC-CE28B8B7-4C40451D-8F01888C-EFA34B0F7CB1831ADC433A9E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:EA6F75758004A5AC-CE28B8B7-4C40451D-8F01888C-EFA34B0F7CB1831ADC433A9E_see|text=|trigger=button}{sub-section}{sub-section:EA6F75758004A5AC-CE28B8B7-4C40451D-8F01888C-EFA34B0F7CB1831ADC433A9E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:EA6F75758004A5AC-CE28B8B7-4C40451D-8F01888C-EFA34B0F7CB1831ADC433A9E_sam|text=|trigger=button}{sub-section}{sub-section:EA6F75758004A5AC-CE28B8B7-4C40451D-8F01888C-EFA34B0F7CB1831ADC433A9E_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=2893738E1B95BE1D-E1F3EBE8-4FAD41D7-B78CBDDA-3A66E18CDC8F8F9B9DD183FC}{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:2893738E1B95BE1D-E1F3EBE8-4FAD41D7-B78CBDDA-3A66E18CDC8F8F9B9DD183FC_des|text=|trigger=button}{sub-section}{sub-section:2893738E1B95BE1D-E1F3EBE8-4FAD41D7-B78CBDDA-3A66E18CDC8F8F9B9DD183FC_des|trigger=none|class=sIndent}Shows a directory selector dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:2893738E1B95BE1D-E1F3EBE8-4FAD41D7-B78CBDDA-3A66E18CDC8F8F9B9DD183FC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2893738E1B95BE1D-E1F3EBE8-4FAD41D7-B78CBDDA-3A66E18CDC8F8F9B9DD183FC_prs|trigger=none}\[directory suggestion\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:2893738E1B95BE1D-E1F3EBE8-4FAD41D7-B78CBDDA-3A66E18CDC8F8F9B9DD183FC_ret|text=|trigger=button}{sub-section}{sub-section:2893738E1B95BE1D-E1F3EBE8-4FAD41D7-B78CBDDA-3A66E18CDC8F8F9B9DD183FC_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:2893738E1B95BE1D-E1F3EBE8-4FAD41D7-B78CBDDA-3A66E18CDC8F8F9B9DD183FC_see|text=|trigger=button}{sub-section}{sub-section:2893738E1B95BE1D-E1F3EBE8-4FAD41D7-B78CBDDA-3A66E18CDC8F8F9B9DD183FC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2893738E1B95BE1D-E1F3EBE8-4FAD41D7-B78CBDDA-3A66E18CDC8F8F9B9DD183FC_see|text=|trigger=button}{sub-section}{sub-section:2893738E1B95BE1D-E1F3EBE8-4FAD41D7-B78CBDDA-3A66E18CDC8F8F9B9DD183FC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2893738E1B95BE1D-E1F3EBE8-4FAD41D7-B78CBDDA-3A66E18CDC8F8F9B9DD183FC_sam|text=|trigger=button}{sub-section}{sub-section:2893738E1B95BE1D-E1F3EBE8-4FAD41D7-B78CBDDA-3A66E18CDC8F8F9B9DD183FC_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=BDF01546660051AB-97DFD57F-43AC4145-84A084D0-ECD41A83F99BFD6715829DC8}{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:BDF01546660051AB-97DFD57F-43AC4145-84A084D0-ECD41A83F99BFD6715829DC8_des|text=|trigger=button}{sub-section}{sub-section:BDF01546660051AB-97DFD57F-43AC4145-84A084D0-ECD41A83F99BFD6715829DC8_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:BDF01546660051AB-97DFD57F-43AC4145-84A084D0-ECD41A83F99BFD6715829DC8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BDF01546660051AB-97DFD57F-43AC4145-84A084D0-ECD41A83F99BFD6715829DC8_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:BDF01546660051AB-97DFD57F-43AC4145-84A084D0-ECD41A83F99BFD6715829DC8_ret|text=|trigger=button}{sub-section}{sub-section:BDF01546660051AB-97DFD57F-43AC4145-84A084D0-ECD41A83F99BFD6715829DC8_ret|trigger=none|class=sIndent}Object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BDF01546660051AB-97DFD57F-43AC4145-84A084D0-ECD41A83F99BFD6715829DC8_see|text=|trigger=button}{sub-section}{sub-section:BDF01546660051AB-97DFD57F-43AC4145-84A084D0-ECD41A83F99BFD6715829DC8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BDF01546660051AB-97DFD57F-43AC4145-84A084D0-ECD41A83F99BFD6715829DC8_see|text=|trigger=button}{sub-section}{sub-section:BDF01546660051AB-97DFD57F-43AC4145-84A084D0-ECD41A83F99BFD6715829DC8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BDF01546660051AB-97DFD57F-43AC4145-84A084D0-ECD41A83F99BFD6715829DC8_sam|text=|trigger=button}{sub-section}{sub-section:BDF01546660051AB-97DFD57F-43AC4145-84A084D0-ECD41A83F99BFD6715829DC8_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=46ACFE546A5B07E9-1D9A7FA5-4C3A401A-B285A5FB-515246E59A493B348447B90D}{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:46ACFE546A5B07E9-1D9A7FA5-4C3A401A-B285A5FB-515246E59A493B348447B90D_des|text=|trigger=button}{sub-section}{sub-section:46ACFE546A5B07E9-1D9A7FA5-4C3A401A-B285A5FB-515246E59A493B348447B90D_des|trigger=none|class=sIndent}Shows a file save dialog.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:46ACFE546A5B07E9-1D9A7FA5-4C3A401A-B285A5FB-515246E59A493B348447B90D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:46ACFE546A5B07E9-1D9A7FA5-4C3A401A-B285A5FB-515246E59A493B348447B90D_prs|trigger=none}\[fileName/dir suggestion\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:46ACFE546A5B07E9-1D9A7FA5-4C3A401A-B285A5FB-515246E59A493B348447B90D_ret|text=|trigger=button}{sub-section}{sub-section:46ACFE546A5B07E9-1D9A7FA5-4C3A401A-B285A5FB-515246E59A493B348447B90D_ret|trigger=none|class=sIndent}[JSFile]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:46ACFE546A5B07E9-1D9A7FA5-4C3A401A-B285A5FB-515246E59A493B348447B90D_see|text=|trigger=button}{sub-section}{sub-section:46ACFE546A5B07E9-1D9A7FA5-4C3A401A-B285A5FB-515246E59A493B348447B90D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:46ACFE546A5B07E9-1D9A7FA5-4C3A401A-B285A5FB-515246E59A493B348447B90D_see|text=|trigger=button}{sub-section}{sub-section:46ACFE546A5B07E9-1D9A7FA5-4C3A401A-B285A5FB-515246E59A493B348447B90D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:46ACFE546A5B07E9-1D9A7FA5-4C3A401A-B285A5FB-515246E59A493B348447B90D_sam|text=|trigger=button}{sub-section}{sub-section:46ACFE546A5B07E9-1D9A7FA5-4C3A401A-B285A5FB-515246E59A493B348447B90D_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=E444CA4EDFD1ED4D-36D51A54-4FD74781-B831ADCA-D83359CBF556DA16BCBFE8DC}{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:E444CA4EDFD1ED4D-36D51A54-4FD74781-B831ADCA-D83359CBF556DA16BCBFE8DC_des|text=|trigger=button}{sub-section}{sub-section:E444CA4EDFD1ED4D-36D51A54-4FD74781-B831ADCA-D83359CBF556DA16BCBFE8DC_des|trigger=none|class=sIndent}Writes data into a binary file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:E444CA4EDFD1ED4D-36D51A54-4FD74781-B831ADCA-D83359CBF556DA16BCBFE8DC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E444CA4EDFD1ED4D-36D51A54-4FD74781-B831ADCA-D83359CBF556DA16BCBFE8DC_prs|trigger=none}file
binary_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:E444CA4EDFD1ED4D-36D51A54-4FD74781-B831ADCA-D83359CBF556DA16BCBFE8DC_ret|text=|trigger=button}{sub-section}{sub-section:E444CA4EDFD1ED4D-36D51A54-4FD74781-B831ADCA-D83359CBF556DA16BCBFE8DC_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:E444CA4EDFD1ED4D-36D51A54-4FD74781-B831ADCA-D83359CBF556DA16BCBFE8DC_see|text=|trigger=button}{sub-section}{sub-section:E444CA4EDFD1ED4D-36D51A54-4FD74781-B831ADCA-D83359CBF556DA16BCBFE8DC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E444CA4EDFD1ED4D-36D51A54-4FD74781-B831ADCA-D83359CBF556DA16BCBFE8DC_see|text=|trigger=button}{sub-section}{sub-section:E444CA4EDFD1ED4D-36D51A54-4FD74781-B831ADCA-D83359CBF556DA16BCBFE8DC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E444CA4EDFD1ED4D-36D51A54-4FD74781-B831ADCA-D83359CBF556DA16BCBFE8DC_sam|text=|trigger=button}{sub-section}{sub-section:E444CA4EDFD1ED4D-36D51A54-4FD74781-B831ADCA-D83359CBF556DA16BCBFE8DC_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=29FEEDD4A7EAF0E5-0982BC48-42634E50-BE6BA140-D2619D683569457526449EFE}{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:29FEEDD4A7EAF0E5-0982BC48-42634E50-BE6BA140-D2619D683569457526449EFE_des|text=|trigger=button}{sub-section}{sub-section:29FEEDD4A7EAF0E5-0982BC48-42634E50-BE6BA140-D2619D683569457526449EFE_des|trigger=none|class=sIndent}Writes data into a text file.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:29FEEDD4A7EAF0E5-0982BC48-42634E50-BE6BA140-D2619D683569457526449EFE_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:29FEEDD4A7EAF0E5-0982BC48-42634E50-BE6BA140-D2619D683569457526449EFE_prs|trigger=none}file
text_data
\[charsetname\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:29FEEDD4A7EAF0E5-0982BC48-42634E50-BE6BA140-D2619D683569457526449EFE_ret|text=|trigger=button}{sub-section}{sub-section:29FEEDD4A7EAF0E5-0982BC48-42634E50-BE6BA140-D2619D683569457526449EFE_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:29FEEDD4A7EAF0E5-0982BC48-42634E50-BE6BA140-D2619D683569457526449EFE_see|text=|trigger=button}{sub-section}{sub-section:29FEEDD4A7EAF0E5-0982BC48-42634E50-BE6BA140-D2619D683569457526449EFE_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:29FEEDD4A7EAF0E5-0982BC48-42634E50-BE6BA140-D2619D683569457526449EFE_see|text=|trigger=button}{sub-section}{sub-section:29FEEDD4A7EAF0E5-0982BC48-42634E50-BE6BA140-D2619D683569457526449EFE_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:29FEEDD4A7EAF0E5-0982BC48-42634E50-BE6BA140-D2619D683569457526449EFE_sam|text=|trigger=button}{sub-section}{sub-section:29FEEDD4A7EAF0E5-0982BC48-42634E50-BE6BA140-D2619D683569457526449EFE_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=9A05528C277299E8-9E95B474-411D4173-88F68927-D95A7B3EAD3340D39488F5BA}{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:9A05528C277299E8-9E95B474-411D4173-88F68927-D95A7B3EAD3340D39488F5BA_des|text=|trigger=button}{sub-section}{sub-section:9A05528C277299E8-9E95B474-411D4173-88F68927-D95A7B3EAD3340D39488F5BA_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:9A05528C277299E8-9E95B474-411D4173-88F68927-D95A7B3EAD3340D39488F5BA_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9A05528C277299E8-9E95B474-411D4173-88F68927-D95A7B3EAD3340D39488F5BA_prs|trigger=none}file
xml_data
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:9A05528C277299E8-9E95B474-411D4173-88F68927-D95A7B3EAD3340D39488F5BA_ret|text=|trigger=button}{sub-section}{sub-section:9A05528C277299E8-9E95B474-411D4173-88F68927-D95A7B3EAD3340D39488F5BA_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:9A05528C277299E8-9E95B474-411D4173-88F68927-D95A7B3EAD3340D39488F5BA_see|text=|trigger=button}{sub-section}{sub-section:9A05528C277299E8-9E95B474-411D4173-88F68927-D95A7B3EAD3340D39488F5BA_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9A05528C277299E8-9E95B474-411D4173-88F68927-D95A7B3EAD3340D39488F5BA_see|text=|trigger=button}{sub-section}{sub-section:9A05528C277299E8-9E95B474-411D4173-88F68927-D95A7B3EAD3340D39488F5BA_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9A05528C277299E8-9E95B474-411D4173-88F68927-D95A7B3EAD3340D39488F5BA_sam|text=|trigger=button}{sub-section}{sub-section:9A05528C277299E8-9E95B474-411D4173-88F68927-D95A7B3EAD3340D39488F5BA_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}