MessageList

An independent list of messages that does not persist in the message database. This list is a snapshot of a list of messages from the message database.

Properties

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

Property

Access

Description

Application

R/O

Application. The Application object.

Count

R/O

Long. The number of objects in this collection

_NewEnum

R/O

Enumeration object. Implements IEnumVARIANT. For Windows only.

Parent

R/O

Application. A reference to the Application object. Because this is an independent list, it has no natural parent.

Methods

Add(VARIANT Message)

Adds an existing message or list of messages to this collection. Message may be a Message object, a MessageList collection, or a string. If Message is a Message object, the message is added. If Message is a MessageList collection, each Message in that collection is added. If Message is a string, the message whose message ID is equal to the Message is added.

MessageList Find(VARIANT Condition)

Returns the MessageList collection containing the messages matching the given Condition. Condition may be a string or a Filter object. If Condition is a string, it represents a filter expression. See Section 5.0, Filter Expressions. If Condition is a Filter object, it represents a saved Filter.

Message Item(VARIANT Index)

DEFAULT. Returns the Message specified by Index. Index may be a Long or a string. If Index is a Long, returns the Message object located at the given Index in the collection. Valid indexes are 1 through Count, inclusive. Throws an exception if the Index is outside of this range. If Index is a string, returns the Message object whose MessageID is equal to Index.

Remove(VARIANT Index)

Removes the message specified by Index from this collection. Index may be a Long, a string, or a Message object. If Index is a Long, removes the Message object located at the given Index in the collection. Valid indexes are 1 through Count, inclusive. Throws an exception if the Index is outside of this range. If Index is a string, removes the Message object whose MessageID is equal to Index. If Index is a Message object, removes the given Message object from the collection.

Remarks

A MessageList collection does not need to be refreshed because it is independent of the message database.