FolderPref

< Previous | Contents | Manuals Home | Boris FX | Next >

This list object allows read-write access to the folder preferences listed on the Preferences panel. This object supercedes Scene.FolderPref/SetFolderPref

The FolderPref object is a list with indexed or associative access, ie FolderPref[2] or FolderPref["Batch Out"].

Use the Plain Text/Preferences Listing (prefslist.szl) and Save Preferences (savepref.szl) exporters as a code reference.

Not all folder preferences will have actual values, and the operating system may choose to ignore them.

Folder preference changes are not permanent until SynthEyes exits successfully, or the user opens and closes the preferences panel. To save them immediately, use Prefs.Save().

Important: there is no Undo for Preferences changes: they take effect immediately, and are outside the scope of the normal undo system.

.default Default value (path) for this preference.

String.

.index The index of this preference in FolderPref.

.name The user-visible name on the Preferences panel

.value The folder (path) name for this preference, a string.

< Previous | Contents | Manuals Home | Boris FX | Next >