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

===== Functions =====

==== File ====
Constructor function.

=== Syntax ===
<code javascript>
var myObject = new File();
</code>

=== Example ===
Create a File object.
<code javascript>
var myObject = new File();
</code>

==== copy ====
Copy a file.

=== Syntax ===
<code javascript>
File.copy(source, destination);
</code>
<code javascript>
File.copy(source, destination, options);
</code>

=== Arguments ===
  - source - (string) the source file to copy
  - destination - (string) the destination file/directory
  - 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)

=== Returns ===
  * (null) nothing

=== Exceptions ===
  * (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 ====
Move a file.

=== Syntax ===
<code javascript>
File.move(source, destination);
</code>
<code javascript>
File.move(source, destination, options);
</code>

=== Arguments ===
  - source - (string) the source file to move
  - destination - (string) the destination file/directory
  - 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)

=== Returns ===
  * (null) nothing

=== Exceptions ===
  * (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)

==== rename ====
This function is an alias of the [[#move|move]] function.

==== remove ====
Remove a file.

=== Syntax ===
<code javascript>
File.remove(filename);
</code>
<code javascript>
File.remove(filename, options);
</code>

=== Arguments ===
  - filename - (string) the file to remove
  - 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)

=== Returns ===
  * (null) nothing

=== Exceptions ===
  * (ParameterCountError) incorrect parameter count
  * (RemoveError) remove failed
  * (RemoveAbortedError) remove aborted (Windows only)

===== Methods =====

==== open ====
Opens a file.

=== Syntax ===
<code javascript>
myObject.open(filename, openMode);
</code>

=== Arguments ===
  - filename - (string) the filename of the file to open
  - openMode - ([[#openmode|OpenMode]]) the open mode

=== Returns ===
  * (File) this File

=== Exceptions ===
  * (CannotOpenFileError) cannot open the file

==== write ====
Write raw data to this File.

=== Syntax ===
<code javascript>
myObject.write(data);
</code>
<code javascript>
myObject.write(other);
</code>

=== Arguments ===
  - data - ([[en:code:core:rawdata|RawData]]) the data to write
  - other - (mixed) the data to write

=== Returns ===
  * (File) this File

=== Exceptions ===
  * (WriteFailedError) write failed

==== writeText ====
Write text to this File.

=== Syntax ===
<code javascript>
myObject.writeText(text);
</code>
<code javascript>
myObject.writeText(text, encoding);
</code>

=== Arguments ===
  - text - (string) the text to write
  - encoding - ([[en:code:core:global#encoding|Encoding]]) the encoding to use

=== Returns ===
  * (File) this File

=== Exceptions ===
  * (WriteFailedError) write failed

==== read ====
Read raw data from this File.

=== Syntax ===
<code javascript>
myObject.read();
</code>

=== Returns ===
  * ([[en:code:core:rawdata|RawData]]) the raw data read from the file

==== readText ====
Read text from this File.

=== Syntax ===
<code javascript>
myObject.readText();
</code>
<code javascript>
myObject.readText(encoding);
</code>

=== Arguments ===
  - encoding - ([[en:code:core:global#encoding|Encoding]]) the encoding to use

=== Returns ===
  * (string) the text read from the file

==== close ====
Close this file.

=== Syntax ===
<code javascript>
myObject.close();
</code>

=== Returns ===
  * (File) this File

==== copy ====
Copy this file to another location.

=== Syntax ===
<code javascript>
myObject.copy(destination);
</code>
<code javascript>
myObject.copy(destination, options);
</code>

=== Arguments ===
  - destination - (string) the location where to copy the file
  - 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)

=== Returns ===
  * (File) this File

=== Exceptions ===
  * (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 ====
Move this file to another location.

=== Syntax ===
<code javascript>
myObject.move(destination);
</code>
<code javascript>
myObject.move(destination, options);
</code>

=== Arguments ===
  - destination - (string) the location where to move the file
  - 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)

=== Returns ===
  * (File) this File

=== Exceptions ===
  * (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)

==== rename ====
This method is an alias of the [[#move1|move]] method.

==== remove ====
Remove this file.

=== Syntax ===
<code javascript>
myObject.remove();
</code>
<code javascript>
myObject.remove(options);
</code>

=== Arguments ===
  - 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)

=== Returns ===
  * (File) this File

=== Exceptions ===
  * (ParameterCountError) incorrect parameter count
  * (RemoveError) remove failed
  * (RemoveAbortedError) remove aborted (Windows only)

===== Enumerations =====

==== OpenMode ====
File open mode.

=== Values ===
  - ReadOnly: file opened for reading only
  - WriteOnly: file opened for writing only
  - ReadWrite: file opened for reading and writing
  - Append: file opened for writing at the end of the file
  - Truncate: file opened for writing, erases any previous content
  - Text: file opened in text mode
  - Unbuffered: file opened in unbuffered mode

=== Notes ===
This is a flag enumeration, that means that you can use multiple values using the | operator.
Example:
<code javascript>
myObject.open("myfile.txt", File.WriteOnly | File.Append | File.Text);
</code>