New Members and Constants (Outlook)

New Members

The following properties, methods, and events have been added to existing objects in Microsoft Outlook 2010.

Account

Properties

Description

AutoDiscoverConnectionMode

Returns an OlAutoDiscoverConnectionMode constant that specifies the type of connection to use for the auto-discovery service of the Microsoft Exchange server that hosts the account mailbox. Read-only.

AutoDiscoverXml

Returns a String that represents information in XML retrieved from the auto-discovery service of the Microsoft Exchange Server that is associated with the account. Read-only.

CurrentUser

Returns a Recipient object that represents the current user identity for the account. Read-only.

DeliveryStore

Returns a Store object that represents the default delivery store for the account. Read-only.

ExchangeConnectionMode

Returns an OlExchangeConnectionMode constant that indicates the current connection mode for the Microsoft Exchange Server that hosts the account mailbox. Read-only.

ExchangeMailboxServerName

Returns a String value that represents the name of the Microsoft Exchange Server that hosts the account mailbox. Read-only.

ExchangeMailboxServerVersion

Returns the full version number of the Microsoft Exchange Server that hosts the account mailbox. Read-only.

Methods

Description

GetAddressEntryFromID

Returns an AddressEntry object that represents the address entry specified by the given entry ID.

GetRecipientFromID

Returns the Recipient object that is identified by the given entry ID.

Accounts

Events

Description

AutoDiscoverComplete

Occurs after Microsoft Outlook has finished accessing the auto-discovery service of the Microsoft Exchange Server that is associated with the account, and has the related information available in the AutoDiscoverXml property of the Account object.

Application

Properties

Description

PickerDialog

Returns a PickerDialog object that provides the functionality to select people or data in a dialog box. Read-only.

Methods

Description

RefreshFormRegionDefinition

Refreshes the cache by obtaining the current definition from the Windows registry for one or all of the form regions that are defined for the local machine and the current user.

AppointmentItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the AppointmentItem object belongs to. Read-only.

RTFBody

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

Methods

Description

CopyTo

Copies the AppointmentItem to the folder that is specified by the DestinationFolder parameter and returns an object that represents the item created in the destination folder by the copy operation.

GetConversation

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

GetOrganizer

Obtains the AddressEntry object that contains information from the Address Book about the organizer of the AppointmentItem.

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

Attachment

Methods

Description

GetTemporaryFilePath

Returns the full path to the attached file that is in a temporary-files folder. Read- only.

AttachmentSelection

Properties

Description

Location

Returns a OlSelectionLocation constant that specifies where the attachment selection is in the Microsoft Outlook user interface. Read-only

Methods

Description

GetSelection

Returns a Selection object that contains the kind of objects specified by the SelectionContents parameter, and that are currently selected in the active explorer where the parent item of the AttachmentSelection object is.

CalendarView

Properties

Description

SelectedEndTime

Returns a Date that represents the end time of a selection in the CalendarView object. Read-only.

SelectedStartTime

Returns a Date that represents the start time of a selection in the CalendarView object. Read-only.

ContactItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the ContactItem object belongs to. Read-only.

RTFBody

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

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

DistListItem

Properties

Description

ConversationID

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

RTFBody

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

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

DocumentItem

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

ExchangeUser

Methods

Description

GetPicture

Obtains an IPictureDisp object that represents the picture of the Microsoft Exchange user that is displayed in Microsoft Outlook.

Explorer

Properties

Description

AccountSelector

Returns an AccountSelector object that represents the Microsoft Office Backstage view for the Explorer object. Read-only.

AttachmentSelection

Returns an AttachmentSelection object consisting of one or more attachments that are selected in the current view of the explorer. Read-only.

Methods

Description

AddToSelection

Adds the specified Microsoft Outlook item to the selection in the active explorer.

ClearSelection

Cancels any selection in the active explorer.

IsItemSelectableInView

Returns a value that indicates whether the specified Microsoft Outlook item can be selected in the current view of the active explorer.

RemoveFromSelection

Cancels the selection of the specified Microsoft Outlook item in the active explorer.

SelectAllItems

Selects all items that are contained in the current view of the active explorer.

Events

Description

AttachmentSelectionChange

Occurs when the user selects a different or additional attachment in the active explorer programmatically or by interacting with the user interface.

Folder

Methods

Description

GetCustomIcon

Returns an IPictureDisp object that represents the custom icon for the folder.

SetCustomIcon

Sets a custom icon that is specified by Picture for the folder.

FormRegion

Properties

Description

Visible

Returns or sets a value that indicates whether the form region is visible or hidden. Read/write.

Inspector

Properties

Description

AttachmentSelection

Returns an AttachmentSelection object consisting of one or more attachments that are selected in the inspector. Read-only.

Methods

Description

SetSchedulingStartTime

Sets the start time for a meeting item in the free/busy grid on the Scheduling Assistant tab of the inspector.

