Document Class

Description

.creationDate

Historique

Release	Modifications
17 R5	Ajout

.creationDate : Date

Description

La propriété .creationDate retourne la date de création du fichier.

Cette propriété est en lecture seule.

.creationTime

Historique

Release	Modifications
17 R5	Ajout

.creationTime : Time

Description

La propriété .creationTime renvoie l'heure de création du fichier (exprimée en nombre de secondes commençant à 00:00).

Cette propriété est en lecture seule.

.exists

Historique

Release	Modifications
17 R5	Ajout

.exists : Boolean

Description

La propriété .exists renvoie true si le fichier existe sur le disque, et false sinon.

Cette propriété est en lecture seule.

.extension

Historique

Release	Modifications
17 R5	Ajout

.extension : Text

Description

La propriété .extension renvoie l'extension du nom du fichier (s'il y en a une). Une extension commence toujours par ".". La propriété renvoie une chaîne vide si le nom du fichier n'a pas d'extension.

Cette propriété est en lecture seule.

.fullName

Historique

Release	Modifications
17 R5	Ajout

.fullName : Text

Description

La propriété .fullName renvoie le nom complet du fichier, y compris son extension (le cas échéant).

Cette propriété est en lecture seule.

.hidden

Historique

Release	Modifications
17 R5	Ajout

.hidden : Boolean

Description

La propriété .hidden renvoie true si le fichier est défini comme "hidden" au niveau du système, et false dans le cas contraire.

Cette propriété est en lecture/écriture.

.isAlias

Historique

Release	Modifications
17 R5	Ajout

.isAlias : Boolean

Description

La propriété .isAlias renvoie true si le fichier est un alias, un raccourci ou un lien symbolique, et false dans le cas contraire.

Cette propriété est en lecture seule.

.isFile

Historique

Release	Modifications
17 R5	Ajout

.isFile : Boolean

Description

La propriété .isFile retourne toujours true pour un fichier.

Cette propriété est en lecture seule.

.isFolder

Historique

Release	Modifications
17 R5	Ajout

.isFolder : Boolean

Description

La propriété .isFolder retourne toujours false pour un fichier.

Cette propriété est en lecture seule.

.isWritable

Historique

Release	Modifications
17 R5	Ajout

.isWritable : Boolean

Description

La propriété .isWritable renvoie true si le fichier existe sur le disque et est modifiable.

Cette propriété vérifie la capacité de l'application 4D à écrire sur le disque (droits d'accès). elle ne se base pas uniquement sur l'attribut writable du fichier.

Cette propriété est en lecture seule.

Example

 $myFile:=File("C:\\Documents\\Archives\\ReadMe.txt";fk platform path)
 If($myFile.isWritable)
    $myNewFile:=$myFile.setText("Added text")
 End if

.modificationDate

Historique

Release	Modifications
17 R5	Ajout

.modificationDate : Date

Description

La propriété .modificationDate renvoie la date de la dernière modification du fichier.

Cette propriété est en lecture seule.

.modificationTime

Historique

Release	Modifications
17 R5	Ajout

.modificationTime : Time

Description

La propriété .modificationTime renvoie l'heure de la dernière modification du fichier (exprimée en nombre de secondes à partir de 00:00).

Cette propriété est en lecture seule.

.name

Historique

Release	Modifications
17 R5	Ajout

.name : Text

Description

