Edit

Share via


CalendarSharing Interface

Definition

Represents a set of utilities for sharing calendar information.

public interface class CalendarSharing : Microsoft::Office::Interop::Outlook::_CalendarSharing
[System.Runtime.InteropServices.Guid("000630E2-0000-0000-C000-000000000046")]
public interface CalendarSharing : Microsoft.Office.Interop.Outlook._CalendarSharing
Public Interface CalendarSharing
Implements _CalendarSharing
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 _CalendarSharing.

You can use the GetCalendarExporter() method of a Folder object that represents a calendar folder to create a CalendarSharing object. The GetCalendarExporter method can only be used on calendar folders. An error occurs if you use the method on Folder objects that represent other folder types.

You can use the SaveAsICal(String) method to save calendar information in an iCalendar (.ics) file for sharing a calendar as a URL, or use the ForwardAsICal(OlCalendarMailFormat) method to create a MailItem for sharing a calendar as a payload.

Note: The CalendarSharing object only supports exporting the iCalendar format.

Properties

Application

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

(Inherited from _CalendarSharing)
CalendarDetail

Returns or sets an OlCalendarDetail value indicating the level of detail for calendar items included in the iCalendar (.ics) file created by the ForwardAsICal(OlCalendarMailFormat) or SaveAsICal(String) methods of the CalendarSharing object. Read/write.

(Inherited from _CalendarSharing)
Class

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

(Inherited from _CalendarSharing)
EndDate

Returns or sets a DateTime value that indicates the inclusive end date of the range of calendar items to be shared by the CalendarSharing object. Read/write.

(Inherited from _CalendarSharing)
Folder

Returns the Folder containing the calendar items to be shared by the CalendarSharing object. Read-only.

(Inherited from _CalendarSharing)
IncludeAttachments

Returns or sets a Boolean (bool in C#) value that indicates whether attachments for calendar items should be included in the iCalendar (.ics) file created by the ForwardAsICal(OlCalendarMailFormat) or SaveAsICal(String) methods of the CalendarSharing object. Read/write.

(Inherited from _CalendarSharing)
IncludePrivateDetails

Returns or sets a Boolean (bool in C#) value that indicates whether private details for calendar items should be included in the iCalendar (.ics) file created by the ForwardAsICal(OlCalendarMailFormat) or SaveAsICal(String) methods of the CalendarSharing object. Read/write.

(Inherited from _CalendarSharing)
IncludeWholeCalendar

Returns or sets a Boolean (bool in C#) value that indicates whether all calendar items in the folder should be included in the iCalendar (.ics) file created by the ForwardAsICal(OlCalendarMailFormat) or SaveAsICal(String) methods of the CalendarSharing object. Read/write.

(Inherited from _CalendarSharing)
Parent

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

(Inherited from _CalendarSharing)
RestrictToWorkingHours

Returns or sets a Boolean (bool in C#) value that indicates whether calendar items that do not occur within working hours should be included in the iCalendar (.ics) file created by the ForwardAsICal(OlCalendarMailFormat) or SaveAsICal(String) methods of the CalendarSharing object. Read/write.

(Inherited from _CalendarSharing)
Session

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

(Inherited from _CalendarSharing)
StartDate

Returns or sets a DateTime value that indicates the inclusive start date of the range of calendar items to be shared by the CalendarSharing object. Read/write.

(Inherited from _CalendarSharing)

Methods

ForwardAsICal(OlCalendarMailFormat)

Forwards calendar information from the parent Folder of the CalendarSharing object as the payload of a MailItem.

(Inherited from _CalendarSharing)
SaveAsICal(String)

Exports calendar information from the parent Folder of the CalendarSharing object as an iCalendar calendar (.ics) file.

(Inherited from _CalendarSharing)

Applies to