RecurrencePattern Interface
Represents the pattern of incidence of recurring appointments and tasks for the associated AppointmentItem and TaskItem object.
Namespace: Microsoft.Office.Interop.Outlook
Assembly: Microsoft.Office.Interop.Outlook (in Microsoft.Office.Interop.Outlook.dll)
Syntax
'Declaration
<GuidAttribute("00063044-0000-0000-C000-000000000046")> _
<TypeLibTypeAttribute()> _
Public Interface RecurrencePattern
'Usage
Dim instance As RecurrencePattern
[GuidAttribute("00063044-0000-0000-C000-000000000046")]
[TypeLibTypeAttribute()]
public interface RecurrencePattern
Remarks
Use the GetRecurrencePattern method to return the RecurrencePattern object associated with an AppointmentItem or TaskItem object.
Calling GetRecurrencePattern or ClearRecurrencePattern has the side effect of setting the IsRecurring property of the item accordingly. This property can be used as required for efficient filtering of the Items object.
The type of recurrence pattern is indicated by the RecurrenceType property. The RecurrenceType property is the first property you should set.
The following properties are valid for all recurrence patterns: EndTime, Occurrences, StartDate, StartTime, or Type.
The following table shows the properties that are valid for the different recurrence types. An error occurs if the item is saved and the property is null or contains an invalid value. Monthly and yearly patterns are only valid for a single day. Weekly patterns are only valid as the Or of the DayOfWeekMask .
OlRecurrenceType value |
Valid RecurrencePattern properties |
|---|---|
olRecursDaily |
Duration, EndTime, Interval, NoEndDate, Occurrences, PatternStartDate, PatternEndDate, StartTime |
olRecursWeekly |
DayOfWeekMask, Duration, EndTime, Interval, NoEndDate, Occurrences, PatternStartDate, PatternEndDate, StartTime |
olRecursMonthly |
DayOfMonth, Duration, EndTime, Interval, NoEndDate, Occurrences, PatternStartDate, PatternEndDate, StartTime |
olRecursMonthNth |
DayOfWeekMask, Duration, EndTime, Interval, Instance, NoEndDate, Occurrences, PatternStartDate, PatternEndDate, StartTime |
olRecursYearly |
DayOfMonth, Duration, EndTime, Interval, MonthOfYear, NoEndDate, Occurrences, PatternStartDate, PatternEndDate, StartTime |
olRecursYearNth |
DayOfWeekMask, Duration, EndTime, Interval, Instance, NoEndDate, Occurrences, PatternStartDate, PatternEndDate, StartTime |
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.
See Also
Reference
Microsoft.Office.Interop.Outlook Namespace
Other Resources
How to: Create a Recurring Appointment by Using the Default Recurrence Pattern
How to: Create a Recurring Appointment That Has a Weekly Pattern
How to: Create an Annual Recurring Appointment That Uses a YearNth Pattern
How to: Find a Specific Appointment in a Recurring Appointment Series