DocumentItem Interface

Definition

Represents any document other than an Outlook item as an item in an Outlook folder.

public interface class DocumentItem : Microsoft::Office::Interop::Outlook::_DocumentItem, Microsoft::Office::Interop::Outlook::ItemEvents_10_Event
[System.Runtime.InteropServices.Guid("00063020-0000-0000-C000-000000000046")]
public interface DocumentItem : Microsoft.Office.Interop.Outlook._DocumentItem, Microsoft.Office.Interop.Outlook.ItemEvents_10_Event
Public Interface DocumentItem
Implements _DocumentItem, 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 _DocumentItem. For information about the event members of the COM object, see ItemEvents_10_Event.

A DocumentItem object is any document other than an Outlook item as an item in an Outlook folder. In common usage, this will be an Office document but may be any type of document or executable file.

Unlike other Microsoft Outlook objects, you cannot create this object.

Note: When you try to programmatically add a user-defined property to a DocumentItem object, you receive the following error message: "Property is read-only." This is because the Outlook object model does not support this functionality.

Properties

Actions

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

(Inherited from _DocumentItem)
Application

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

(Inherited from _DocumentItem)
Attachments

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

(Inherited from _DocumentItem)
AutoResolvedWinner

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

(Inherited from _DocumentItem)
BillingInformation

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

(Inherited from _DocumentItem)
Body

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

(Inherited from _DocumentItem)
Categories

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

(Inherited from _DocumentItem)
Class

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

(Inherited from _DocumentItem)
Companies

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

(Inherited from _DocumentItem)
Conflicts

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

(Inherited from _DocumentItem)
ConversationIndex

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

(Inherited from _DocumentItem)
ConversationTopic

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

(Inherited from _DocumentItem)
CreationTime

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

(Inherited from _DocumentItem)
DownloadState

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

(Inherited from _DocumentItem)
EntryID

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

(Inherited from _DocumentItem)
FormDescription

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

(Inherited from _DocumentItem)
GetInspector

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

(Inherited from _DocumentItem)
Importance

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

(Inherited from _DocumentItem)
IsConflict

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

(Inherited from _DocumentItem)
ItemProperties

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

(Inherited from _DocumentItem)
LastModificationTime

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

(Inherited from _DocumentItem)
Links

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

(Inherited from _DocumentItem)
MAPIOBJECT

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

(Inherited from _DocumentItem)
MarkForDownload

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

(Inherited from _DocumentItem)
MessageClass

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

(Inherited from _DocumentItem)
Mileage

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

(Inherited from _DocumentItem)
NoAging

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

(Inherited from _DocumentItem)
OutlookInternalVersion

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

(Inherited from _DocumentItem)
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 _DocumentItem)
Parent

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

(Inherited from _DocumentItem)
PropertyAccessor

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

(Inherited from _DocumentItem)
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 _DocumentItem)
Sensitivity

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

(Inherited from _DocumentItem)
Session

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

(Inherited from _DocumentItem)
Size

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

(Inherited from _DocumentItem)
Subject

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

(Inherited from _DocumentItem)
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 _DocumentItem)
UserProperties

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

(Inherited from _DocumentItem)

Methods

Close(OlInspectorClose)

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

(Inherited from _DocumentItem)
Copy()

Creates another instance of an object.

(Inherited from _DocumentItem)
Delete()

Removes the item from the folder that contains the item.

(Inherited from _DocumentItem)
Display(Object)

Displays a new Inspector object for the item.

(Inherited from _DocumentItem)
Move(MAPIFolder)

Moves a Microsoft Outlook item to a new folder.

(Inherited from _DocumentItem)
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 _DocumentItem)
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 _DocumentItem)
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 _DocumentItem)
ShowCategoriesDialog()

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

(Inherited from _DocumentItem)

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