Folder¶
Description¶
Represents a file-system folder or directory in a platform-independent manner.
Properties¶
| absoluteURI readonly | The full path name for the referenced folder in URI notation. |
| alias readonly | When true, the object refers to a file system alias or shortcut. |
| created readonly | The creation date of the referenced folder, or null if the object does not refer to a folder on disk. |
| displayName readonly | The localized name portion of the absolute URI for the referenced folder, without the path specification. |
| error readonly | A message describing the most recent file system error. |
| exists readonly | When true, this object refers to a folder that currently exists in the file system. |
| fsName readonly | The platform-specific name of the referenced folder as a full path name. |
| fullName readonly | The full path name for the referenced folder in URI notation. . |
| modified readonly | The date of the referenced folder’s last modification, or null if the object does not refer to a folder on disk. |
| name readonly | The folder name portion of the absolute URI for the referenced file, without the path specification. |
| parent 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 readonly | The path portion of the object absolute URI for the referenced file, without the folder name. |
| relativeURI readonly | The path name for the referenced folder in URI notation, relative to the current folder. |
Static Properties¶
| appData readonly | The folder containing the application data for all users. |
| appPackage readonly | In Mac OS, a Folder object for the folder containing the bundle of the running application. |
| commonFiles readonly | A Folder object for the folder containing common files for all programs installed by the user. |
| current readonly | A Folder object for the current folder. |
| desktop readonly | A Folder object for the folder that contains the user?s desktop. |
| fs readonly | The name of the current file system. |
| myDocuments readonly | A folder pointing to the user’s My Documents folder. |
| startup readonly | A Folder object for the folder containing the executable image of the running application. |
| system readonly | A Folder object for the folder containing the operating system files. |
| temp readonly | A Folder object for the default folder for temporary files. |
| trash readonly | A Folder object for the folder containing deleted items. On Windows, the trash folder is a virtual folder containing a database; therefore, the property value is null on Windows. |
| userData readonly | A Folder object for the folder containing the user’s application data. |
Constructors¶
| Folder readonly | Creates and returns a new Folder object referring to a given file-system location. |
Methods¶
| changePath readonly | Changes the path specification of the referenced folder. |
| create readonly | Creates a folder at the location given by this object’s?path?property. |
| execute readonly | Opens this folder in the platform-specific file browser (as if it had been double-clicked in the file browser). |
| getFiles readonly | Retrieves the contents of this folder, filtered by the supplied mask. |
| getRelativeURI readonly | Retrieves and returns the path for this file, relative to the specified base path, in URI notation. |
| remove readonly | Deletes the folder associated with this object from disk immediately, without moving it to the system trash. |
| rename readonly | Renames the associated folder. |
| resolve readonly | Attempts to resolve the file-system alias or shortcut that this object refers to. |
| selectDlg readonly | Opens the built-in platform-specific file-browsing dialog, and creates a new File or Folder object for the selected file or folder. |
| toSource readonly | Creates and returns a serialized string representation of this object. |
| toString readonly | Converts this object to a string. |
Static Methods¶
| decode readonly | Decodes a UTF-8 encoded string as required by RFC 2396, and returns the decoded string. |
| encode readonly | Encodes a string as required by RFC 2396, and returns the encoded string. |
| isEncodingAvailable readonly | Reports whether a given encoding is available. |
| selectDialog readonly | Opens the built-in platform-specific file-browsing dialog, and creates a new File or Folder object for the selected file or folder. |