OccurrenceCalculator.CalcOccurrences(TimeInterval, Appointment) Method

Creates a sequence of appointments for the specified pattern within the specified time interval.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v14.2.Core.dll

Declaration

C#

public AppointmentBaseCollection CalcOccurrences(
    TimeInterval interval,
    Appointment pattern
)

VB.NET

Public Function CalcOccurrences(
    interval As TimeInterval,
    pattern As Appointment
) As AppointmentBaseCollection

Parameters

Name	Type	Description
interval	TimeInterval	A DevExpress.XtraScheduler.TimeInterval object which specifies the interval in which the occurrences are created.
pattern	Appointment	An Appointment object which specifies the pattern for occurrences.

Returns

Type	Description
AppointmentBaseCollection	A DevExpress.XtraScheduler.AppointmentBaseCollection object which specifies a collection of occurrences.

Remarks

Use the CalcOccurrences method to generate a sequence of appointments of the AppointmentType.Occurrence type for further investigation or comparison.

NOTE

The OccurrenceCalculator creates a collection of occurrences based on the recurrence pattern only. It is not aware of any exceptions (deleted and changed occurrences). When appointment pattern evolves in the scheduler, the recurrence chain created by the OccurrenceCalculator is merged with data on deleted and changed occurrences.

Examples

The following code sample adds the pattern for recurring appointments to the scheduler's storage and replaces all occurrences with appointments of the AppointmentType.Normal type. It uses the OccurrenceCalculator.CalcOccurrences method to calculate the recurrent series.

C#

using DevExpress.XtraScheduler;
// ...

private void Button_Click(object sender, RoutedEventArgs e) {

    // Add new appointment pattern
    Appointment apt = schedulerControl1.Storage.CreateAppointment(AppointmentType.Pattern);
    apt.Subject = "MyTestAppointment";
    apt.RecurrenceInfo.Type = RecurrenceType.Daily;
    apt.RecurrenceInfo.Start = DateTime.Now;
    apt.RecurrenceInfo.End = apt.RecurrenceInfo.Start.AddDays(15);
    apt.RecurrenceInfo.Range = RecurrenceRange.EndByDate;
    schedulerControl1.Storage.AppointmentStorage.Add(apt);

    // Calculate occurrences
    Appointment pattern = schedulerControl1.Storage.AppointmentStorage.Items.Find(
        delegate(Appointment item) { return item.Subject == "MyTestAppointment"; });
    OccurrenceCalculator calc =
        OccurrenceCalculator.CreateInstance(pattern.RecurrenceInfo);
    TimeInterval ttc = new TimeInterval(pattern.RecurrenceInfo.Start,
        pattern.RecurrenceInfo.End + new TimeSpan(1, 0, 0));
    AppointmentBaseCollection apts = calc.CalcOccurrences(ttc, pattern);
    Appointment occurrence = null;

    // Create normal appointments
    schedulerControl1.Storage.BeginUpdate();
    for (int i = 0; i < apts.Count; i++) {
        occurrence = schedulerControl1.Storage.CreateAppointment(AppointmentType.Normal);
        occurrence.Subject = apts[i].Subject;
        occurrence.Description = apts[i].Description;
        occurrence.Start = apts[i].Start;
        occurrence.End = apts[i].End;
        schedulerControl1.Storage.AppointmentStorage.Add(occurrence);
    }
    schedulerControl1.Storage.EndUpdate();

    // Remove the pattern and occurrences
    schedulerControl1.Storage.AppointmentStorage.Remove(pattern);
}

VB.NET

Imports DevExpress.XtraScheduler
' ... 
Private Sub Button_Click(sender As Object, e As RoutedEventArgs) Handles Button.Click
    Dim apt As Appointment = SchedulerControl1.Storage.CreateAppointment(AppointmentType.Pattern)
    apt.Subject = "MyTestAppointment"
    apt.RecurrenceInfo.Type = RecurrenceType.Daily
    apt.RecurrenceInfo.Start = DateTime.Now
    apt.RecurrenceInfo.End = apt.RecurrenceInfo.Start.AddDays(15)
    apt.RecurrenceInfo.Range = RecurrenceRange.EndByDate
    SchedulerControl1.Storage.AppointmentStorage.Add(apt)

    ' Calculate occurrences
    Dim pattern As Appointment = _
        SchedulerControl1.Storage.AppointmentStorage.Items.Find(AddressOf FindMyAppointment)
    Dim calc As OccurrenceCalculator = _
        OccurrenceCalculator.CreateInstance(pattern.RecurrenceInfo)
    Dim ttc As TimeInterval = New TimeInterval(pattern.RecurrenceInfo.Start, _
        pattern.RecurrenceInfo.End + New TimeSpan(1, 0, 0))
    Dim apts As AppointmentBaseCollection = calc.CalcOccurrences(ttc, pattern)
    Dim occurrence As Appointment = Nothing

    ' Create normal appointments
    SchedulerControl1.Storage.BeginUpdate()
    Dim i As Integer = 0
    Do While i < apts.Count
        occurrence = New Appointment(AppointmentType.Normal)
        occurrence.Subject = apts(i).Subject
        occurrence.Description = apts(i).Description
        occurrence.Start = apts(i).Start
        occurrence.End = apts(i).End
        SchedulerControl1.Storage.AppointmentStorage.Add(occurrence)
        i += 1
    Loop
    SchedulerControl1.Storage.EndUpdate()

    ' Remove recurrent pattern and occurrences
    SchedulerControl1.Storage.AppointmentStorage.Remove(pattern)
End Sub

Function FindMyAppointment(ByVal item As Appointment) As Boolean
    If item.Subject = "MyTestAppointment" Then
        Return True
    Else
        Return False
    End If
End Function