Table des matières
File
L'objet Fichier vous permet de lire et écrire un fichier.
Fonctions
File
Fonction de construction.
Syntaxe
var myObject = new File();
Exemple
Créer l'objet Fichier.
var myObject = new File();
copy
Copier un fichier.
Syntaxe
File.copy(source, destination);
File.copy(source, destination, options);
Arguments
- source - (string) la source du fichier à copier
- destination - (string) la destination fichier/dossier
- options - (object) [Ajouté dans Actionaz 3.0.1.]
- noErrorDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait si une erreur est rencontrée ?(Windows seulement, défaut: vrai)
- noConfirmDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait si une confirmation est requise ? (Windows seulement, défaut: vrai)
- noProgressDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait en cours de progression (Windows seulement, défaut: vrai)
- createDestinationDirectory - (bool) le chemin de destination devrait-il être créé s'il n'existe pas ? (Linux seulement, défaut: vrai)
Renvoie
- (null) rien
Exceptions
- (ParameterCountError) paramètre de compteur incorrect
- (DirectoryCreationError) impossible de créer le dossier de destination (Linux seulement)
- (DirectoryDoesntExistError) le dossier de destination n'existe pas (Linux seulement)
- (CopyError) copie échouée
- (CopyAbortedError) copie annulée (Windows seulement)
move
Déplace un fichier.
Syntaxe
File.move(source, destination);
File.move(source, destination, options);
Arguments
- source - (string) la source du fichier à déplcer
- destination - (string) la destination du fichier/dossier
- options - (object) [Ajouté dans Actionaz 3.0.1.]
- noErrorDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait si une erreur est rencontrée ?(Windows seulement, défaut: vrai)
- noConfirmDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait si une confirmation est requise ? (Windows seulement, défaut: vrai)
- noProgressDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait en cours de progression (Windows seulement, défaut: vrai)
- createDestinationDirectory - (bool) le chemin de destination devrait-il être créé s'il n'existe pas ? (Linux seulement, défaut: vrai)
Renvoie
- (null) rien
Exceptions
- (ParameterCountError) paramètre de compteur incorrect
- (DirectoryCreationError) impossible de créer le dossier de destination (Linux seulement)
- (DirectoryDoesntExistError) le dossier de destination n'existe pas (Linux seulement)
- (MoveError) déplacement échoué
- (MoveAbortedError) déplacement annulé (Windows seulement)
rename
Cette fonction est un alias de la fonction move .
remove
Supprimer un fichier.
Syntaxe
File.remove(filename);
File.remove(filename, options);
Arguments
- filename - (string) le fichier à supprimer
- options - (object) [Ajouté dans Actionaz 3.0.1.]
- noErrorDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait si une erreur est rencontrée ?(Windows seulement, défaut: vrai)
- noConfirmDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait si une confirmation est requise ? (Windows seulement, défaut: vrai)
- noProgressDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait en cours de progression (Windows seulement, défaut: vrai)
- allowUndo - (bool) le fichier/dossier doit-il être envoyé vers la corbeille (Windows seulement, défaut: faux)
Renvoie
- (null) rien
Exceptions
- (ParameterCountError) paramètre de compteur incorrect
- (RemoveError) supression échoué
- (RemoveAbortedError) supression annulée (Windows seulement)
Methods
open
Ouvrir un fichier.
Syntaxe
myObject.open(filename, openMode);
Arguments
- filename - (string) le nom de fichier du fichier à ouvrir
- openMode - (OpenMode) le mode ouvrir
Returns
- (File) ce Fichier
Exceptions
- (CannotOpenFileError) ne peut pas ouvrir le fichier
write
Écrire une série de données sur un fichier.
Syntaxe
myObject.write(data);
myObject.write(other);
Arguments
- data - (RawData) les données à écrire
- other - (mixed) les données à écrire
Renvoie
- (File) ce Fichier
Exceptions
- (WriteFailedError) écriture échouée
writeText
Écrire du texte sur un fichier.
Syntaxe
myObject.writeText(text);
myObject.writeText(text, encoding);
Arguments
- text - (string) le texte à écrire
- encoding - (Encoding) l'encodage à utiliser
Renvoie
- (File) ce Fichier
Exceptions
- (WriteFailedError) écriture échouée
read
Lire une série de données à partir d'un fichier.
Syntaxe
myObject.read();
Renvoie
- (RawData) la série de donnée en provenance du fichier
readText
Lire du texte à partir d'un fichier.
Syntaxe
myObject.readText();
myObject.readText(encoding);
Arguments
- encoding - (Encoding) l'encodage à utiliser
Renvoie
- (string) le texte à lire en provenance du fichier
close
Fermer un fichier.
Syntaxe
myObject.close();
Renvoie
- (File) ce Fichier
copy
Copier ce fichier vers une autre destination.
Syntaxe
myObject.copy(destination);
myObject.copy(destination, options);
Arguments
- destination - (string) la destination où doit être copié ce fichier
- options - (object) [Ajouté dans Actionaz 3.0.1.]
- noErrorDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait si une erreur est rencontrée ?(Windows seulement, défaut: vrai)
- noConfirmDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait si une confirmation est requise ? (Windows seulement, défaut: vrai)
- noProgressDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait en cours de progression (Windows seulement, défaut: vrai)
- createDestinationDirectory - (bool) le chemin de destination devrait-il être créé s'il n'existe pas ? (Linux seulement, défaut: vrai)
Renvoie
- (File) ce Fichier
Exceptions
- (ParameterCountError) paramètre de compteur incorrect
- (DirectoryCreationError) impossible de créer le répertoire de destination (Linux seulement)
- (DirectoryDoesntExistError) le répertoire de destination n'existe pas (Linux seulement)
- (CopyError) copie échouée
- (CopyAbortedError) copy annulée (Windows seulement)
move
Déplacer un fichier vers une autre destination.
Syntaxe
myObject.move(destination);
myObject.move(destination, options);
Arguments
- destination - (string) la destination où déplacer le fichier
- options - (object) [Ajouté dans Actionaz 3.0.1.]
- noErrorDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait si une erreur est rencontrée ?(Windows seulement, défaut: vrai)
- noConfirmDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait si une confirmation est requise ? (Windows seulement, défaut: vrai)
- noProgressDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait en cours de progression (Windows seulement, défaut: vrai)
- createDestinationDirectory - (bool) le chemin de destination devrait-il être créé s'il n'existe pas ? (Linux seulement, défaut: vrai)
Renvoie
- (File) ce Fichier
Exceptions
- (ParameterCountError) paramètre de compteur incorrect
- (DirectoryCreationError) impossible de créer le répertoire de destination (Linux seulement)
- (DirectoryDoesntExistError) le répertoire de destination n'existe pas (Linux seulement)
- (MoveError) déplacement échoué
- (MoveAbortedError) déplacement annulé (Windows seulement)
rename
Cette méthode est un alias de la méthode move .
remove
Supprimer un fichier.
Syntaxe
myObject.remove();
myObject.remove(options);
Arguments
- options - (object) [Ajouté dans Actionaz 3.0.1.]
- noErrorDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait si une erreur est rencontrée ?(Windows seulement, défaut: vrai)
- noConfirmDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait si une confirmation est requise ? (Windows seulement, défaut: vrai)
- noProgressDialog - (bool) devrait-il y avoir une fenêtre de dialogue qui apparait en cours de progression (Windows seulement, défaut: vrai)
- allowUndo - (bool) le fichier/dossier doit-il être envoyé vers la corbeille (Windows seulement, défaut: faux)
Renvoie
- (File) ce Fichier
Exceptions
- (ParameterCountError) paramètre de compteur incorrect
- (RemoveError) suppression échouée
- (RemoveAbortedError) suppression annulée (Windows seulement)
Enumerations
OpenMode
Mode ouverture de Fichier.
Values
- ReadOnly: fichier ouvert pour lecture seule
- WriteOnly: fichier ouvert pour écriture seule
- ReadWrite: fichier ouvert pour lecture et écriture
- Append: fichier ouvert pour une écriture à la fin de ce fichier
- Truncate: fichier ouvert pour une écriture en effaçant tout le contenu précédent
- Text: fichier ouvert en mode texte
- Unbuffered: fichier ouvert en mode "unbuffered" (sans tampon)
Notes
C'est une suite d’indicateur, ce qui signifie que vous pouvez utilisez plusieurs valeurs en utilisant l'opérateur | .
Example:
myObject.open("myfile.txt", File.WriteOnly | File.Append | File.Text);