DocumentAccessRights

Describes rights granted to individual users or groups.

Properties

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

Property

Access

Description

Application

R/O

Application. The Application object.

ModifySecurity

R/W

Boolean. TRUE if the user can modify the access rights of the owning document. This property cannot be set to TRUE if the RevokeAllRights property is TRUE.

Parent

R/O

DocumentAccessRightsCollection. The DocumentAccessRightsCollection that owns this object.

RevokeAllRights

R/W

Boolean. When set to TRUE, the user identified by the User property has all rights to the document revoked.

When set to TRUE, the SecurityCurrentVersions, SecurityOfficialVersion, SecurityOtherVersions, and ModifySecurity properties have no meaning. Attempting to write to any of these properties while RevokeAllRights is TRUE will generate an exception. Also, if RevokeAllRights is set to TRUE, ModifySecurity is forced FALSE.

SecurityCurrentVersions

R/O

DocumentRights. Access rights for this document’s current version. Current versions are defined as all document revisions newer than the official document version.

SecurityOfficialVersion

R/O

DocumentRights. Access rights for this document’s official version.

SecurityOtherVersions

R/O

DocumentRights. Access rights for this document’s unofficial, noncurrent versions (all document versions older than the official version.)

User

R/O

Address. Identifies the user or group for whom additional rights are being set. When the DocumentAccessRights object is obtained from a Document’s AuthorCreatorRights or DefaultRights properties, the User property returns nothing.

Methods

Delete()

Deletes the DocumentAccessRights object, removing the object from the parent DocumentAccessRightsCollection.

Remarks

A DocumentAccessRights object is refreshed when its parent is refreshed. When a DocumentAccessRights object is refreshed, it recursively refreshes its contained objects.