3.32 DocumentReference

Refers to a specific version of a document management document. A subtype of Message.

3.32.1 Properties

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

Property

Access

Description

Archived

R/W

Boolean. TRUE if this message has been archived.

Categories

R/O

Categories Collection. The collection of Category objects on this Mail, Appointment, Document Reference, Note, Phone Message, Task, or AddressBookEntry.

ChecklistCompleted

R/W

Boolean. TRUE if the item is part of the Checklist folder Messages collection or a Task item AND the item has been marked Completed. FALSE otherwise.

ChecklistCompletedDate

R/W

Date. The date this item was marked completed.

ChecklistDueDate

R/W

Date. The date this item should be Completed. Returns an error if the Message item is not a Task or is not part of the Checklist folder Messages collection.

ChecklistPercentComplete

R/W

Integer. Between 0 and 100 percent, how complete the checklist item is. If this value is set to a number outside the 0 to 100 range, an error is returned. If the value is set to 100, the item will also be marked complete.

ChecklistShowOnCalendarDate

R/W

Date. The date this item should appear on the calendar task list.

CommonMessageID

R/O

String. The ID of the message, regardless of its location. For example, an email will have the same CommonMessageID for both Sent and Received.

DeliveredDate

R/O

Date. The date and time this message item was delivered to the account.

Document

R/O

Document. The original document from which the document version and this document reference have been generated.

DocumentLibrary

R/O

DocumentLibrary. The document library in which the document version resides.

DocumentSize

R/O

Long. Returns the size of the document that is pointed to by this reference.

DocumentVersion

R/O

DocumentVersion. The document version to which this document reference refers.

Forwarded

R/O

Boolean. TRUE if this item has been forwarded to another user. Otherwise, FALSE.

MessageProperty

R/O

String. Based on the MessagePropertiesConstant passed in, a different string is returned.

PersonalSubject

R/W

String. A text string to be shown by the GroupWise Windows client as the Subject text. This text appears only for the current user. The normal subject or their own Personal Subject text appears for other users.

RefType

R/O

Enum (DocumentReferenceTypeConstants). The type of this document reference.

Replied

R/O

Boolean. TRUE if this item has been replied to. Otherwise, FALSE.

Sharer

R/O

Address. The user who added this message to a shared folder. If this message was not added to a shared folder, this will be the same as the Sender property.

ShowOnChecklist

R/W

Boolean. TRUE if the item is part of the Checklist folder Messages collection. FALSE otherwise.

Size

R/O

Returns the size of the attachments and message body. If there are no attachments, only the size of the message body is returned.

3.32.2 Methods

See Message.

LocalDelete()

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

RemoveChecklistDueDate()

Removes the Checklist Due Date from the Message item. Returns an error if the item is not on the Checklist.

3.32.3 Remarks

DocumentReference objects are typically personal items (read/write objects). However, when a DocumentReference is attached (encapsulated) to another message, the encapsulation is ReadOnly.