The DocumentManager object provides a way to inspect the groups and files in the user’s Document Manager.
DocumentManager Type Commands
DocumentManager.instance v1.3
Returns the single shared DocumentManager object.
DocumentManager Commands
.isVisible v1.3
Returns @true if the Document Manager window is shown on screen, otherwise @false.
.allGroups v1.3
Return an array of DocumentManagerGroup objects, one for each group in the document manager.
.groupWithName name v1.3
Return the DocumentManagerGroup object with the given name, or the @undefined value if no such group exists.
.selectedGroups v1.3
Return an array of DocumentManagerGroup objects, one for each group selected in the Document Manager window.
.selectedFilePaths v1.3
Return an array of file paths, one for each file selected in the Document Manager window.
.addUserGroupWithName name v1.3
Adds a new empty group with the given name to the Document Manager, returning the new DocumentManagerGroup object. If the name is already in use this command does nothing and returns the @undefined value.
.addFolderGroupWithPath folderPath, [name] v1.3
Adds a new folder backed group to the Document Manager, returning the new DocumentManagerGroup object. If a group backed by the given folder already exists, then this command does nothing and returns the @undefined value.
Optionally a name for the new group may be specified. If omitted the name of the folder is used and updates dynamically as the name changes on disk.
.removeGroup group v1.3
Permanently removes the given DocumentManagerGroup and all associated files from the Document Manager. Any files contained/listed in the group are left on disk, eg: no files are actually deleted.
| Previous Chapter Manual Access |
<< index >> |
Next Chapter Document Manager Group Object |