3.26 Document

A document management document.

3.26.1 Properties

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

Property

Access

Description

AdditionalRights

R/O

DocumentAccessRightsCollection. Contains rights granted to specific users or groups. This collection will be empty if: (1) the user does not have rights to modify access rights (see the ModifySecurity property under the DocumentAccessRights object); or (2) GroupWise Remote is running. This is a GroupWise limitation because the ModifySecurity rights information is not known or guaranteed to be current when Remote is running. The user can perform any action on the document, but when those actions are uploaded, the synchronization is subject to the user’s actual access rights.

Application

R/O

Application. The Application object.

Author

R/W

Address. The author of the document. During document creation, defaults to the same address as the Creator.

AuthorCreatorRights

R/O

DocumentAccessRights. Contains access rights to the document that are granted to the document’s author or creator. This property is empty when running GroupWise Remote.

CreationDate

R/O

Date. The date and time this document was created.

Creator

R/O

Address. The creator of this document.

CurrentVersion

R/O

DocumentVersion. The latest revision of the document. All revisions later than the "official" version are also collectively referred to as "current."

DefaultRights

R/O

DocumentAccessRights. Contains access rights to the document that are granted to Everyone as a default. This property is empty when running GroupWise Remote.

DocumentLibrary

R/O

DocumentLibrary. The document library which contains this document.

DocumentNumber

R/O

Long. The number of this document. This number is unique within the document library.

DocumentType

R/W

DocumentType. The document type for this document. Categorizes this document according to specific document retention characteristics.

DocumentVersions

R/O

DocumentVersions collection. The collection of versions for this document.

Fields

R/O

Fields collection. The collection of user-defined fields for this document.

OfficialVersion

R/W

DocumentVersion. The version of this document deemed to be the approved or "official" version.

Parent

R/O

Documents collection. The Documents collection that owns this object.

Subject

R/W

String. The descriptive name, or subject, of the document.

3.26.2 Methods

Delete()

Deletes the document and all corresponding versions from the document library.

DocumentVersion GetVersion(Long VersionNumber)

Returns the document with the DocumentNumber equal to the specified VersionNumber.

LocalDelete()

Deletes this document only from the currently connected post office database. No synchronization will take place between the master database and a remote database. This method i

Refresh()

Forces this Document object and its associated DocumentRights and Fields objects to read values from the message database. The actual reading of a specific property may be postponed until the next time the property is accessed. This "lazy evaluation" is an optimization that avoids unnecessary reading of unaccessed properties.

SetDefaults()

Sets default fields in the document. Each document library defines a set of default fields for documents in the library. These defaults name particular field values that are normally set on each document (by default) in the library. Calling this method will set the field values on the document to their default values based on how the system administrator has configured the library.

3.26.3 Remarks

When a Document object is refreshed, it recursively refreshes its contained objects and collections.