Folders Class Methods
- Last UpdatedNov 06, 2025
- 4 minute read
For a list of all members of this type, see Folders members.
| Name | Description | |
|---|---|---|
  | CloneFolder | The CloneFolder() method opens the Create Folder dialog to allow the user to create a new folder. An item ID, operation ID, operation description, entity ID, and version ID can be passed in as suggestions for the user, but the user can change any or all of these. |
| CreateFolder | The CreateFolder() method opens the Create Folder dialog to allow the user to create a new folder. An item ID, operation ID, operation description, entity ID, and version ID can be passed in as suggestions for the user, but the user can change any or all of these. |
| CreateFolderFromProcessOrJob | The CreateFolderFromProcessOrJob() method opens the Create Folder dialog to allow a folder to be created from an existing process or job. The process ID is optional, but all other values must be supplied. |
| GetFiles | The GetFiles() method retrieves the folder files associated with the folder specified by the item ID, operation ID, entity ID, and version ID. This includes any files associated with the item for which the folder is built. |
| GetFolderFiles | The GetFolderFiles() method retrieves the folder files associated with the folder specified by the item ID. The results can also be filtered by operation ID, operation description, entity ID, and version ID. This includes any files associated with the item for which the folder is built. If a folder is not completely specified, only item files are returned. |
| GetFolderInfo | The GetFolderInfo() method returns the row in the Folders table for the folder specified by the item ID, operation ID, entity ID, and version ID. |
| GetFolderTreeData | The GetFolderTreeData() method retrieves data for the different levels of the folders tree based on the setting of the folderTreeLevel.
The data returned can be further filtered by supplying values for the other parameters. |
| GetPreferredFolders | The GetPreferredFolders() method returns a DataSet containing all the preferred folders filtered by item ID, operation ID, and operation description. The folders can be further filtered by an entity ID. |
| PopupFolderFilterDialog | The PopupFolderFilterDialog() method opens the Folder's Filter dialog. If the user applies a filter, the values for the filters are returned in the supplied variables. If the user does not apply the filter, the supplied variables are not changed. |
| RemoveFolders | The RemoveFolders() method removes all the folders below the specified item and optionally the specified operation or operation and entity. |