Edit

Share via


DistListItem Interface

Definition

Represents a distribution list in a Contacts folder.

public interface class DistListItem : Microsoft::Office::Interop::Outlook::_DistListItem, Microsoft::Office::Interop::Outlook::ItemEvents_10_Event
[System.Runtime.InteropServices.Guid("00063081-0000-0000-C000-000000000046")]
public interface DistListItem : Microsoft.Office.Interop.Outlook._DistListItem, Microsoft.Office.Interop.Outlook.ItemEvents_10_Event
Public Interface DistListItem
Implements _DistListItem, ItemEvents_10_Event
Derived
Attributes
Implements

Remarks

This is a .NET interface derived from a COM coclass that is required by managed code for interoperability with the corresponding COM object. Use this derived interface to access all method, property, and event members of the COM object. However, if a method or event you want to use shares the same name under the same COM object, cast to the corresponding primary interface to call the method, and cast to the latest events interface to connect to the event. Refer to this topic for information about the COM object. For information about the method and property members of the COM object, see _DistListItem. For information about the event members of the COM object, see DistListItemClass.

A distribution list can contain multiple recipients and is used to send messages to everyone in the list.

Use the CreateItem(OlItemType) method to create a DistListItem object that represents a new distribution list.

Use Items(index), where index is the index number of an item in a contacts folder or a value used to match the default property of an item in the folder, to return a single DistListItem object from a contacts folder (that is, a folder whose default item type is olContactItem).

Properties

Actions

Returns an Actions collection that represents all the available actions for the item. Read-only.

(Inherited from _DistListItem)
Application

Returns an Application object that represents the parent Outlook application for the object. Read-only.

(Inherited from _DistListItem)
Attachments

Returns an Attachments object that represents all the attachments for the specified item. Read-only.

(Inherited from _DistListItem)
AutoResolvedWinner