Events

Description

AttachmentSelectionChange

Occurs when the user selects a different or additional attachment of an item in the active inspector programmatically or by interacting with the user interface.

JournalItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the JournalItem object belongs to. Read-only.

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

MailItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the MailItem object belongs to. Read-only.

PermissionTemplateGuid

Returns or sets the GUID of the template file to apply to the MailItem in order to specify Information Rights Management (IRM) permissions. Read/write.

RTFBody

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

Sender

Returns or sets an AddressEntry object that corresponds to the user of the account from which the MailItem is sent. Read/write.

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

MeetingItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the MeetingItem object belongs to. Read-only.

IsLatestVersion

Returns a value that indicates whether the MeetingItem represents the latest version of the item on the organizer’s calendar. Read-only.

RTFBody

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

SendUsingAccount

Returns or sets an Account object that represents the account to use to send the MeetingItem. Read/write.

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

NameSpace

Methods

Description

CreateContactCard

Creates an instance of a ContactCard object for the contact that is specified by the AddressEntry parameter.

PostItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the PostItem object belongs to. Read-only.

RTFBody

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

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

Recipient

Properties

Description

Sendable

Returns or sets a value that indicates whether a meeting request can be sent to the Recipient. Read/write

RemoteItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the RemoteItem object belongs to. Read-only.

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

ReportItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the ReportItem object belongs to. Read-only.

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

Selection

Properties

Description

Location

Returns an OlSelectionLocation constant that specifies where in the Microsoft Outlook user interface the current selection is. Read-only

Methods

Description

GetSelection

Returns a Selection object that contains the kind of objects specified by the SelectionContents parameter, and that are currently selected in the active explorer.

SharingItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the SharingItem object belongs to. Read-only.

PermissionTemplateGuid

Returns or sets a String that represents the GUID of the template file to be applied to the SharingItem in order to specify Information Rights Management (IRM) permissions. Read/write.

RTFBody

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

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

Store

Properties

Description

Categories

Returns a Categories collection that represents all of the categories that are defined for the Store. Read-only.

IsConversationEnabled

Returns a Boolean value that is True if the store supports Conversation view. Read-only.

Methods

Description

GetDefaultFolder

Returns a Folder object that represents the default folder in the store and that is of the type specified by the FolderType argument.

RefreshQuotaDisplay

Refreshes the store quota information that is displayed in the status bar in the explorer window.

TableView

Properties

Description

AlwaysExpandConversation

Returns or sets a value that indicates whether conversations are always fully expanded in the table view. Read/write.

ShowConversationByDate

Returns or sets a value that indicates whether items in the table view are organized by the conversation date and conversation. Read/write.

ShowConversationSendersAboveSubject

Returns or sets a Boolean value that indicates whether the table view displays the participating senders above the subject line in the conversation header, or below it. Read/write.

ShowFullConversations

Returns or sets a value that indicates whether to display conversation items from other folders, such as the Sent Items folder, as part of the conversation in the table view. Read/write.

Methods

Description

GetTable

Returns a Table object that represents all of the Microsoft Outlook items that are contained in a TableView object.

TaskItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the TaskItem object belongs to. Read-only.

RTFBody

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

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

TaskRequestAcceptItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the TaskRequestAcceptItem object belongs to. Read-only.

RTFBody

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

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

TaskRequestDeclineItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the TaskRequestDeclineItem object belongs to. Read-only.

RTFBody

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

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

TaskRequestItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the TaskRequestItem object belongs to. Read-only.

RTFBody

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

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

TaskRequestUpdateItem

Properties

Description

ConversationID

Returns a String that uniquely identifies a Conversation object that the TaskRequestUpdateItem object belongs to. Read-only.

RTFBody

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

Methods

Description

GetConversation

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

Events

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

BeforeRead

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

ViewFont

Properties

Description

ExtendedColor

Returns or sets an OlCategoryColor constant as the font color of the view. Read/write

New Constants

The following constants have been added to existing enumerations in Outlook 2010.

Enumeration

New Constants

OlDefaultFolders

  • olFolderRssFeeds

  • olFolderSuggestedContacts

OlExchangeStoreType

  • olAdditionalExchangeMailbox

OlGroupType

  • olReadOnlyGroup

  • olRoomsGroup

OlItemType

  • olMobileItemMMS

  • olMobileItemSMS

OlMarkInterval

  • olMarkComplete

OlNavigationModuleType

  • olModuleSolutions

OlObjectClass

  • olConversation

  • olConversationHeader

  • olMeetingForwardNotification

  • olMobile

  • olOutspace

  • olSimpleItems

  • olSolutionsModule

OlSearchScope

  • olSearchScopeAllOutlookItems

  • olSearchScopeSubfolders

OlSharingProvider

  • olProviderFederate