Inherits: FolderList < ScriptObject
This object provides access to the directory lists in the Folders dialog.
Properties
| Name | Type | Get/Set | Brief |
|---|---|---|---|
| Category | ListCategory | Yes/No | The category of files that this folder list stores. |
| Count | int | Yes/No | The number of folders in this folder list. |
| Paths | Array[str] | Yes/No | The path of each folder in this list. |
Methods
| Name | Returns | Arguments |
|---|---|---|
| Add | none | path : strindex : Variant[ int, none] |
| Disable | none | folder : Variant[str, int] |
| Enable | none | folder : Variant[str, int] |
| EnableFile | none | fileName : strenable : Variant[ bool, none] |
| GetIndex | Variant[int, none] | path : str |
| GetPath | Variant[str, none] | index : int |
| IncludesSubfolders | bool | folders : Variant[str, int] |
| Remove | none | folder : Variant[str, int] |
Property Details
Category
Type: ListCategory
The category of files that this folder list stores.
Count
Type: int
The number of folders in this folder list.
Paths
Type: Array[str]
The path of each folder in this list.
Method Details
Add
Add a folder to this list.
Arguments:
path:str- The path of the folder.index: Variant[int,none] - The position to add it in the list, defaulting to the end.
Disable
Disable the specified folder.
Arguments:
folder: Variant[str,int] - The path of the folder, or the index of it in this list.
Enable
Enable the specified folder.
Arguments:
folder: Variant[str,int] - The path of the folder, or the index of it in this list.
EnableFile
Set whether a file should be enabled in all folder categories.
Arguments:
fileName:str- The name of the file.enable: Variant[bool,none] - Whether to enable or disable the file - defaults to enabling it.
GetIndex
Get the index of the folder with this path in the list, if it exists.
Returns Variant[int, none].
Arguments:
path:str
GetPath
Get the path of the folder at this index of the list, if it exists.
Returns Variant[str, none].
Arguments:
index:int
IncludesSubfolders
Get whether a folder has the “Include Subfolders” option enabled.
Returns bool.
Arguments:
folders: Variant[str,int]
Remove
Remove a folder to this list.
Arguments:
folder: Variant[str,int] - The path of the folder, or the index of it in this list.