FavoriteFolder object

A FavoriteFolder object represents a favorite folder.

You get a FavoriteFolder object from a FavoriteFolderFactory object.

Public methods

This object supports the following methods.

Method Description

LockObject

Locks the object. Returns True if the object has been changed on the server.

For details, see LockObject.
NewList

Gets a list of the node's immediate children.

Syntax: NewList()

Post

Posts all changed values into database.

For details, see  Post.

Refresh

Reads saved values, overwriting values in memory.

For details, see  Refresh.

Undo

Undoes changes to field values that have not been posted.

For details, see  Undo.

UnLockObject

Unlocks the object.

For details, see UnLockObject.

Public properties

This object supports the following properties.

Property R/W Type Description

AutoPost

 R/W Boolean

If true, the database is updated immediately when the field value changes.

AutoUnlock

 R/W Boolean

Indicates whether to make the item changeable to other users automatically after a Refresh or Post.

Field

 R/W Any

The value of the specified field.

Syntax: FavoriteFolder.Field[fieldName]

Parameters:

  • fieldName. A string that represents the name of the field in the project database. Use all upper case.

FieldMultiValue

 R/W Object

The MultiValue object of the specified field. See MultiValue object.

Syntax: FavoriteFolder.FieldMultiValue[fieldName]

Parameters:

  • fieldName. A string that represents the name of the field in the project database. Use all upper case.
FavoriteFolderFactory R Object The FavoriteFolderFactory object for folders that are direct children of this folder. See FavoriteFolderFactory object.

ID

 R Number

The favorite folder ID.

IsLocked

 R Boolean

Checks if the test is locked for editing.

Modified

 R Boolean

Checks if the item has been modified since last refresh or post operation. If true, the field properties on the server side are not up to date.

Name

 R/W String

The favorite folder name.
ParentId R/W Number The containing folder's ID.
Public R Boolean Checks whether this folder is public.

TypeName

 R String

The field's type.

Virtual

 R Boolean

Checks if this is a virtual item, that is, an item that does not have a corresponding database record.

Back to top