The Favorites object holds a collection of all the defined
favorite folders. It is
retrieved from the DOpus.favorites property.
Property Name |
Return Type |
Description |
---|---|---|
<default value> |
collection:Favorite |
You can enumerate the Favorites object to retrieve individual Favorite objects. |
Method Name |
Arguments |
Return Type |
Description |
---|---|---|---|
Add |
<string:typeOrName> |
object:Favorite |
Adds a new favorite folder to the favorites list. Note that changes you make to the list are not saved until you call the Save method.
This method performs three separate functions; it can add a separator, a sub-folder or a favorite folder.
In all three cases the new item is added to the end by default, but you can optionally specify a position to insert the item somewhere else. E.g. specifying 0 for the insertion position would add it at the top of the list. You can provide either a number or another Favorite object.
The return value is either a Favorite or a Favorites object (depending on whether you added a sub-folder or a favorite folder). |
Delete |
<object:Favorite>
or |
none |
Deletes the specified favorite or sub-folder. Note that changes you make to the list are not saved until you call the Save method. |
Find |
<string:name> |
object:Favorites |
Lets you locate a sub-folder one or more levels below the current one.
The name parameter is the name or path and name of the
sub-folder to look for (e.g. "myfave", "pictures/local", etc). |
Save |
none |
none |
Saves any changes you've made to the favorites list. Once you call this method changes you have made will be reflected in Preferences and the favorites list in Listers. Note that you can only call this method on the main "root" Favorites object obtained from the DOpus.favorites property |
SetName |
<string:name> |
none |
Changes the name of this sub-folder. Note that changes you make to the list are not saved until you call the Save method. You can only call this method on Favorites objects that refer to sub-folders, and not the main "root" folder. |