Sidebar
reference:scripting_reference:scripting_objects:pairedfolder
PairedFolder
The PairedFolder object is returned by the FSUtil.GetFolderPair method when you query for a folder's pair.
Make sure you check the valid property before querying any others - if valid is False it means the folder had no pair, so none of the other properties will exist.
| Property Name | Return Type | Description |
|---|---|---|
dual |
bool |
Returns True if the Default dual display folder option is on for the pair. |
dualnavlock |
bool |
Returns True if the Default Navigation Lock target option is on for the pair. |
ifnonexistent |
string |
Returns a string indicating the setting of the If non-existent option. Valid values are gotoparent, ignorepair and useanyway. |
navlock |
bool |
Returns True if the Turn on Navigation Lock automatically option is on for the pair. |
parent_level |
int |
If the initial paired folder didn't exist and so the returned path is a parent folder (as a result of the If non-existent option), this property tells you how many levels above the initial pair the returned folder is. |
path |
object:Path |
Returns a Path object which provides the paired folder. |
primaryonleft |
bool |
Returns True if the Always display primary folder at the left/top option is turned on. |
sync |
bool |
Returns True if Default Synchronize target is turned on for the pair. |
subfolders |
bool |
Returns True if the Apply Settings to all sub-folders option is on. |
valid |
bool |
Returns True if the paired folder is valid. |