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