Skip to content

Commit 615670e

Browse files
Merge pull request #6827 from syncfusion-content/984382-scheduler4
Updated the UG document for the Scheduler Component
2 parents 89710b7 + 35d7e1d commit 615670e

18 files changed

+267
-331
lines changed
25.1 KB
Loading
38 KB
Loading
36.8 KB
Loading
26.7 KB
Loading
28.6 KB
Loading
23.7 KB
Loading

blazor/scheduler/recurring-events.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ control: Scheduler
77
documentation: ug
88
---
99

10-
# Recurring events in Blazor Scheduler Component
10+
# Recurring Events in Blazor Scheduler Component
1111

12-
It represents an appointment that is created for a certain time interval and occurring repeatedly on a daily, weekly, monthly or yearly basis at the same time interval based on the provided recurrence rule. Usually, the recurring events are indicated by a repeat marker added at the bottom-right position.
12+
It represents an appointment that is created for a certain time interval and occurring repeatedly on a daily, weekly, monthly or yearly basis at the same time interval based on the provided recurrence rule. Usually, the recurring events are indicated by a repeat marker at the bottom-right position.
1313

1414
N>Set [`RecurrenceRule`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.FieldRecurrenceRule.html) property to create recurring events.
1515

16-
## Recurrence options and rules
16+
## Recurrence Options and Rules
1717

1818
Events can be repeated on a daily, weekly, monthly or yearly basis based on the recurrence rule which accepts the string value. The following details should be assigned to the [`RecurrenceRule`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.FieldRecurrenceRule.html) property to generate the recurring instances.
1919

2020
* Repeat type - daily/weekly/monthly/yearly.
21-
* How many times it needs to be repeated?
21+
* The number of times it needs to be repeated.
2222
* The interval duration.
2323
* The time period to render the appointment, etc.
2424

@@ -29,7 +29,7 @@ There are four repeat types available namely,
2929
* **Monthly** - Creates the recurring instances on monthly basis for the selected months and other provided recurrence criteria.
3030
* **Yearly** - Creates the recurring instances on yearly basis.
3131

32-
## Recurrence properties
32+
## Recurrence Properties
3333

3434
The properties based on which the recurrence appointments are created with its respective time period are depicted in the following table. Also, the valid rule string can be referred from [iCalendar](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10) specifications.
3535

@@ -46,9 +46,9 @@ There are four repeat types available namely,
4646
| BYMONTH | This property is used to store the index value of the selected Month while creating the yearly appointments. When the yearly appointment is created on June month, the index value of June month 6 will get stored in the BYMONTH field. The appointment is created on every 6th month of a year. | FREQ=YEARLY;BYMONTHDAY=16;BYMONTH=6;INTERVAL=1;COUNT=10|
4747
| BYSETPOS | This property is used to store the index value of the week. When the monthly appointment is created in second week of a month, the index value of the second week (2) is stored in BYSETPOS. | FREQ=MONTHLY;BYDAY=MO;BYSETPOS=2;COUNT=10|
4848

49-
N> The default recurrence related validation has been included for recurrence appointments similar to the one available in Outlook. The validation usually occurs during the recurrence appointment creation, editing, drag and drop or resizing of the recurrence appointments and also if any single occurrence changes.
49+
N> Default recurrence-related validation has been included for recurring appointments, similar to that available in Outlook. Validation typically occurs during the creation, editing, dragging, dropping, or resizing of recurring appointments, and also if any single occurrence changes.
5050

51-
## Creating a recurring event
51+
## Creating a Recurring Event
5252

5353
The following example depicts how to create a recurring event on Scheduler with the specific recurrence rule. In the following example, an event is made to repeat on daily mode and ends after 5 occurrences.
5454

