DocumentRights

Details a set of access rights associated with a document. The object is typically used to list additional rights that are added to a user’s base level access. The additional rights are associated with a specific set of document versions (such as the "current" version).

Properties

The following table lists properties along with their access and descriptions.

Property

Access

Description

AllowDelete

R/W

Boolean. TRUE if the user can delete the document version.

AllowEdit

R/W

Boolean. TRUE if the user can modify the document version.

AllowShare

R/W

Boolean. TRUE if the user can share the document version with other users. Document versions can be shared by adding them to shared folders, and by forwarding them as attachments to messages.

AllowView

R/W

Boolean. TRUE if the user can view the document version.

Application

R/O

Application. The Application object.

BitMask

R/W

Long. A bit mask containing one bit for each Boolean property. See DocumentAccessRightsCollection for the bit definitions. This property is synchronized with the Boolean properties.

Parent

R/O

DocumentAccessRights. The DocumentAccessRights object that owns this object.

Remarks

The properties of the DocumentRights object are writable only by users who have been granted the ModifySecurity right (in the DocumentAccessRights object).

A DocumentRights object is refreshed when its parent object is refreshed.