Returns a Boolean (bool in C#) that determines if the item is a winner of an automatic conflict resolution. Read-only.

(Inherited from _DistListItem)
BillingInformation

Returns or sets a String (string in C#) representing the billing information associated with the Outlook item. Read/write.

(Inherited from _DistListItem)
Body

Returns or sets a String (string in C#) representing the clear-text body of the Outlook item. Read/write.

(Inherited from _DistListItem)
Categories

Returns or sets a String (string in C#) representing the categories assigned to the Outlook item. Read/write.

(Inherited from _DistListItem)
CheckSum

This object, member, or enumeration is deprecated and is not intended to be used in your code.

(Inherited from _DistListItem)
Class

Returns an OlObjectClass constant indicating the object's class. Read-only.

(Inherited from _DistListItem)
Companies

Returns or sets a String (string in C#) representing the names of the companies associated with the Outlook item. Read/write.

(Inherited from _DistListItem)
Conflicts

Return the Conflicts object that represents the items that are in conflict for any Outlook item object. Read-only.

(Inherited from _DistListItem)
ConversationID

Returns a string that uniquely identifies a Conversation object that the DistListItem object belongs to. Read-only.

(Inherited from _DistListItem)
ConversationIndex

Returns a String (string in C#) representing the index of the conversation thread of the Outlook item. Read-only.

(Inherited from _DistListItem)
ConversationTopic

Returns a String (string in C#) representing the topic of the conversation thread of the Outlook item. Read-only.

(Inherited from _DistListItem)
CreationTime

Returns a DateTime indicating the creation time for the Outlook item. Read-only.

(Inherited from _DistListItem)
DLName

Returns or sets a String (string in C#) representing the display name of a distribution list. Read/write.

(Inherited from _DistListItem)
DownloadState

Returns a constant that belongs to the OlDownloadState enumeration indicating the download state of the item. Read-only.

(Inherited from _DistListItem)
EntryID

Returns a String (string in C#) representing the unique Entry ID of the object. Read-only.

(Inherited from _DistListItem)
FormDescription

Returns the FormDescription object that represents the form description for the specified Outlook item. Read-only.

(Inherited from _DistListItem)
GetInspector

Returns an Inspector object that represents an inspector initialized to contain the specified item. Read-only.

(Inherited from _DistListItem)
Importance

Returns or sets an OlImportance constant indicating the relative importance level for the Outlook item. Read/write.

(Inherited from _DistListItem)
IsConflict

Returns a Boolean (bool in C#) that determines if the item is in conflict. Read-only.

(Inherited from _DistListItem)
IsMarkedAsTask

Returns a Boolean (bool in C#) value that indicates whether the DistListItem is marked as a task. Read-only.

(Inherited from _DistListItem)
ItemProperties

Returns an ItemProperties collection that represents all standard and user-defined properties associated with the Outlook item. Read-only.

(Inherited from _DistListItem)
LastModificationTime

Returns a DateTime specifying the date and time that the Outlook item was last modified. Read-only.

(Inherited from _DistListItem)
Links

This object, member, or enumeration is deprecated and is not intended to be used in your code.

(Inherited from _DistListItem)
MAPIOBJECT

This object, member, or enumeration is deprecated and is not intended to be used in your code.

(Inherited from _DistListItem)
MarkForDownload

Returns or sets an OlRemoteStatus constant that determines the status of an item once it is received by a remote user. Read/write.

(Inherited from _DistListItem)
MemberCount

Returns an Integer (int in C#) value indicating the number of members in a distribution list. Read-only.

(Inherited from _DistListItem)
Members

This object, member, or enumeration is deprecated and is not intended to be used in your code.

(Inherited from _DistListItem)
MessageClass

Returns or sets a String (string in C#) representing the message class for the Outlook item. Read/write.

(Inherited from _DistListItem)
Mileage

Returns or sets a String (string in C#) representing the mileage for an item. Read/write.

(Inherited from _DistListItem)
NoAging

Returns or sets a Boolean (bool in C#) value that is True to not age the Outlook item. Read/write.

(Inherited from _DistListItem)
OneOffMembers

This object, member, or enumeration is deprecated and is not intended to be used in your code.

(Inherited from _DistListItem)
OutlookInternalVersion

Returns an Integer (int in C#) value representing the build number of the Outlook application for an Outlook item. Read-only.

(Inherited from _DistListItem)
OutlookVersion

Returns a String (string in C#) indicating the major and minor version number of the Outlook application for an Outlook item. Read-only.

(Inherited from _DistListItem)
Parent

Returns the parent Object of the specified object. Read-only.

(Inherited from _DistListItem)
PropertyAccessor

Returns a PropertyAccessor object that supports creating, getting, setting, and deleting properties of the parent DistListItem object. Read-only.

(Inherited from _DistListItem)
ReminderOverrideDefault

Returns or sets a Boolean (bool in C#) value that is True if the reminder overrides the default reminder behavior for the item. Read/write.

(Inherited from _DistListItem)
ReminderPlaySound

Returns or sets a Boolean (bool in C#) value that is True if the reminder should play a sound when it occurs for this item. Read/write.

(Inherited from _DistListItem)
ReminderSet

Returns or sets a Boolean (bool in C#) value that is True if a reminder has been set for this item. Read/write.

(Inherited from _DistListItem)
ReminderSoundFile

Returns or sets a String (string in C#) indicating the path and file name of the sound file to play when the reminder occurs for the Outlook item. Read/write.

(Inherited from _DistListItem)
ReminderTime

Returns or sets a DateTime indicating the date and time at which the reminder should occur for the specified item. Read/write.

(Inherited from _DistListItem)
RTFBody

Returns or sets a byte array that represents the body of the Microsoft Outlook item in Rich Text Format. Read/write.

(Inherited from _DistListItem)
Saved

Returns a Boolean (bool in C#) value that is True if the Outlook item has not been modified since the last save. Read-only.

(Inherited from _DistListItem)
Sensitivity

Returns or sets a constant in the OlSensitivity enumeration indicating the sensitivity for the Outlook item. Read/write.

(Inherited from _DistListItem)
Session

Returns the NameSpace object for the current session. Read-only.

(Inherited from _DistListItem)
Size

Returns an Integer (int in C#) value indicating the size (in bytes) of the Outlook item. Read-only.

(Inherited from _DistListItem)
Subject

Returns or sets a String (string in C#) indicating the subject for the Outlook item. Read/write.

(Inherited from _DistListItem)
TaskCompletedDate

Returns or sets a DateTime value that represents the completion date of the task for this DistListItem. Read/write.

(Inherited from _DistListItem)
TaskDueDate

Returns or sets a DateTime value that represents the due date of the task for this DistListItem. Read/write.

(Inherited from _DistListItem)
TaskStartDate

Returns or sets a DateTime value that represents the start date of the task for this DistListItem object. Read/write.

(Inherited from _DistListItem)
TaskSubject

Returns or sets a String (string in C#) value that represents the subject of the task for the DistListItem object. Read/write.

(Inherited from _DistListItem)
ToDoTaskOrdinal

Returns or sets a DateTime value that represents the ordinal value of the task for the DistListItem. Read/write.

(Inherited from _DistListItem)
UnRead

Returns or sets a Boolean (bool in C#) value that is True if the Outlook item has not been opened (read). Read/write.

(Inherited from _DistListItem)
UserProperties

Returns the UserProperties collection that represents all the user properties for the Outlook item. Read-only.

(Inherited from _DistListItem)

Methods

AddMember(Recipient)

Adds a new member to the specified distribution list. The distribution list contains Recipient objects that represent valid e-mail addresses.

(Inherited from _DistListItem)
AddMembers(Recipients)

Adds new members to a distribution list.

(Inherited from _DistListItem)
ClearTaskFlag()

Clears the DistListItem object as a task.

(Inherited from _DistListItem)
Close(OlInspectorClose)

Closes and optionally saves changes to the Outlook item.

(Inherited from _DistListItem)
Copy()

Creates another instance of an object.

(Inherited from _DistListItem)
Delete()

Removes the item from the folder that contains the item.

(Inherited from _DistListItem)
Display(Object)

Displays a new Inspector object for the item.

(Inherited from _DistListItem)
GetConversation()

Obtains a Conversation object that represents the conversation to which this item belongs.

(Inherited from _DistListItem)
GetMember(Int32)

Returns a Recipient object representing a member in a distribution list.

(Inherited from _DistListItem)
MarkAsTask(OlMarkInterval)

Marks a DistListItem object as a task and assigns a task interval for the object.

(Inherited from _DistListItem)
Move(MAPIFolder)

Moves a Microsoft Outlook item to a new folder.

(Inherited from _DistListItem)
PrintOut()

Prints the Outlook item using all default settings. The PrintOut method is the only Outlook method that can be used for printing.

(Inherited from _DistListItem)
RemoveMember(Recipient)

Removes an individual member from a given distribution list.

(Inherited from _DistListItem)
RemoveMembers(Recipients)

Removes members from a distribution list.

(Inherited from _DistListItem)
Save()

Saves the Microsoft Outlook item to the current folder or, if this is a new item, to the Outlook default folder for the item type.

(Inherited from _DistListItem)
SaveAs(String, Object)

Saves the Microsoft Outlook item to the specified path and in the format of the specified file type. If the file type is not specified, the MSG format (.msg) is used.

(Inherited from _DistListItem)
ShowCategoriesDialog()

Displays the Show Categories dialog box, which allows you to select categories that correspond to the subject of the item.

(Inherited from _DistListItem)

Events

AfterWrite

Occurs after Microsoft Outlook has saved the item.

(Inherited from ItemEvents_10_Event)
AttachmentAdd

Occurs when an attachment has been added to an instance of the parent object.

(Inherited from ItemEvents_10_Event)
AttachmentRead

Occurs when an attachment in an instance of the parent object has been opened for reading.

(Inherited from ItemEvents_10_Event)
AttachmentRemove

Occurs when an attachment has been removed from an instance of the parent object.

(Inherited from ItemEvents_10_Event)
BeforeAttachmentAdd

Occurs before an attachment is added to an instance of the parent object.

(Inherited from ItemEvents_10_Event)
BeforeAttachmentPreview

Occurs before an attachment associated with an instance of the parent object is previewed.

(Inherited from ItemEvents_10_Event)
BeforeAttachmentRead

Occurs before an attachment associated with an instance of the parent object is read from the file system, an attachment stream, or an Attachment object.

(Inherited from ItemEvents_10_Event)
BeforeAttachmentSave

Occurs just before an attachment is saved.

(Inherited from ItemEvents_10_Event)
BeforeAttachmentWriteToTempFile

Occurs before an attachment associated with an instance of the parent object is written to a temporary file.

(Inherited from ItemEvents_10_Event)
BeforeAutoSave

Occurs before the item is automatically saved by Outlook.

(Inherited from ItemEvents_10_Event)
BeforeCheckNames

Occurs just before Microsoft Outlook starts resolving names in the recipient collection for an item (which is an instance of the parent object).

(Inherited from ItemEvents_10_Event)
BeforeDelete

Occurs before an item (which is an instance of the parent object) is deleted.

(Inherited from ItemEvents_10_Event)
BeforeRead

Occurs before Microsoft Outlook begins to read the properties for the item.

(Inherited from ItemEvents_10_Event)
Close

Occurs when the inspector associated with an item (which is an instance of the parent object) is being closed.

(Inherited from ItemEvents_10_Event)
CustomAction

Occurs when a custom action of an item (which is an instance of the parent object) executes.

(Inherited from ItemEvents_10_Event)
CustomPropertyChange

Occurs when a custom property of an item (which is an instance of the parent object) is changed.

(Inherited from ItemEvents_10_Event)
Forward

Occurs when the user selects the Forward action for an item (which is an instance of the parent object).

(Inherited from ItemEvents_10_Event)
Open

Occurs when an instance of the parent object is being opened in an Inspector.

(Inherited from ItemEvents_10_Event)
PropertyChange

Occurs when an explicit built-in property of an instance of the parent object is changed.

(Inherited from ItemEvents_10_Event)
Read

Occurs when an instance of the parent object is opened for editing by the user.

(Inherited from ItemEvents_10_Event)
ReadComplete

Occurs when Outlook has completed reading the properties of the item.

(Inherited from ItemEvents_10_Event)
Reply

Occurs when the user selects the Reply action for an item (which is an instance of the parent object).

(Inherited from ItemEvents_10_Event)
ReplyAll

Occurs when the user selects the ReplyAll action for an item (which is an instance of the parent object).

(Inherited from ItemEvents_10_Event)
Send

Occurs when the user selects the Send action for an item (which is an instance of the parent object).

(Inherited from ItemEvents_10_Event)
Unload

Occurs before an Outlook item is unloaded from memory, either programmatically or by user action.

(Inherited from ItemEvents_10_Event)
Write

Occurs when an instance of the parent object is saved, either explicitly or implicitly (for example, in response to a prompt when closing the item's inspector).

(Inherited from ItemEvents_10_Event)

Applies to