Inherits: Folders < ScriptObject
This object gives you access to the application folder configuration.
It provides access to both general settings and format-specific folder lists. Most of these settings would be manually configured using the “Folders” dialog.
Multiple instances of this object are not necessary, as they have no unique information. Instead, they provide easy access to related functions and properties.
Properties
| Name | Type | Get/Set | Brief |
|---|---|---|---|
| GeneralFolderPath | str | Yes/Yes | The general folder path. |
| ShowFolderName | bool | Yes/Yes | Whether folder names are to be shown for every file in list on dialogs. |
| StartFolder | str | Yes/Yes | Get the Start folder if “Start In” is set to start in a specific named folder. |
| StartOption | StartOption | Yes/Yes | No description provided. |
Methods
| Name | Returns | Arguments |
|---|---|---|
| GetList | FolderList | category : ListCategory |
| SetOutputFilePattern | none | output : OutputCategory nameTemplate : str |
| SetOutputFolderName | none | output : OutputCategory folderName : str |
| SetOutputLocation | none | output : OutputCategory location : FolderLocation |
Enumerations
FolderLocation
| Name | Value | Description |
|---|---|---|
| Absolute | 0 | Specific (absolute) folder. |
| BelowDesign | 1 | Folder below the design or library folder. |
| WithDesign | 2 | Same folder as the design or library. |
| General | 3 | The “catch all” folder defined on the “General” page of the “Folders” dialog. |
ListCategory
| Name | Value | Description |
|---|---|---|
| Blocks | 0 | No description provided. |
| Colours | 1 | No description provided. |
| Formats | 2 | No description provided. |
| Libraries | 3 | No description provided. |
| Macros | 4 | No description provided. |
| Profiles | 5 | No description provided. |
| Scripts | 6 | No description provided. |
| Step | 7 | No description provided. |
| Technology | 8 | No description provided. |
OutputCategory
| Name | Value | Description |
|---|---|---|
| CamPlot | 0 | No description provided. |
| DesignReports | 1 | No description provided. |
| LibraryReports | 2 | No description provided. |
StartOption
| Name | Value | Description |
|---|---|---|
| SystemDefault | 0 | Use operating system setting. |
| NamedFolder | 1 | Start in a named folder which can be set using StartFolder. |
| LastUsed | 2 | Start in the last used folder. |
Property Details
GeneralFolderPath
Type: str
The general folder path.
ShowFolderName
Type: bool
Whether folder names are to be shown for every file in list on dialogs.
StartFolder
Type: str
Get the Start folder if “Start In” is set to start in a specific named folder.
StartOption
Type: StartOption
Method Details
GetList
Returns FolderList.
Arguments:
category: ListCategory
SetOutputFilePattern
The output file name pattern.
Arguments:
output: OutputCategorynameTemplate:str
SetOutputFolderName
The name of the folder.
Arguments:
output: OutputCategoryfolderName:str
SetOutputLocation
The folder location.
Arguments:
output: OutputCategorylocation: FolderLocation