Aller au contenu principal
Version : 19

Classe Directory

.creationDate​

Historique
ReleaseModifications
17 R5Ajout

.creationDate : Date

Description​

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

Cette propriété est en lecture seule.

.creationTime​

Historique
ReleaseModifications
17 R5Ajout

.creationTime : Time

Description​

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

Cette propriété est en lecture seule.


.exists​

Historique
ReleaseModifications
17 R5Ajout

.exists : Boolean

Description​

La propriété .exists retourne vrai si le dossier existe sur le disque, et faux sinon.

Cette propriété est en lecture seule.


.extension​

Historique
ReleaseModifications
17 R5Ajout

.extension : Text

Description​

La propriété .extension retourne l'extension du nom du dossier (le cas échéant). Une extension commence toujours par ".". La propriété retourne une chaîne vide si le nom du dossier n'a pas d'extension.

Cette propriété est en lecture seule.


.fullName​

Historique
ReleaseModifications
17 R5Ajout

.fullName : Text

Description​

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

Cette propriété est en lecture seule.


.hidden​

Historique
ReleaseModifications
17 R5Ajout

.hidden : Boolean

Description​

La propriété .hidden retourne vrai si le dossier est défini comme "caché" au niveau du système, et faux sinon.

Cette propriété est en lecture seule.


.isAlias​

Historique
ReleaseModifications
17 R5Ajout

.isAlias : Boolean

Description​

La propriété .isAlias retourne toujours faux pour un objet Folder.

Cette propriété est en lecture seule.


.isFile​

Historique
ReleaseModifications
17 R5Ajout

.isFile : Boolean

Description​

La propriété .isFile retourne toujours faux pour un objet Folder.

Cette propriété est en lecture seule.


.isFolder​

Historique
ReleaseModifications
17 R5Ajout

.isFolder : Boolean

Description​

La propriété .isFolder retourne toujours vrai pour un objet Folder.

Cette propriété est en lecture seule.


.isPackage​

Historique
ReleaseModifications
17 R5Ajout

.isPackage : Boolean

Description​

La propriété .isPackage retourne vrai si le dossier est un paquet sur macOS (et existe sur le disque). Sinon, elle retourne false.

Sous Windows, .isPackage retourne toujours false.

Cette propriété est en lecture seule.


.modificationDate​

Historique
ReleaseModifications
17 R5Ajout

.modificationDate : Date

Description​

La propriété .modificationDate retourne la date de la dernière modification du dossier.

Cette propriété est en lecture seule.


.modificationTime​

Historique
ReleaseModifications
17 R5Ajout

.modificationTime : Time

Description​

La propriété .modificationTime retourne l'heure de la dernière modification du dossier (exprimé en nombre de secondes commençant à 00:00).

Cette propriété est en lecture seule.


.name​

Historique
ReleaseModifications
17 R5Ajout

.name : Text

Description​

La propriété .name retourne le nom du dossier, sans extension (le cas échéant).

Cette propriété est en lecture seule.


.original​

Historique
ReleaseModifications
17 R5Ajout

.original : 4D.Folder

Description​

La propriété .original retourne le même objet Folder que le dossier.

Cette propriété est en lecture seule.

Cette propriété est disponible sur les dossiers pour permettre au code générique de traiter les dossiers ou les fichiers.


.parent​

Historique
ReleaseModifications
17 R5Ajout

.parent : 4D.Folder

Description​

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

Si le dossier n'a pas de parent (racine), la valeur nulle est retournée.

Cette propriété est en lecture seule.


.path​

Historique
ReleaseModifications
17 R5Ajout

.path : Text

Description​

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

Cette propriété est en lecture seule.


.platformPath​

Historique
ReleaseModifications
17 R5Ajout

.platformPath : Text

Description​

La propriété .platformPath retourne le chemin du dossier exprimé avec la syntaxe de la plate-forme actuelle.

Cette propriété est en lecture seule.


.copyTo()​

Historique
ReleaseModifications
17 R5Ajout

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

ParameterTypeDescription
destinationFolder4D.Folder->Destination folder
newNameText->Name for the copy
overwriteInteger->fk overwrite to replace existing elements
Result4D.Folder<-Copied file or folder

Description​

La fonction .copyTo() copie l'objet Folder dans l'objet destinationFolder spécifié.

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

Par défaut, le dossier est copié avec le nom du dossier 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 dossier 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 :

ConstanteValeurCommentaire
fk overwrite4Écrase les éléments existants, le cas échéant

Valeur retournée

L'objet Folder copié.

Exemple​