@@ -86,8 +86,11 @@ The following example depicts how to create a recurring event on Scheduler with
8686
}
8787
}
8888
```
89+
{% previewsample "https://blazorplayground.syncfusion.com/embed/BNhSsjNGVOpvJlRM?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
8990

90-
## Adding exceptions
91+
![Recurring Event in Blazor Scheduler](images/recurring-event.png)
92+
93+
## Adding Exceptions
9194

9295
A few instance of the recurrence series can be excluded on specific dates, by adding those exceptional dates to the [`RecurrenceException`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.FieldRecurrenceException.html) field. These date values should be given in the ISO date time format with no hyphens(-) separating the date elements.
9396

@@ -127,8 +130,11 @@ For example, 7th January 2020 can be represented as 20200107. Also, the time par
127130
}
128131
}
129132
```
133+
{% previewsample "https://blazorplayground.syncfusion.com/embed/rjLSsZNQVYHzQVve?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
134+
135+
![Recurrence Exceptions in Blazor Scheduler](images/recurrence-exception.png)
130136

131-
## Editing an occurrence from a series
137+
## Editing an Occurrence from a Series
132138

133139
To dynamically edit a particular occurrence from an event series and display it on the initial load of Scheduler, the edited occurrence needs to be added as a new event to the dataSource collection, with an additional [`RecurrenceID`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.FieldRecurrenceId.html) field defined to it. The [`RecurrenceID`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.FieldRecurrenceId.html) field of edited occurrence usually maps the ID value of the parent event.
134140

@@ -169,10 +175,13 @@ In this example, a recurring instance that displays on the date 30th January 202
169175
}
170176
}
171177
```
178+
{% previewsample "https://blazorplayground.syncfusion.com/embed/hZBysNXwBkaVfXNS?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
179+
180+
![Editing an Occurrence from a Series in Blazor Scheduler](images/editing-recurrence.png)
172181

173-
## Edit/Delete following recurrence events
182+
## Edit/Delete Following Recurrence Events
174183

175-
The Scheduler allows the user to edit the following recurrence events by setting true value to [AllowEditFollowingEvents](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEventSettings-1.html#Syncfusion_Blazor_Schedule_ScheduleEventSettings_1_AllowEditFollowingEvents) within the [`ScheduleEventSettings`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEventSettings-1.html) tag. Once the recurrence events are edited/ deleted as following events, then the following recurrence events will be considered as separate series, the changes will not reflect to parent series. In the following code example, if any of the recurrence event is edited or deleted with the following events option, then the edit or delete action is applied to further recurrence events.
184+
The Scheduler allows editing of subsequent recurrence events by setting the [`AllowEditFollowingEvents`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEventSettings-1.html#Syncfusion_Blazor_Schedule_ScheduleEventSettings_1_AllowEditFollowingEvents) property to `true` within the [`ScheduleEventSettings`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEventSettings-1.html) tag. Once subsequent recurrence events are edited or deleted, they will be considered as a separate series, and changes will not reflect in the parent series. In the following code example, if any recurrence event is edited or deleted using the "following events" option, the edit or delete action is applied to further recurrence events in the series.
176185

177186
N>To edit/delete following recurrence events into the scheduler, set [`AllowEditFollowingEvents`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEventSettings-1.html#Syncfusion_Blazor_Schedule_ScheduleEventSettings_1_AllowEditFollowingEvents) field to **true** in [`ScheduleEventSettings`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEventSettings-1.html).
178187

@@ -211,6 +220,7 @@ N>To edit/delete following recurrence events into the scheduler, set [`AllowEdit
211220
}
212221
}
213222
```
223+
{% previewsample "https://blazorplayground.syncfusion.com/embed/BtLIWjZGszsobUfY?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
214224

215225
![Editing Events in Blazor Scheduler](images/blazor-scheduler-editing-events.png)
216226

@@ -260,8 +270,8 @@ The built-in validation support has been added by default for recurring appointm
260270

261271
| Validation messages | Description |
262272
|-------|---------|
263-
| The recurrence pattern is not valid. | This alert will raise, when the selected recurrence rule value is not a valid one. For example, when you try to select the end date value (using `Until` option) for a recurring event, which occurs before the start date, an alert will popup out saying that the chosen pattern is invalid. |
264-
| The changes made to specific instances of this series will be canceled and those events will match the series again. | This alert will raise, when you try to edit the whole series, whose occurrence might have been already edited. For example, If there are five occurrences and one of the occurrence is already edited. Now, when you try to edit the entire series, you will get this validation alert. |
265-
| The duration of the event must be shorter than how frequently it occurs. Shorten the duration, or change the recurrence pattern in the recurrence event editor. | This validation will occur, if the event duration is longer than the selected frequency. For example, if you create a recurring appointment with two days duration in `Daily` frequency with no intervals set to it, you may get this alert. |
266-
| Some months have fewer than the selected date. For these months, the occurrence will fall on the last date of the month. | When you try to create a recurring appointment on 31st of every month, where few months won’t have 31 days and in this scenario, you will get this alert. |
267-
| Two occurrences of the same event cannot occur on the same day. | This validation will occur, when you try to edit or move any single occurrence to some other date, where another occurrence of the same event is already present. |
273+
| The recurrence pattern is not valid. | This alert will be raised when the selected recurrence rule value is not valid. For example, when selecting an end date value (using the `Until` option) for a recurring event that occurs before its start date, an alert will pop up indicating that the chosen pattern is invalid. |
274+
| The changes made to specific instances of this series will be canceled and those events will match the series again. | This alert will be raised when attempting to edit the entire series after one of its occurrences has already been edited. For example, if there are five occurrences and one of them is already edited, attempting to edit the entire series will trigger this validation alert. |
275+
| The duration of the event must be shorter than how frequently it occurs. Shorten the duration, or change the recurrence pattern in the recurrence event editor. | This validation will occur if the event duration is longer than its selected frequency. For example, if a recurring appointment is created with a two-day duration in `Daily` frequency with no intervals set, this alert may appear. |
276+
| Some months have fewer than the selected date. For these months, the occurrence will fall on the last date of the month. | When attempting to create a recurring appointment for the 31st of every month, an alert will be issued for months that do not have 31 days. |
277+
| Two occurrences of the same event cannot occur on the same day. | This validation will occur when attempting to edit or move a single occurrence to a date where another occurrence of the same event is already present. |

0 commit comments

Comments
 (0)