Recurrence editor

11 Jul 202418 minutes to read

The Recurrence editor is integrated into Scheduler editor window by default, to process the recurrence rule generation for events. Apart from this, it can also be used as an individual component referring from the Scheduler repository to work with the recurrence related processes.

NOTE

All the valid recurrence rule string mentioned in the iCalendar specifications are applicable to use with the recurrence editor.

Customizing the repeat type option in editor

By default, there are 5 types of repeat options available in recurrence editor such as,

  • Never
  • Daily
  • Weekly
  • Monthly
  • Yearly

It is possible to customize the recurrence editor to display only the specific repeat options such as Daily and Weekly options alone by setting the appropriate frequencies option.

@using Syncfusion.EJ2.Schedule

<ejs-schedule id="schedule" height="550" selectedDate="new DateTime(2018, 2, 15)" views="@ViewBag.view" popupOpen="onPopupOpen">
    <e-schedule-eventsettings dataSource="@ViewBag.datasource"></e-schedule-eventsettings>
</ejs-schedule>

<script type="text/javascript">
    function onPopupOpen(args) {
        if (args.type === 'Editor') {
            var scheduleObj = document.getElementById('schedule').ej2_instances[0];
            scheduleObj.eventWindow.recurrenceEditor.frequencies = ['none', 'daily', 'weekly'];
        }
    }
</script>
public ActionResult Index()
{
    ViewBag.datasource = GetScheduleData();
    List<ScheduleView> viewOption = new List<ScheduleView>()
    {
        new ScheduleView { Option = Syncfusion.EJ2.Schedule.View.Day },
        new ScheduleView { Option = Syncfusion.EJ2.Schedule.View.Week },
        new ScheduleView { Option = Syncfusion.EJ2.Schedule.View.WorkWeek }
    };
    ViewBag.view = viewOption;
    return View();
}

public List<AppointmentData> GetScheduleData()
{
    List<AppointmentData> appData = new List<AppointmentData>();
    appData.Add(new AppointmentData
    { Id = 1, Subject = "Explosion of Betelgeuse Star", StartTime = new DateTime(2018, 2, 14, 9, 30, 0), EndTime = new DateTime(2018, 2, 14, 11, 0, 0) });
    return appData;
}
    
public class AppointmentData
{
    public int Id { get; set; }
    public string Subject { get; set; }
    public DateTime StartTime { get; set; }
    public DateTime EndTime { get; set; }
}

The other properties available in recurrence editor are tabulated below,

Properties Type Description
firstDayOfWeek number Sets the first day of the week on recurrence editor.
startDate Date Sets the start date from which date the recurrence event starts.
dateFormat string Sets the specific date format on recurrence editor.
locale string Sets the locale to be applied on recurrence editor.
cssClass string Allows styling to be applied on recurrence editor with custom class names.
enableRtl boolean Allows recurrence editor to render in RTL mode.
minDate Date Sets the minimum date on recurrence editor.
maxDate Date Sets the maximum date on recurrence editor.
value string Sets the recurrence rule value on recurrence editor.
selectedType number Sets the specific repeat type on the recurrence editor.

Customizing the End Type Option in Editor

By default, there are 3 types of end options available in the recurrence editor such as:

  • Never
  • Until
  • Count

It is possible to customize the recurrence editor to display only the specific end options, such as the Until and Count options alone, by setting the appropriate endTypes option.

@using Syncfusion.EJ2.Schedule
</div>
<ejs-recurrenceeditor id="recurrence" selectedType="1" endTypes='new[] { "until", "count" }'></ejs-recurrenceeditor>
</div>
public ActionResult Index()
{
    return View();
}

Accessing the recurrence rule string

The recurrence rule is usually generated based on the options selected from the recurrence editor and also it follows the iCalendar specifications. The generated recurrence rule string is a valid one to be used with the Scheduler event’s recurrence rule field.

There is a change event available in recurrence editor, that triggers on every time the fields of recurrence editor tends to change. Within this event argument, you can access the generated recurrence value through the value option as shown in the following code example.

@using Syncfusion.EJ2.Schedule

<div class="recurrence-editor-wrap">
    <div style="padding-bottom:15px;">
        <label>Rule Output</label>
        <div class="rule-output-container">
            <div id="rule-output">FREQ=DAILY;INTERVAL=1;</div>
        </div>
    </div>
    <ejs-recurrenceeditor id="RecurrenceEditor" selectedType="1" change="onChange"></ejs-recurrenceeditor>
</div>
    
<style>
    .recurrence-editor-wrap {
        margin: 0 25%;
    }

    .rule-output-container {
        height: auto;
        border: 1px solid #969696;
    }

    #rule-output {
        padding: 8px 4px;
        text-align: center;
        min-height: 20px;
        overflow: hidden;
        overflow-wrap: break-word;
    }

    @@media (max-width: 580px) {
        .recurrence-editor-wrap {
            margin: 0 5%;
        }
    }
</style>

<script type="text/javascript">
    function onChange(args) {
        var outputElement = document.querySelector('#rule-output');
        if(args.value == "") {
            outputElement.innerText = 'Select Rule';
        } else {
            outputElement.innerText = args.value;
        }
    }
</script>
public ActionResult Index()
{
    return View();
}

Set specific value on recurrence editor

It is possible to display the recurrence editor with specific options loaded initially, based on the rule string that we provide. The fields of recurrence editor will change its values accordingly, when we provide a particular rule through the setRecurrenceRule method.

@using Syncfusion.EJ2.Schedule

<div class="recurrence-editor-wrap">
    <div style="padding-bottom:15px;">
        <label id="rule-label">Rule Output</label>
        <div class="rule-output-container">
            <div id="rule-output"></div>
        </div>
    </div>
    <ejs-recurrenceeditor id="RecurrenceEditor" change="onChange"></ejs-recurrenceeditor>