Vous souhaitez copier un dossier Pictures, à partir du dossier Document de l'utilisateur vers le dossier de la base :

var $userImages; $copiedImages : 4D.Folder
$userImages:=Folder(fk documents folder).folder("Pictures")
$copiedImages:=$userImages.copyTo(Folder(fk database folder);fk overwrite)

.file()​

Historique
ReleaseModifications
17 R5Ajout

.file( path : Text ) : 4D.File

ParameterTypeDescription
pathText->Relative POSIX file pathname
Result4D.File<-File object (null if invalid path)

Description​

La fonction .file() crée un objet File à l'intérieur de l'objet Folder et renvoie sa référence.

Dans le paramètre path, passez un chemin relatif POSIX pour désigner le fichier à retourner. Le chemin sera évalué à partir du dossier parent en tant que racine.

Valeur retournée

Un objet File ou null si path n'est pas valide.

Exemple​

var $myPDF : 4D.File
$myPDF:=Folder(fk documents folder).file("Pictures/info.pdf")

.files()​

Historique
ReleaseModifications
17 R5Ajout

.files( { options : Integer } ) : Collection

ParameterTypeDescription
optionsInteger->File list options
ResultCollection<-Collection of children file objects

Description​

La fonction .files() retourne une collection des objets File contenus dans le dossier.

Les alias ou les liens symboliques ne sont pas résolus.

Par défaut, si vous omettez le paramètre options, seuls les fichiers à la racine du dossier sont retournés dans la collection, ainsi que les fichiers et dossiers invisibles. Vous pouvez modifier cela en passant, dans le paramètre options parameter, une ou plusieurs des constantes suivantes :

ConstanteValeurCommentaire
fk recursive1La collection contient les fichiers du dossier spécifié ainsi que de ses sous-dossiers
fk ignore invisible8Les fichiers invisibles ne sont pas répertoriés

Valeur retournée

Collection d'objets File.

Exemple 1​

Vous souhaitez savoir s'il y a des fichiers invisibles dans le dossier de la base :

var $all; $noInvisible : Collection
$all:=Folder(fk database folder).files()
$noInvisible:=Folder(fk database folder).files(fk ignore invisible)
If($all.length#$noInvisible.length)
ALERT("Database folder contains hidden files.")
End if

Exemple 2​

Vous souhaitez lire tous les fichiers qui ne sont pas invisibles dans le dossier Documents :

var $recursive : Collection
$recursive:=Folder(fk documents folder).files(fk recursive+fk ignore invisible)

.folder()​

Historique
ReleaseModifications
17 R5Ajout

.folder( path : Text ) : 4D.Folder

ParameterTypeDescription
pathText->Relative POSIX file pathname
Result4D.Folder<-Created folder object (null if invalid path)

Description​

La fonction .folder() crée un objet Folder à l'intérieur de l'objet parent Folder et retourne sa référence.

Dans le paramètre path, passez un chemin relatif POSIX pour désigner le dossier à retourner. Le chemin sera évalué à partir du dossier parent en tant que racine.

Valeur retournée

Un objet Folder object ou null si path est invalide.

Exemple​

var $mypicts : 4D.Folder
$mypicts:=Folder(fk documents folder).folder("Pictures")

.folders()​

Historique
ReleaseModifications
17 R5Ajout

.folders( { options : Integer } ) : Collection

ParameterTypeDescription
optionsInteger->Folder list options
ResultCollection<-Collection of children folder objects

Description​

La fonction .folders() retourne une collection d'objets Folder contenus dans le dossier parent.

Par défaut, si vous omettez le paramète options, seuls les dossiers à la racine du dossier sont retournés dans la collection. Vous pouvez modifier cela en passant, dans le paramètre options parameter, une ou plusieurs des constantes suivantes :

ConstanteValeurCommentaire
fk recursive1La collection contient les dossiers du dossier spécifié ainsi que de ses sous-dossiers
fk ignore invisible8Les dossiers invisibles ne sont pas répertoriés

Valeur retournée

Collection d'objets Folder.

Exemple​

Vous souhaitez obtenir la collection de tous les dossiers et sous-dossiers du dossier de la base :

var $allFolders : Collection
$allFolders:=Folder("/PACKAGE").folders(fk recursive)

.getIcon()​

Historique
ReleaseModifications
17 R5Ajout

.getIcon( { size : Integer } ) : Picture

ParameterTypeDescription
sizeInteger->Side length for the returned picture (pixels)
ResultPicture<-Icon

Description​

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

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 dossier n'existe pas sur disque, une icône vide est retournée par défaut.

Valeur retournée

Image de l'icône du dossier.