3.69 Note

Provides information and actions for a note. A subtype of Message.

3.69.1 Properties

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

Property

Access

Description

Accepted

R/O

Boolean. TRUE if this note has been accepted.

Archived

R/W

Boolean. TRUE if this message has been archived.

AutoDate

R/O

Boolean. TRUE if this note has an auto-date.

AutodateMessages

R/O

MessageList. The list of auto-dated items. This list includes the current note.

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.

Completed

R/W

Boolean. TRUE if this note has been completed.

DelayedDeliveryDate

R/W

Date. When the Message,Send() method is called, the message is not delivered until the specified Date. This property can be used only on a Draft Message.

Delegated

R/O

Boolean. TRUE if this note has been delegated.

DeliveredDate

R/O

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

DraftAutoDates

R/O

DraftAutoDates collection. The collection contains additional Dates which the Appointment, Note, or Task is created on.

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.

NotifyWhenAccepted

R/W

Enum (NotifyMessageConstants). Specifies the type of notification to send when this note has been accepted.

NotifyWhenCompleted

R/W

Enum (NotifyMessageConstants). Specifies the type of notification to send when this note has been completed.

NotifyWhenDeclined

R/W

Enum (NotifyMessageConstants). Specifies the type of notification to send when this note has been deleted.

OnCalendar

R/W

Boolean. TRUE if this note should appear on a Calendar display.

Personal

R/O

Boolean. TRUE if this note is a personal note.

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.

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.

StartDate

R/W

Date. The date a calendar note should start.

3.69.2 Methods

Accept([String Comment], [Boolean AllInstances])

Accepts this note. Comment is the text you would like to send in reply as you accept the note. AllInstances is used for auto-date notes. If AllInstances is set to TRUE, this method will accept all instances of the auto-dated note. Passing a value for AllInstances for a note that is not auto-dated is legal but ignored. If AllInstances is omitted, FALSE is assumed.

Decline([String Comment], [Boolean AllInstances])

Declines this note. Comment is the text you would like to send in reply as you decline the note. AllInstances is used for auto-date notes. If AllInstances is set to TRUE, this method will decline all instances of the auto-dated note. Passing a value for AllInstances for a note that is not auto-dated is legal but ignored. If AllInstances is omitted, FALSE is assumed.

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.

Note Delegate([Boolean AllInstances])

Delegates this note. AllInstances is used for auto-date notes. If AllInstances is set to TRUE, this method will delegate all instances of the auto-dated note. Passing a value for AllInstances for a note that is not auto-dated is legal but ignored. If AllInstances is omitted, FALSE is assumed. Returns the OutBox note.

RemoveChecklistDueDate()

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

3.69.3 Remarks

When a Note object is refreshed, it updates the Message objects returned by its AutodateMessages property, but it does not recursively refresh the Message objects themselves.