RecurrenceInfo Class

Contains a recurring appointment’s reocurrence information.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v18.1.Core.dll

Declaration

C#

public class RecurrenceInfo :
    PersistentObject,
    IPersistentObject,
    IBatchUpdateable,
    IDisposable,
    IRecurrenceInfo,
    INotifyPropertyChanged,
    IInternalRecurrenceInfo,
    IInternalPersistentObject

VB.NET

Public Class RecurrenceInfo
    Inherits PersistentObject
    Implements IPersistentObject,
               IBatchUpdateable,
               IDisposable,
               IRecurrenceInfo,
               INotifyPropertyChanged,
               IInternalRecurrenceInfo,
               IInternalPersistentObject

Related API Members

The following members accept/return RecurrenceInfo objects:

Library	Related API Members
WPF Controls	AppointmentFormController.PatternRecurrenceInfo
	DailyRecurrenceControl.RecurrenceInfo
	MonthlyRecurrenceControl.RecurrenceInfo
	WeeklyRecurrenceControl.RecurrenceInfo
	YearlyRecurrenceControl.RecurrenceInfo
ASP.NET Web Forms Controls	AppointmentRecurrenceFormExtension.GetValue(String, Appointment)
	AppointmentRecurrenceFormExtension.GetValue(String, Appointment, TimeZoneHelper)

Remarks

The RecurrenceInfo class encapsulates information about the reoccurrences of a recurring appointment. All of the reoccurrence’s attributes are defined using the RecurrenceInfo class’ properties. These properties can be divided into the following three groups, according to their designation and if they appear within the Appointment Recurrence dialog.

Group Name	Property
Range of Recurrence	RecurrenceInfo.Range (the determinant property),RecurrenceInfo.Start,RecurrenceInfo.End,RecurrenceInfo.Duration,RecurrenceInfo.OccurrenceCount
Recurrence Pattern	RecurrenceInfo.Type (the determinant property),RecurrenceInfo.WeekOfMonth,RecurrenceInfo.WeekDays,RecurrenceInfo.Periodicity,RecurrenceInfo.Month,RecurrenceInfo.DayNumber
Auxiliary	RecurrenceInfo.AllDay,PersistentObject.Id

The data that the RecurrenceInfo class provides is sufficient to calculate a particular appointment’s reoccurrence.

An instance of the RecurrenceInfo class can be accessed via a recurring appointment’s Appointment.RecurrenceInfo property.

To specify recurrence information for an appointment, you shouldn’t create a RecurrenceInfo instance. It is created automatically for the appointment’s pattern. See the How to: Create Appointments with Various Recurrence Types Programmatically topic for more information.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the RecurrenceInfo class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-color-time-cells-partially-t590114/CS/SchedulerCellTemplate/TeamData.cs#L156

};
appt.RecurrenceInfo = new RecurrenceInfo() {
    AllDay = true,

how-to-customize-time-scales-in-the-timeline-view-t591091/CS/WpfSchedulerTimelineScalesTemplate/TeamData.cs#L169

};
appt.RecurrenceInfo = new RecurrenceInfo()
{

recurrence-dialog-as-a-standalone-form-e4353/CS/AppointmentRecurrenceFormExample/Controllers/HomeController.cs#L14

public ActionResult Index() {
    RecurrenceInfo recurrenceInfo = new RecurrenceInfo() {
        Start = DateTime.Today,

XAF_how-to-create-a-recurring-appointment-via-code-e1283/CS/Program.cs#L23

using (Session session = new Session(XpoDefault.DataLayer)) {
    RecurrenceInfo ri = new RecurrenceInfo(DateTime.Now, TimeSpan.FromMinutes(30));
    //Dennis: set more options of the RecurrenceInfo class here.

Reporting_report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application-t431255/CS/ScheduledTasksAPIClientDemo/SchedulerJobViewerForm.cs#L72

var infos = new List<Info>();
infos.Add(new Info { Name = "Description", Value = RecurrenceInfo.GetDescription(appointment, culture.DateTimeFormat.FirstDayOfWeek) });
infos.Add(new Info { Name = "Next start", Value = GetNextDateDisplayText(appointment) });

VB.NET

how-to-color-time-cells-partially-t590114/VB/SchedulerCellTemplate/TeamData.vb#L299

}
appt.RecurrenceInfo = New RecurrenceInfo() With { _
    .AllDay = True, _

how-to-customize-time-scales-in-the-timeline-view-t591091/VB/WpfSchedulerTimelineScalesTemplate/TeamData.vb#L299

}
appt.RecurrenceInfo = New RecurrenceInfo() With { _
    .AllDay = True, _

recurrence-dialog-as-a-standalone-form-e4353/VB/AppointmentRecurrenceFormExample/Controllers/HomeController.vb#L15

Public Function Index() As ActionResult
    Dim recurrenceInfo As New RecurrenceInfo() With {.Start = Date.Today, .End = Date.Today.Add(TimeSpan.FromDays(1)), .Type = RecurrenceType.Weekly, .AllDay = True}
    Return View("Index", recurrenceInfo)

XAF_how-to-create-a-recurring-appointment-via-code-e1283/VB/Program.vb#L23

Using session As New Session(XpoDefault.DataLayer)
    Dim ri As New RecurrenceInfo(Date.Now, TimeSpan.FromMinutes(30))
    'Dennis: set more options of the RecurrenceInfo class here.

Reporting_report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application-t431255/VB/ScheduledTasksAPIClientDemo/SchedulerJobViewerForm.vb#L74

    .Name = "Description", _
    .Value = RecurrenceInfo.GetDescription(appointment, culture.DateTimeFormat.FirstDayOfWeek) _
})

Implements

IIdProvider

IPersistentObject

IRecurrenceInfo

Inheritance

Object

DevExpress.XtraScheduler.Utils.NotifyPropertyChanged

PersistentObject

RecurrenceInfo