La propriété .name renvoie le nom du fichier sans extension (s'il y en a une).

Cette propriété est en lecture seule.

.original

Historique

Release	Modifications
17 R5	Ajout

.original : 4D.File
.original : 4D.Folder

Description

La propriété .original renvoie l'élément cible d'un fichier alias, d'un raccourci ou d'un lien symbolique. L'élément cible peut être :

• un objet File
• un objet Folder

Pour les fichiers sans alias, la propriété retourne le même objet File que le fichier.

Cette propriété est en lecture seule.

.parent

Historique

Release	Modifications
17 R5	Ajout

.parent : 4D.Folder

Description

La propriété .parent retourne l'objet dossier parent du fichier. Si le chemin représente un filesystem (ex : "/DATA/"), le filesystem est retourné.

Cette propriété est en lecture seule.

.path

Historique

Release	Modifications
17 R5	Ajout

.path : Text

Description

La propriété .path retourne le chemin POSIX du fichier. Si le chemin représente un filesystem (ex : "/DATA/"), le filesystem est retourné.

Cette propriété est en lecture seule.

.platformPath

Historique

Release	Modifications
17 R5	Ajout

.platformPath : Text

Description

La propriété .platformPath retourne le chemin du fichier exprimé dans la syntaxe de la plate-forme courante.

Cette propriété est en lecture seule.

.size

Historique

Release	Modifications
17 R5	Ajout

.size : Real

Description

La propriété .size renvoie la taille du fichier exprimée en octets. Si le fichier n'existe pas sur le disque, la taille est de 0.

Cette propriété est en lecture seule.

.copyTo()

Historique

Release	Modifications
17 R5	Ajout

.copyTo( destinationFolder : 4D.Folder { ; newName : Text } { ; overwrite : Integer } ) : 4D.File

Paramètres	Type		Description
dossierDestination	4D.Folder	->	Dossier de destination
nouveauNom	Text	->	Nom de la copie
overwrite	Integer	->	fk overwrite pour écraser les éléments existants
Résultat	4D.File	<-	Fichier copié

Description

La fonction .copyTo() copie l'objet File vers le destinationFolder spécifié .

Le destinationFolder doit exister sur disque, sinon une erreur est générée.

Par défaut, le fichier est copié avec le nom du fichier original. Si vous souhaitez renommer la copie, passez le nouveau nom dans le paramètre newName. Le nouveau nom doit être conforme aux règles de nommage (ex : il ne doit pas contenir de caractères tels que ":", "/", etc.), sinon une erreur est retournée.

S'il existe déjà un fichier portant le même nom dans destinationFolder, par défaut 4D génère une erreur. Vous pouvez passer la constante fk overwrite dans le paramètre overwrite pour ignorer et écraser le dossier existant :

Constante	Valeur	Commentaire
fk overwrite	4	Écrase les éléments existants, le cas échéant

Valeur retournée

L'objet File copié.

Exemple

Vous souhaitez copier un file image, à partir du dossier Documents de l'utilisateur vers le dossier de la base :

var $source; $copy : Object
$source:=Folder(fk documents folder).file("Pictures/photo.png")
$copy:=$source.copyTo(Folder("/PACKAGE");fk overwrite)

.getContent()

Historique

Release	Modifications
19 R2	Retourne 4D.Blob
17 R5	Ajout

.getContent( ) : 4D.Blob

Paramètres	Type		Description
Résultat	4D.Blob	<-	Contenu du fichier

Description

La fonction .getContent() retourne un objet 4D.Blob contenant le contenu intégral du fichier. Pour plus d'informations sur les BLOBs, veuillez vous reporter à la section BLOB.

Valeur retournée

Un objet 4D.Blob.

Exemple

Pour sauvegarder le contenu d'un document dans un champ BLOB :

 var $vPath : Text
 $vPath:=Select document("";"*";"Select a document";0)
 If(OK=1) //Si un document a été sélectionné
    [aTable]aBlobField:=File($vPath;fk platform path).getContent()
 End if

.getIcon()

Historique

Release	Modifications
17 R5	Ajout

.getIcon( { size : Integer } ) : Picture

Paramètres	Type		Description
size	Integer	->	Longueur du côté de l'image retournée (pixels)
Résultat	Picture	<-	Icône

Description

La fonction .getIcon() retourne l'icône du fichier.

Le paramètre optionnel size spécifie les dimensions en pixels de l'icône retournée. Cette valeur représente la longueur latérale du côté du carré contenant l'icône. La taille des icônes est généralement de 32x32 pixels (“grandes icônes”) ou de 16x16 pixels (“petites icônes”). Si vous passez 0 ou si vous omettez ce paramètre, la version "grandes icônes" est retournée.

Si le fichier n'existe pas sur disque, une icône par défaut vide est retournée.

Valeur retournée

Image de l'icône du fichier.

.getText()

Historique

Release	Modifications
17 R5	Ajout

.getText( { charSetName : Text { ; breakMode : Integer } } ) : Text
.getText( { charSetNum : Integer { ; breakMode : Integer } } ) : Text

Paramètres	Type		Description
charSetName	Text	->	Nom du jeu de caractères
charSetNum	Integer	->	Numéro du jeu de caractères
breakMode	Integer	->	Mode de traitement des retours à la ligne
Résultat	Text	<-	Texte du document

Description

La fonction .getText() retourne le contenu du fichier sous forme de texte .

Optionnellement, vous pouvez indiquer le jeu de caractères à utiliser pour la lecture du contenu. Vous pouvez passer soit :

• dans charSetName, une chaîne contenant le nom de jeu standard (par exemple "ISO-8859-1" ou "UTF-8"),
• ou dans charSetNum, l'ID MIBEnum (numéro) du nom du jeu standard.

Pour consulter la liste des jeux de caractères pris en charge par 4D, veuillez vous reporter à la description de la commande CONVERT FROM TEXT.

Si le document contient un BOM (Byte Order Mark), 4D utilise le jeu de caractères inséré au lieu de celui qui est indiqué dans charSetName or charSetNum (ce paramètre est alors ignoré). Si le document ne contient pas de BOM et si le paramètre charSetName ou charSetNum est omis, 4D utilise par défaut le jeu de caractères "UTF-8".

Dans le paramètre breakMode, vous pouvez passer une valeur numérique indiquant le traitement à appliquer aux caractères de fin de ligne du document. Les constantes suivantes du thème "Documents système" sont disponibles :

Constante	Valeur	Commentaire
Document unchanged	0	Aucun traitement
Document with native format	1	(Défaut) Les fins de ligne sont convertis au format natif de la plate-forme d’exécution : CR (carriage return) sous OS X, CRLF (carriage return + line feed) sous Windows
Document with CRLF	2	Les fins de ligne sont convertis au format Windows : CRLF (carriage return + line feed)
Document with CR	3	Les fins de ligne sont convertis au format OS X : CR (carriage return)
Document with LF	4	Les fins de ligne sont convertis au format Unix : LF (line feed)

Par défaut, lorsque vous omettez le paramètre breakMode les retours à la ligne sont traités en mode natif (1).

Valeur retournée

Texte du fichier.

Exemple

Considérons le document texte suivant (les champs sont séparés par des tabulations ) :

id name price vat
3 thé 1.06€ 19.6
2 café 1.05€ 19.6

Lorsque vous exécutez ce code :

 $myFile:=Folder(fk documents folder).file("Billing.txt") //UTF-8 par défaut
 $txt:=$myFile.getText()

... vous obtenez ce qui suit pour $txt :

"id\tname\tprice\tvat\r\n3\tthé\t1.06€\t19.6\r\n2\tcafé\t1.05€\t19.6"

avec \t (tab) comme séparateur et \r\n (CRLF) comme délimiteur de ligne.

Voici un autre exemple avec le même fichier, mais un délimiteur de ligne différent :

 $txt:=$myFile.getText("UTF-8"; Document with LF)

Dans ce cas, le contenu de $txt est :

"id\tname\tprice\tvat\n3\tthé\t1.06€\t19.6\n2\tcafé\t1.05€\t19.6"

Cette fois-ci \n (LF) est utilisé comme délimiteur de ligne.