File

The File object allows you to read and write a file.

Constructor function.

var myObject = new File();

Create a File object.

var myObject = new File();

Copy a file.

File.copy(source, destination);

File.copy(source, destination, options);

1. source - (string) the source file to copy
2. destination - (string) the destination file/directory
3. options - (object) [Added in Actionaz 3.0.1.]
   • noErrorDialog - (bool) should an error dialog be shown if an error occurs (Windows only, default: true)
   • noConfirmDialog - (bool) should a confirmation dialog be shown if needed (Windows only, default: true)
   • noProgressDialog - (bool) should a progress dialog be shown (Windows only, default: true)
   • createDestinationDirectory - (bool) should the destination directory be created if it doesn't exist (Linux only, default: true)

• (null) nothing

• (ParameterCountError) incorrect parameter count
• (DirectoryCreationError) unable to create the destination directory (Linux only)
• (DirectoryDoesntExistError) the destination directory doesn't exist (Linux only)
• (CopyError) copy failed
• (CopyAbortedError) copy aborted (Windows only)

Move a file.

File.move(source, destination);

File.move(source, destination, options);

1. source - (string) the source file to move
2. destination - (string) the destination file/directory
3. options - (object) [Added in Actionaz 3.0.1.]
   • noErrorDialog - (bool) should an error dialog be shown if an error occurs (Windows only, default: true)
   • noConfirmDialog - (bool) should a confirmation dialog be shown if needed (Windows only, default: true)
   • noProgressDialog - (bool) should a progress dialog be shown (Windows only, default: true)
   • createDestinationDirectory - (bool) should the destination directory be created if it doesn't exist (Linux only, default: true)

• (null) nothing

• (ParameterCountError) incorrect parameter count
• (DirectoryCreationError) unable to create the destination directory (Linux only)
• (DirectoryDoesntExistError) the destination directory doesn't exist (Linux only)
• (MoveError) move failed
• (MoveAbortedError) move aborted (Windows only)

This function is an alias of the move function.

Remove a file.

File.remove(filename);

File.remove(filename, options);

1. filename - (string) the file to remove
2. options - (object) [Added in Actionaz 3.0.1.]
   • noErrorDialog - (bool) should an error dialog be shown if an error occurs (Windows only, default: true)
   • noConfirmDialog - (bool) should a confirmation dialog be shown if needed (Windows only, default: true)
   • noProgressDialog - (bool) should a progress dialog be shown (Windows only, default: true)
   • allowUndo - (bool) should the file/directory be moved to the trash bin (Windows only, default: false)

• (null) nothing

• (ParameterCountError) incorrect parameter count
• (RemoveError) remove failed
• (RemoveAbortedError) remove aborted (Windows only)

Opens a file.

myObject.open(filename, openMode);

1. filename - (string) the filename of the file to open
2. openMode - (OpenMode) the open mode

• (File) this File

• (CannotOpenFileError) cannot open the file

Write raw data to this File.

myObject.write(data);

myObject.write(other);

1. data - (RawData) the data to write
2. other - (mixed) the data to write

• (File) this File

• (WriteFailedError) write failed

Write text to this File.

myObject.writeText(text);

myObject.writeText(text, encoding);

1. text - (string) the text to write
2. encoding - (Encoding) the encoding to use

• (File) this File

• (WriteFailedError) write failed

Read raw data from this File.

myObject.read();

• (RawData) the raw data read from the file

Read text from this File.

myObject.readText();

myObject.readText(encoding);

1. encoding - (Encoding) the encoding to use

• (string) the text read from the file

Close this file.

myObject.close();

• (File) this File

Copy this file to another location.

myObject.copy(destination);

myObject.copy(destination, options);

1. destination - (string) the location where to copy the file
2. options - (object) [Added in Actionaz 3.0.1.]
   • noErrorDialog - (bool) should an error dialog be shown if an error occurs (Windows only, default: true)
   • noConfirmDialog - (bool) should a confirmation dialog be shown if needed (Windows only, default: true)
   • noProgressDialog - (bool) should a progress dialog be shown (Windows only, default: true)
   • createDestinationDirectory - (bool) should the destination directory be created if it doesn't exist (Linux only, default: true)

• (File) this File

• (ParameterCountError) incorrect parameter count
• (DirectoryCreationError) unable to create the destination directory (Linux only)
• (DirectoryDoesntExistError) the destination directory doesn't exist (Linux only)
• (CopyError) copy failed
• (CopyAbortedError) copy aborted (Windows only)

Move this file to another location.

myObject.move(destination);

myObject.move(destination, options);

1. destination - (string) the location where to move the file
2. options - (object) [Added in Actionaz 3.0.1.]
   • noErrorDialog - (bool) should an error dialog be shown if an error occurs (Windows only, default: true)
   • noConfirmDialog - (bool) should a confirmation dialog be shown if needed (Windows only, default: true)
   • noProgressDialog - (bool) should a progress dialog be shown (Windows only, default: true)
   • createDestinationDirectory - (bool) should the destination directory be created if it doesn't exist (Linux only, default: true)

• (File) this File

• (ParameterCountError) incorrect parameter count
• (DirectoryCreationError) unable to create the destination directory (Linux only)
• (DirectoryDoesntExistError) the destination directory doesn't exist (Linux only)
• (MoveError) move failed
• (MoveAbortedError) move aborted (Windows only)

This method is an alias of the move method.

Remove this file.

myObject.remove();

myObject.remove(options);

1. options - (object) [Added in Actionaz 3.0.1.]
   • noErrorDialog - (bool) should an error dialog be shown if an error occurs (Windows only, default: true)
   • noConfirmDialog - (bool) should a confirmation dialog be shown if needed (Windows only, default: true)
   • noProgressDialog - (bool) should a progress dialog be shown (Windows only, default: true)
   • allowUndo - (bool) should the file/directory be moved to the trash bin (Windows only, default: false)

• (File) this File

• (ParameterCountError) incorrect parameter count
• (RemoveError) remove failed
• (RemoveAbortedError) remove aborted (Windows only)

File open mode.

1. ReadOnly: file opened for reading only
2. WriteOnly: file opened for writing only
3. ReadWrite: file opened for reading and writing
4. Append: file opened for writing at the end of the file
5. Truncate: file opened for writing, erases any previous content
6. Text: file opened in text mode
7. Unbuffered: file opened in unbuffered mode

This is a flag enumeration, that means that you can use multiple values using the | operator. Example:

myObject.open("myfile.txt", File.WriteOnly | File.Append | File.Text);