</div>

<style>
    .recurrence-editor-wrap {
        margin: 0 25%;
    }

    .rule-output-container {
        height: auto;
        border: 1px solid #969696;
    }

    #rule-output {
        padding: 8px 4px;
        text-align: center;
        min-height: 20px;
        overflow: hidden;
        overflow-wrap: break-word;
    }
</style>

<script type="text/javascript">
    document.addEventListener('DOMContentLoaded', function () {
        var recObject = document.getElementById('RecurrenceEditor').ej2_instances[0];
        recObject.setRecurrenceRule('FREQ=DAILY;INTERVAL=2;COUNT=8');
    });
    function onChange(args) {
        var outputElement = document.querySelector('#rule-output');
        if (args.value == "") {
            outputElement.innerText = 'Select Rule';
        } else {
            outputElement.innerText = args.value;
        }
    }
</script>
public ActionResult Index()
{
    return View();
}

Recurrence date generation

You can parse the recurrenceRule of an event to generate the date instances on which that particular event is going to occur, using the getRecurrenceDates method. It generates the dates based on the recurrenceRule that we provide. The parameters to be provided for getRecurrenceDates method are as follows.

Field name Type Description
startDate Date Appointment start date.
rule String Recurrence rule present in an event object.
excludeDate String Date collection (in ISO format) to be excluded. It is optional.
maximumCount Number Number of date count to be generated. It is optional.
viewDate Date Current view range’s first date. It is optional. 
@using Syncfusion.EJ2.Schedule

<div>
    <div style="padding-bottom:15px;">
        <label id="rule-label">Rule Output</label>
        <div class="rule-output-container">
            <div id="rule-output"></div>
        </div>
    </div>
    <ejs-recurrenceeditor id="RecurrenceEditor"></ejs-recurrenceeditor>
</div>

<style>
    .recurrence-editor-wrap {
        margin: 0 25%;
    }

    .rule-output-container {
        height: auto;
        border: 1px solid #969696;
    }

    #rule-output {
        padding: 8px 4px;
        text-align: center;
        min-height: 20px;
        overflow: hidden;
        overflow-wrap: break-word;
    }

    #RecurrenceEditor {
        display: none;
    }
</style>

<script type="text/javascript">
    document.addEventListener('DOMContentLoaded', function () {
        var outputElement = document.querySelector('#rule-output');
        var labelElement = document.querySelector('#rule-label');
        var recObject = new ej.schedule.RecurrenceEditor();
        var dates = recObject.getRecurrenceDates(new Date(2018, 0, 7, 10, 0), 'FREQ=DAILY;INTERVAL=1', '20180108T114224Z,20180110T114224Z', 4, new Date(2018, 0, 7))
        labelElement.innerText = 'Date Collections';
        outputElement.innerHTML = '';
        for (var index = 0; index < dates.length; index++) {
            outputElement.appendChild(new ej.base.createElement('div', { innerHTML: new Date(dates[index]).toString() }));
        }
    });
</script>
public ActionResult Index()
{
    return View();
}

NOTE

Above example will generate two dates January 7, 2018 & January 9 2018 by excluding the in between dates January 8 2018 & January 10 2018, since those dates were given in the exclusion list. Generated dates can then be utilized to create appointments.

Recurrence date generation in server-side

It is also possible to generate recurrence date instances from server-side by manually referring the RecurrenceHelper class, which is specifically written and referred from application end to handle this date generation process.

NOTE

Refer here for the step by step procedure to achieve date generation in server-side.

Restrict date generation with specific count

In case, if the rule is given in “NEVER ENDS” category, then you can mention the maximum count when you actually want to stop the date generation starting from the provided start date. To do so, provide the appropriate maximumCount value within the getRecurrenceDates method as shown in the following code example.

@using Syncfusion.EJ2.Schedule

<div>
    <div style="padding-bottom:15px;">
        <label id="rule-label">Rule Output</label>
        <div class="rule-output-container">
            <div id="rule-output"></div>
        </div>
    </div>
    <ejs-recurrenceeditor id="RecurrenceEditor"></ejs-recurrenceeditor>
</div>

<style>
    .recurrence-editor-wrap {
        margin: 0 25%;
    }

    .rule-output-container {
        height: auto;
        border: 1px solid #969696;
    }

    #rule-output {
        padding: 8px 4px;
        text-align: center;
        min-height: 20px;
        overflow: hidden;
        overflow-wrap: break-word;
    }

    #RecurrenceEditor {
        display: none;
    }
</style>

<script type="text/javascript">
    document.addEventListener('DOMContentLoaded', function () {
        var outputElement = document.querySelector('#rule-output');
        var labelElement = document.querySelector('#rule-label');
        var recObject = new ej.schedule.RecurrenceEditor();
        var dates = recObject.getRecurrenceDates(new Date(2018, 0, 7, 10, 0), 'FREQ=DAILY;INTERVAL=1; COUNT=30', '20180108T114224Z,20180110T114224Z', 10, new Date(2018, 0, 7));
        labelElement.innerText = 'Date Collections';
        outputElement.innerHTML = '';
        for (var index = 0; index < dates.length; index++) {
            outputElement.appendChild(new ej.base.createElement('div', { innerHTML: new Date(dates[index]).toString() }));
        }
    });
</script>
public ActionResult Index()
{
    return View();
}

NOTE

You can refer to our ASP.NET Core Scheduler feature tour page for its groundbreaking feature representations. You can also explore our ASP.NET Core Scheduler example to knows how to present and manipulate data.