AppointmentItem Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a meeting, a one-time appointment, or a recurring appointment or meeting in the Calendar folder.
public interface class AppointmentItem : Microsoft::Office::Interop::Outlook::_AppointmentItem, Microsoft::Office::Interop::Outlook::ItemEvents_10_Event[System.Runtime.InteropServices.Guid("00063033-0000-0000-C000-000000000046")]
public interface AppointmentItem : Microsoft.Office.Interop.Outlook._AppointmentItem, Microsoft.Office.Interop.Outlook.ItemEvents_10_EventPublic Interface AppointmentItem
Implements _AppointmentItem, 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 _AppointmentItem. For information about the event members of the COM object, see ItemEvents_10_Event.
Use the CreateItem(OlItemType) method to create an AppointmentItem object that represents a new appointment.
Use Item[Object] (index), where index is the index number of an appointment or a value used to match the default property of an appointment, to return a single AppointmentItem object from a Calendar folder.
You can also return an AppointmentItem object from a MeetingItem object by using the GetAssociatedAppointment(Boolean) method.
When you work with recurring appointment items, you should release any prior references, obtain new references to the recurring appointment item before you access or modify the item, and release these references as soon as you are finished and have saved the changes. This practice applies to the recurring AppointmentItem object, and any Exception or RecurrencePattern object. To release a reference in Visual Basic, set that existing object to Nothing. In C#, explicitly release the memory for that object.
Note that even after you release your reference and attempt to obtain a new reference, if there is still an active reference, held by another add-in or Outlook, to one of the above objects, your new reference will still point to an out-of-date copy of the object. Therefore, it is important that you release your references as soon as you are finished with the recurring appointment.
Properties
| Actions |
Returns an Actions collection that represents all the available actions for the item. Read-only. (Inherited from _AppointmentItem) |
| AllDayEvent |
Returns True if the appointment is an all-day event (as opposed to a specified time). Read/write. (Inherited from _AppointmentItem) |
| Application |
Returns an Application object that represents the parent Outlook application for the object. Read-only. (Inherited from _AppointmentItem) |
| Attachments |
Returns an Attachments object that represents all the attachments for the specified item. Read-only. (Inherited from _AppointmentItem) |
| AutoResolvedWinner |
Returns a Boolean (bool in C#) that determines if the item is a winner of an automatic conflict resolution. Read-only. (Inherited from _AppointmentItem) |
| BillingInformation |
Returns or sets a String (string in C#) representing the billing information associated with the Outlook item. Read/write. (Inherited from _AppointmentItem) |
| Body |
Returns or sets a String (string in C#) representing the clear-text body of the Outlook item. Read/write. (Inherited from _AppointmentItem) |
| BusyStatus |
Returns or sets an OlBusyStatus constant indicating the busy status of the user for the appointment. Read/write. (Inherited from _AppointmentItem) |
| Categories |
Returns or sets a String (string in C#) representing the categories assigned to the Outlook item. Read/write. (Inherited from _AppointmentItem) |
| Class |
Returns an OlObjectClass constant indicating the object's class. Read-only. (Inherited from _AppointmentItem) |
| Companies |
Returns or sets a String (string in C#) representing the names of the companies associated with the Outlook item. Read/write. (Inherited from _AppointmentItem) |
| ConferenceServerAllowExternal |
This object, member, or enumeration is deprecated and is not intended to be used in your code. (Inherited from _AppointmentItem) |
| ConferenceServerPassword |
This object, member, or enumeration is deprecated and is not intended to be used in your code. (Inherited from _AppointmentItem) |
| Conflicts |
Return the Conflicts object that represents the items that are in conflict for any Outlook item object. Read-only. (Inherited from _AppointmentItem) |
| ConversationID |
Returns a String (string in C#) that uniquely identifies a Conversation object that the AppointmentItem object belongs to. Read-only. (Inherited from _AppointmentItem) |
| ConversationIndex |
Returns a String (string in C#) representing the index of the conversation thread of the Outlook item. Read-only. (Inherited from _AppointmentItem) |
| ConversationTopic |
Returns a String (string in C#) representing the topic of the conversation thread of the Outlook item. Read-only. (Inherited from _AppointmentItem) |
| CreationTime |
Returns a DateTime indicating the creation time for the Outlook item. Read-only. (Inherited from _AppointmentItem) |
| DownloadState |
Returns a constant that belongs to the OlDownloadState enumeration indicating the download state of the item. Read-only. (Inherited from _AppointmentItem) |
| Duration |
Returns or sets an Integer (int in C#) value indicating the duration (in minutes) of the AppointmentItem. Read/write. (Inherited from _AppointmentItem) |
| End |
Returns or sets a DateTime indicating the end date and time of an AppointmentItem. Read/write. (Inherited from _AppointmentItem) |
| EndInEndTimeZone |
Returns or sets a DateTime value that represents the end date and time of the appointment expressed in the EndTimeZone. Read/write. (Inherited from _AppointmentItem) |
| EndTimeZone |
Returns or sets a TimeZone value that corresponds to the end time of the appointment. Read/write. (Inherited from _AppointmentItem) |
| EndUTC |
Returns or sets a DateTime value that represents the end date and time of the appointment expressed in the Coordinated Universal Time (UTC) standard. Read/write. (Inherited from _AppointmentItem) |
| EntryID |
Returns a String (string in C#) representing the unique Entry ID of the object. Read-only. (Inherited from _AppointmentItem) |
| ForceUpdateToAllAttendees |
Returns or sets a Boolean (bool in C#) value that indicates whether updates to the AppointmentItem object should be sent to all attendees. Read/write. (Inherited from _AppointmentItem) |
| FormDescription |
Returns the FormDescription object that represents the form description for the specified Outlook item. Read-only. (Inherited from _AppointmentItem) |
| GetInspector |
Returns an Inspector object that represents an inspector initialized to contain the specified item. Read-only. (Inherited from _AppointmentItem) |
| GlobalAppointmentID |
Returns a String (string in C#) value that represents a unique global identifier for the AppointmentItem object. Read-only. (Inherited from _AppointmentItem) |
| Importance |
Returns or sets an OlImportance constant indicating the relative importance level for the Outlook item. Read/write. (Inherited from _AppointmentItem) |
| InternetCodepage |
Returns or sets an Integer (int in C#) value that determines the Internet code page used by the item. Read/write. (Inherited from _AppointmentItem) |
| IsConflict |
Returns a Boolean (bool in C#) that determines if the item on the local computer is different from the copy on the server. Read-only. (Inherited from _AppointmentItem) |
| IsOnlineMeeting |
This object, member, or enumeration is deprecated and is not intended to be used in your code. (Inherited from _AppointmentItem) |
| IsRecurring |
Returns a Boolean (bool in C#) value that is True if the appointment is a recurring appointment. Read-only. (Inherited from _AppointmentItem) |
| ItemProperties |
Returns an ItemProperties collection that represents all standard and user-defined properties associated with the Outlook item. Read-only. (Inherited from _AppointmentItem) |
| LastModificationTime |
Returns a DateTime specifying the date and time that the Outlook item was last modified. Read-only. (Inherited from _AppointmentItem) |
| Links |
This object, member, or enumeration is deprecated and is not intended to be used in your code. (Inherited from _AppointmentItem) |
| Location |
Returns or sets a String (string in C#) representing the specific office location (for example, Building 1 Room 1 or Suite 123) for the appointment. Read/write. (Inherited from _AppointmentItem) |
| MAPIOBJECT |
This object, member, or enumeration is deprecated and is not intended to be used in your code. (Inherited from _AppointmentItem) |
| 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 _AppointmentItem) |
| MeetingStatus |
Returns or sets an OlMeetingStatus constant specifying the meeting status of the appointment. Read/write. (Inherited from _AppointmentItem) |
| MeetingWorkspaceURL |
Returns a String (string in C#) value that represents the URL for the Meeting Workspace that the appointment item is linked to. Read-only. (Inherited from _AppointmentItem) |
| MessageClass |
Returns or sets a String (string in C#) representing the message class for the Outlook item. Read/write. (Inherited from _AppointmentItem) |
| Mileage |
Returns or sets a String (string in C#) representing the mileage for an item. Read/write. (Inherited from _AppointmentItem) |
| NetMeetingAutoStart |
This object, member, or enumeration is deprecated and is not intended to be used in your code. (Inherited from _AppointmentItem) |
| NetMeetingDocPathName |
This object, member, or enumeration is deprecated and is not intended to be used in your code. (Inherited from _AppointmentItem) |
| NetMeetingOrganizerAlias |
This object, member, or enumeration is deprecated and is not intended to be used in your code. (Inherited from _AppointmentItem) |
| NetMeetingServer |
This object, member, or enumeration is deprecated and is not intended to be used in your code. (Inherited from _AppointmentItem) |
| NetMeetingType |
This object, member, or enumeration is deprecated and is not intended to be used in your code. (Inherited from _AppointmentItem) |
| NetShowURL |
This object, member, or enumeration is deprecated and is not intended to be used in your code. (Inherited from _AppointmentItem) |
| NoAging |
Returns or sets a Boolean (bool in C#) value that is True to not age the Outlook item. Read/write. (Inherited from _AppointmentItem) |
| OptionalAttendees |
Returns or sets a String (string in C#) representing the display string of optional attendees names for the appointment. Read/write. (Inherited from _AppointmentItem) |
| Organizer |
Returns a String (string in C#) representing the name of the organizer of the appointment. Read-only. (Inherited from _AppointmentItem) |
| OutlookInternalVersion |
Returns an Integer (int in C#) value representing the build number of the Outlook application for an Outlook item. Read-only. (Inherited from _AppointmentItem) |
| 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 _AppointmentItem) |
| Parent |
Returns the parent Object of the specified object. Read-only. (Inherited from _AppointmentItem) |
| PropertyAccessor |
Returns a PropertyAccessor object that supports creating, getting, setting, and deleting properties of the parent AppointmentItem object. Read-only. (Inherited from _AppointmentItem) |
| Recipients |
Returns a Recipients collection that represents all the recipients for the Outlook item. Read-only. (Inherited from _AppointmentItem) |
| RecurrenceState |
Returns an OlRecurrenceState constant indicating the recurrence property of the specified object. Read-only. (Inherited from _AppointmentItem) |
| ReminderMinutesBeforeStart |
Returns or sets an Integer (int in C#) value indicating the number of minutes the reminder should occur prior to the start of the appointment. Read/write. (Inherited from _AppointmentItem) |
| 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 _AppointmentItem) |
| 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 _AppointmentItem) |
| 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 _AppointmentItem) |
| 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 _AppointmentItem) |
| ReplyTime |
Returns or sets a DateTime indicating the reply time for the appointment. Read/write. (Inherited from _AppointmentItem) |
| RequiredAttendees |
Returns a semicolon-delimited String (string in C#) of required attendee names for the meeting appointment. Read/write. (Inherited from _AppointmentItem) |
| Resources |
Returns a semicolon-delimited String (string in C#) of resource names for the meeting. Read/write. (Inherited from _AppointmentItem) |
| ResponseRequested |
Returns a Boolean (bool in C#) that indicates True if the sender would like a response to the meeting request for the appointment. Read/write. (Inherited from _AppointmentItem) |
| ResponseStatus |
Returns an OlResponseStatus constant indicating the overall status of the meeting for the current user for the appointment. Read-only. (Inherited from _AppointmentItem) |
| RTFBody |
Returns or sets a byte array that represents the body of the Microsoft Outlook item in Rich Text Format. Read/write. (Inherited from _AppointmentItem) |
| 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 _AppointmentItem) |
| SendUsingAccount |
Returns or sets an Account object that represents the account under which the AppointmentItem is to be sent. Read/write. (Inherited from _AppointmentItem) |
| Sensitivity |
Returns or sets a constant in the OlSensitivity enumeration indicating the sensitivity for the Outlook item. Read/write. (Inherited from _AppointmentItem) |
| Session |
Returns the NameSpace object for the current session. Read-only. (Inherited from _AppointmentItem) |
| Size |
Returns an Integer (int in C#) value indicating the size (in bytes) of the Outlook item. Read-only. (Inherited from _AppointmentItem) |
| Start |
Returns or sets a DateTime indicating the starting date and time for the Outlook item. Read/write. (Inherited from _AppointmentItem) |
| StartInStartTimeZone |
Returns or sets a DateTime value that represents the start date and time of the appointment expressed in the StartTimeZone. Read/write. (Inherited from _AppointmentItem) |
| StartTimeZone |
Returns or sets a TimeZone value that corresponds to the time zone for the start time of the appointment. Read/write. (Inherited from _AppointmentItem) |
| StartUTC |
Returns or sets a DateTime value that represents the start date and time of the appointment expressed in the Coordinated Universal Time (UTC) standard. Read/write. (Inherited from _AppointmentItem) |
| Subject |
Returns or sets a String (string in C#) indicating the subject for the Outlook item. Read/write. (Inherited from _AppointmentItem) |
| 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 _AppointmentItem) |
| UserProperties |
Returns the UserProperties collection that represents all the user properties for the Outlook item. Read-only. (Inherited from _AppointmentItem) |
Methods
| ClearRecurrencePattern() |
Removes the recurrence settings and restores the single-occurrence state for an appointment or task. (Inherited from _AppointmentItem) |
| Close(OlInspectorClose) |
Closes and optionally saves changes to the Outlook item. (Inherited from _AppointmentItem) |
| Copy() |
Creates another instance of an object. (Inherited from _AppointmentItem) |
| CopyTo(MAPIFolder, OlAppointmentCopyOptions) |
Copies the AppointmentItem to the folder that is specified by the |
| Delete() |
Removes the item from the folder that contains the item. (Inherited from _AppointmentItem) |
| Display(Object) |
Displays a new Inspector object for the item. (Inherited from _AppointmentItem) |
| ForwardAsVcal() |
Forwards the AppointmentItem as a vCal; virtual calendar item. (Inherited from _AppointmentItem) |
| GetConversation() |
Obtains a Conversation object that represents the conversation to which this item belongs. (Inherited from _AppointmentItem) |
| GetOrganizer() |
Obtains the AddressEntry object that contains information from the Address Book about the organizer of the AppointmentItem. (Inherited from _AppointmentItem) |
| GetRecurrencePattern() |
Returns a RecurrencePattern object that represents the recurrence attributes of an appointment. (Inherited from _AppointmentItem) |
| Move(MAPIFolder) |
Moves a Microsoft Outlook item to a new folder. (Inherited from _AppointmentItem) |
| 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 _AppointmentItem) |
| Respond(OlMeetingResponse, Object, Object) |
Responds to a meeting request. (Inherited from _AppointmentItem) |
| 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 _AppointmentItem) |
| 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 _AppointmentItem) |
| ShowCategoriesDialog() |
Displays the Show Categories dialog box, which allows you to select categories that correspond to the subject of the item. (Inherited from _AppointmentItem) |
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) |