GetRecurrencePattern Method

Description

Retrieves an instance of a recurrence pattern from the data provider by the specified Pattern ID.

Syntax

Public Function GetRecurrencePattern( _
    ByVal [PatternID](#) As Long _
) As [CalendarRecurrencePattern](XtremeCalendarControl~CalendarRecurrencePattern.md)

Parameters

PatternID: Id of a CalendarRecurrencePattern.

Return Type

A CalendarRecurrencePattern object with the specified PatternID.

Remarks

The GetRecurrencePattern method can be used, for example, in the Calendar Control's event handlers: PatternChanged, PatternAdded, and PatternDeleted.

Each of the event handlers provides only the numeric PatternID. The GetRecurrencePattern method can then be used to retrieve the CalendarRecurrencePattern itself from the data provider.

Note: The PatternID is automatically generated when the pattern is added and cannot be changed.

When using a custom data provider, the DoReadRPattern event is fired when GetRecurrencePattern is called.