CS3 JS: Folder

CS3 JavaScript

Folder

Represents a file-system folder or directory in a platform-independent manner.

QuickLinks

Folder, changePath, create, decode, encode, execute, getFiles, getRelativeURI, isEncodingAvailable, remove, rename, resolve, selectDialog, selectDlg, toSource, toString

Properties

Property	Type	Access	Description
absoluteURI	string	readonly	The full path name for the referenced folder in URI notation.
alias	bool	readonly	When true, the object refers to a file system alias or shortcut.
appData	Folder	readonly	The folder containing the application data for all users. In Windows, the value of %APPDATA% (by default, C:\\Documents and Settings\\All Users\\Application Data) In Mac OS, /Library/Application Support
appPackage	Folder	readonly	In Mac OS, a Folder object for the folder containing the bundle of the running application.
commonFiles	Folder	readonly	A Folder object for the folder containing common files for all programs installed by the user. In Windows, the value of %CommonProgramFiles% (by default, C:\\Program Files\\Common Files) In Mac OS, /Library/Application Support
created	Date	readonly	The creation date of the referenced folder, or null if the object does not refer to a folder on disk.
current	Folder	r/w	A Folder object for the current folder. Assign a Folder object or a string containing the new path name to set the current folder. This is a class property accessed through the Folder constructor.
desktop	Folder	readonly	A Folder object for the folder that contains the user’s desktop. In Windows, C:\\Documents and Settings\\username\\Desktop In Mac OS, ~/Desktop
displayName	string	readonly	The localized name portion of the absolute URI for the referenced folder, without the path specification.
error	string	r/w	A message describing the most recent file system error. Typically set by the file system, but a script can set it. Setting this value clears any error message and resets the error bit for opened files. Contains the empty string if there is no error.
exists	bool	readonly	When true, this object refers to a folder that currently exists in the file system.
fs	string	readonly	The name of the current file system. One of "Windows", "Macintosh", or "Unix".
fsName	string	readonly	The platform-specific name of the referenced folder as a full path name.
fullName	string	readonly	The full path name for the referenced folder in URI notation. .
modified	Date	readonly	The date of the referenced folder's last modification, or null if the object does not refer to a folder on disk.
myDocuments	Folder	readonly	A folder pointing to the user's My Documents folder. In Windows, C:\\Documents and Settings\\username\\My Documents In Mac OS, ~/Documents
name	string	readonly	The folder name portion of the absolute URI for the referenced file, without the path specification.
parent	Folder	readonly	TThe Folder object for the folder that contains this folder, or null if this object refers to the root folder of a volume.
path	string	readonly	The path portion of the object absolute URI for the referenced file, without the folder name.
relativeURI	string	readonly	The path name for the referenced folder in URI notation, relative to the current folder.
startup	Folder	readonly	A Folder object for the folder containing the executable image of the running application.
system	Folder	readonly	A Folder object for the folder containing the operating system files. In Windows, the value of %windir% (by default, C:\\Windows) In Mac OS, /System
temp	Folder	readonly	A Folder object for the default folder for temporary files.
trash	Folder	readonly	A Folder object for the folder containing deleted items.
userData	Folder	readonly	A Folder object for the folder containing the user's application data. In Windows, the value of %USERDATA% (by default, C:\\Documents and Settings\\username\\Application Data) In Mac OS, ~/Library/Application Support.

Methods

Folder Folder (path:string)
Creates and returns a new Folder object referring to a given file-system location.

Parameter	Type	Description
path	string	The absolute or relative path to the folder associated with this object, specified in URI format.

bool changePath (path:string)
Changes the path specification of the referenced folder.

Parameter	Type	Description
path	string	A string containing the new path, absolute or relative to the current folder.

bool create ()
Creates a folder at the location given by this object's path property.

string decode (uri:string)
Decodes a UTF-8 encoded string as required by RFC 2396, and returns the decoded string.

Parameter	Type	Description
uri	string	The UTF-8 string to decode.

string encode (name:string)
Encodes a string as required by RFC 2396, and returns the encoded string.

Parameter	Type	Description
name	string	The string to encode.

bool execute ()
Opens this folder in the platform-specific file browser (as if it had been double-clicked in the file browser).

Array getFiles (mask:any)
Retrieves the contents of this folder, filtered by the supplied mask.

Parameter	Type	Description
mask	any	A search mask for file names, specified as a string or a function.

string getRelativeURI ( [basePath:string=.])
Retrieves and returns the path for this file, relative to the specified base path, in URI notation.

Parameter	Type	Description
basePath	string	A base path in URI notation. (default: .)

bool isEncodingAvailable (name:string)
Reports whether a given encoding is available.

Parameter	Type	Description
name	string	The encoding name.

bool remove ()
Deletes the folder associated with this object from disk immediately, without moving it to the system trash.

bool rename (newName:string)
Renames the associated folder.

Parameter	Type	Description
newName	string	The new folder name, with no path information.

Folder resolve ()
Attempts to resolve the file-system alias or shortcut that this object refers to.

Folder selectDialog (prompt:string)
Opens the built-in platform-specific file-browsing dialog, and creates a new File or Folder object for the selected file or folder.

Parameter	Type	Description
prompt	string	The prompt text, if the dialog allows a prompt.

Folder selectDlg (prompt:string)
Opens the built-in platform-specific file-browsing dialog, and creates a new File or Folder object for the selected file or folder.