ConstructorFolder Folder ([path:
string])
Creates and returns a new Folder object referring to a given file-system location.
If the path name refers to an already existing disk file, a File object is returned instead. Returns the new Folder object.
| Parameter | Type | Description |
|---|
| path | string | The absolute or relative path to the folder associated with this object, specified in URI format.
The value stored in the object is the absolute path.The path need not refer to an existing folder. If the path refers to an existing file, rather than a folder:
•
The Folder() function returns a File object instead of a Folder object.
•
The new operator returns a Folder object for a nonexisting folder with the same name.
(Optional) |
Classstring decode (uri:
string)
Decodes a UTF-8 encoded string as required by RFC 2396, and returns the decoded string.
See also String.decodeURI().
| 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.
All special characters are encoded in UTF-8 and stored as escaped characters starting with the percent sign followed by two hexadecimal digits. For example, the string "my file" is encoded as "my%20file".
Special characters are those with a numeric value greater than 127, except the following: / - _ . ! ~ * ' ( )
See also encodeURI().
| Parameter | Type | Description |
|---|
| name | string | The string to encode. |
bool isEncodingAvailable (name:
string)
Reports whether a given encoding is available.
| Parameter | Type | Description |
|---|
| name | string | The encoding name.
Typical values are "ASCII", "binary", or "UTF-8". For a complete list of supported encodings, see the JavaScript Tools Guide.
|
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.
Differs from the object method selectDlg() in that it does not preselect a folder.
• If the user clicks OK, returns a File or Folder object for the selected file or folder.
• If the user cancels, returns null.
| Parameter | Type | Description |
|---|
| prompt | string | The prompt text, if the dialog allows a prompt. |
Instancesbool 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. |
| Example | folder.changePath (".."); |
bool create ()
Creates a folder at the location given by this object's path property.
Returns true if the folder was created.
bool execute ()
Opens this folder in the platform-specific file browser (as if it had been double-clicked in the file browser).
Returns true immediately if the folder was opened successfully.
Array getFiles (mask:
any)
Retrieves the contents of this folder, filtered by the supplied mask.
Returns an array of File and Folder objects, or null if this object's referenced folder does not exist.
| Parameter | Type | Description |
|---|
| mask |
any
| A search mask for file names, specified as a string or a function.
A mask string can contain question mark (?) and asterisk (*) wild cards. Default is "*", which matches all file names.
Can also be the name of a function that takes a File or Folder object as its argument. It is called for each file or folder found in the search; if it returns true, the object is added to the return array.
• NOTE: In Windows, all aliases end with the extension .lnk. ExtendScript strips this from the file name when found, in order to preserve compatibility with other operating systems. You can search for all aliases by supplying the search mask "*.lnk", but note that such code is not portable.
|
string getRelativeURI ([basePath:
string=.])
Retrieves and returns the path for this file, relative to the specified base path, in URI notation.
If no base path is supplied, the URI is relative to the path of the current folder. Returns a string containing the relative URI.
| Parameter | Type | Description |
|---|
| basePath | string | A base path in URI notation. (default: .) (Optional) |
| Example | aFile.getRelativeURI(basePath) |
bool remove ()
Deletes the folder associated with this object from disk immediately, without moving it to the system trash.
Folders must be empty before they can be deleted. Does not resolve aliases; instead, deletes the referenced alias or shortcut file itself. Returns true if the file was successfully removed.
• IMPORTANT: Cannot be undone. It is recommended that you prompt the user for permission before deleting.
bool rename (newName:
string)
Renames the associated folder.
Does not resolve aliases, but renames the referenced alias or shortcut file itself. Returns true if the folder was successfully renamed.
| Parameter | Type | Description |
|---|
| newName | string | The new folder name, with no path information. |
| Example | aFolder.rename(newName) |
Folder resolve ()
Attempts to resolve the file-system alias or shortcut that this object refers to.
If successful, creates and returns a new Folder object that points to the resolved file system element. Returns null if this object does not refer to an alias, or if the alias could not be resolved.
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.
Differs from the class method selectDialog() in that it preselects this folder.
• If the user clicks OK, returns a File or Folder object for the selected file or folder.
• If the user cancels, returns null.
| Parameter | Type | Description |
|---|
| prompt | string | The prompt text, if the dialog allows a prompt. |
string toSource ()
Creates and returns a serialized string representation of this object.
Pass the resulting string to eval() to recreate the object.
string toString ()
Converts this object to a string.
|