Skip to content

Commit ed9a588

Browse files
committed
984382: Updated the UG document for the Scheduler component
1 parent 4e4d6d6 commit ed9a588

18 files changed

+293
-214
lines changed

blazor/scheduler/dimensions.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ documentation: ug
99

1010
# Scheduler Dimensions in Blazor Scheduler Component
1111

12-
The Scheduler dimensions refers to both height and width of the entire layout and it accepts 3 types of values.
12+
The dimensions of the Syncfusion Blazor Scheduler component, encompassing both height and width of its entire layout, can be defined using three types of values:
1313

1414
* auto
1515
* pixel
1616
* percentage
1717

1818
## Auto Height and Width
1919

20-
When height and width of the Scheduler are set to `auto`, it will try hard to keep an element the same width as its parent container. In other words, for the parent container that holds Scheduler, it's width or height will be the sum of its children. By default, Scheduler is assigned with `auto` values for both height and width properties.
20+
When the height and width of the Scheduler are set to `auto`, the component attempts to match the width of its parent container. In this configuration, the parent container's width or height will be the cumulative size of its children. By default, the Scheduler component is assigned `auto` values for both its `Height` and `Width` properties.
2121

2222
```cshtml
2323
@using Syncfusion.Blazor.Schedule
@@ -47,10 +47,11 @@ When height and width of the Scheduler are set to `auto`, it will try hard to ke
4747
}
4848
}
4949
```
50+
{% previewsample "https://blazorplayground.syncfusion.com/embed/BNBesjtcsURMTcIB?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
5051

51-
## Height and Width in pixel
52+
## Height and Width in Pixel
5253

53-
The Scheduler height and width will be rendered exactly as per the given pixel values. It accepts both string and number values.
54+
The Scheduler's height and width render precisely according to the specified pixel values. Both string and number values are accepted for these properties.
5455

5556
```cshtml
5657
@using Syncfusion.Blazor.Schedule
@@ -80,10 +81,13 @@ The Scheduler height and width will be rendered exactly as per the given pixel v
8081
}
8182
}
8283
```
84+
{% previewsample "https://blazorplayground.syncfusion.com/embed/rZByiNjQWKmhecik?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
8385

84-
## Height and Width in percentage
86+
![Height and width in pixel in Blazor Scheduler](images/height-width-inpixel.png)
8587

86-
When height and width of the Scheduler are given as percentage, it will make the Scheduler as wide as the parent container.
88+
## Height and Width in Percentage
89+
90+
When the height and width of the Scheduler are provided as percentage values, the component will expand to occupy the specified percentage of its parent container's dimensions.
8791

8892
```cshtml
8993
@using Syncfusion.Blazor.Schedule
@@ -113,10 +117,11 @@ When height and width of the Scheduler are given as percentage, it will make the
113117
}
114118
}
115119
```
120+
{% previewsample "https://blazorplayground.syncfusion.com/embed/BtLSstjwCqYbFnCD?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
116121

117-
## How to set the full height of the view port
122+
## How to set the full height of the viewport
118123

119-
When the height of the Scheduler is set in the CSS unit of Viewport Height(vh), it will make the Scheduler to occupy the full height within the viewport.
124+
Setting the Scheduler's height using the CSS unit of Viewport Height (vh) allows the component to occupy the full height within the viewport.
120125

121126
In the following example, the application header height (4.6rem) is reduced from the total viewport.
122127

@@ -148,5 +153,4 @@ In the following example, the application header height (4.6rem) is reduced from
148153
}
149154
}
150155
```
151-
152156
![Blazor Scheduler with View Port Height](images/blazor-scheduler-view-port-height.png)

blazor/scheduler/editor-template.md

Lines changed: 73 additions & 48 deletions
Large diffs are not rendered by default.

blazor/scheduler/events.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ documentation: ug
99

1010
# Events in Blazor Scheduler Component
1111

12-
In this section, the list of events of the Scheduler component have been provided which will be triggered for appropriate Scheduler actions.
12+
This section provides a list of events associated with the Scheduler component that trigger upon appropriate Scheduler actions.
1313

1414
The events should be provided to the Scheduler using **ScheduleEvents** tag. When using events of Scheduler, **TValue** must be provided in the **ScheduleEvents** tag.
1515

1616
## ActionCompleted
1717

18-
[`ActionCompleted`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_ActionCompleted) event triggers on successful completion of the Scheduler actions.
18+
[`ActionCompleted`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_ActionCompleted) event triggers upon the successful completion of Scheduler actions.
1919

2020
The action type that can be checked within the [`ActionCompleted`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_ActionCompleted) event are as follows.
2121

@@ -77,7 +77,7 @@ The action type that can be checked within the [`ActionCompleted`](https://help.
7777

7878
## Created
7979

80-
[`Created`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_Created) event triggers after the Scheduler component is created.
80+
The [`Created`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_Created) event triggers after the Scheduler component is rendered.
8181

8282
```cshtml
8383
@using Syncfusion.Blazor.Schedule
@@ -98,7 +98,7 @@ The action type that can be checked within the [`ActionCompleted`](https://help.
9898
DateTime CurrentDate = new DateTime(2020, 3, 10);
9999
public void OnCreated()
100100
{
101-
//Here you can customize your code
101+
// Custom code can be implemented here.
102102
}
103103
List<AppointmentData> DataSource = new List<AppointmentData>
104104
{
@@ -122,7 +122,7 @@ The action type that can be checked within the [`ActionCompleted`](https://help.
122122

123123
## DataBinding
124124

125-
[`DataBinding`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_DataBinding) event triggers before the data binds to the Scheduler.
125+
The [`DataBinding`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_DataBinding) event triggers before data binds to the Scheduler.
126126

127127
```cshtml
128128
@using Syncfusion.Blazor.Schedule
@@ -167,7 +167,7 @@ The action type that can be checked within the [`ActionCompleted`](https://help.
167167

168168
## DataBound
169169

170-
[`DataBound`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_DataBound) event triggers once the event data is bound to the Scheduler.
170+
The [`DataBound`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_DataBound) event triggers once event data is bound to the Scheduler.
171171

172172
```cshtml
173173
@using Syncfusion.Blazor.Schedule
@@ -213,7 +213,7 @@ The action type that can be checked within the [`ActionCompleted`](https://help.
213213

214214
## Destroyed
215215

216-
[`Destroyed`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_Destroyed) event triggers when the Scheduler component is destroyed.
216+
The [`Destroyed`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_Destroyed) event triggers when the Scheduler component is destroyed.
217217

218218
```cshtml
219219
@using Syncfusion.Blazor.Schedule
@@ -234,7 +234,7 @@ The action type that can be checked within the [`ActionCompleted`](https://help.
234234
DateTime CurrentDate = new DateTime(2020, 3, 10);
235235
public void OnDestroyed()
236236
{
237-
//Here you can customize your code
237+
// Custom code can be implemented here.
238238
}
239239
List<AppointmentData> DataSource = new List<AppointmentData>
240240
{
@@ -258,7 +258,7 @@ The action type that can be checked within the [`ActionCompleted`](https://help.
258258

259259
## Dragged
260260

261-
[`Dragged`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_Dragged) event triggers when the dragging of appointment is stopped.
261+
[`Dragged`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_Dragged) event triggers when appointment dragging is stopped.
262262

263263
```cshtml
264264
@using Syncfusion.Blazor.Schedule
@@ -304,7 +304,7 @@ The action type that can be checked within the [`ActionCompleted`](https://help.
304304

305305
## EventRendered
306306

307-
[`EventRendered`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_EventRendered) event triggers before each of the event getting rendered on the Scheduler user interface.
307+
The [`EventRendered`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_EventRendered) event triggers before each event is rendered on the Scheduler user interface.
308308

309309
```cshtml
310310
@using Syncfusion.Blazor.Schedule
@@ -358,7 +358,7 @@ The action type that can be checked within the [`ActionCompleted`](https://help.
358358

359359
## MoreEventsClicked
360360

361-
[`MoreEventsClicked`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_MoreEventsClicked) event triggers when the more events indicator are clicked.
361+
The [`MoreEventsClicked`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_MoreEventsClicked) event triggers when the "more events" indicator is clicked.
362362

363363
```cshtml
364364
@using Syncfusion.Blazor.Schedule
@@ -406,7 +406,7 @@ The action type that can be checked within the [`ActionCompleted`](https://help.
406406

407407
## Navigating
408408

409-
[`Navigating`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_Navigating) event triggers before the date or view navigation takes place on Scheduler.
409+
[`Navigating`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_Navigating) event triggers before date or view navigation occurs in the Scheduler.
410410

411411
```cshtml
412412
@using Syncfusion.Blazor.Schedule
@@ -453,9 +453,9 @@ The action type that can be checked within the [`ActionCompleted`](https://help.
453453

454454
## OnActionBegin
455455

456-
[`OnActionBegin`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnActionBegin) event triggers on beginning of every Scheduler action.
456+
[`OnActionBegin`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnActionBegin) event triggers at the beginning of every Scheduler action.
457457

458-
The request type that can be checked within the [`OnActionBegin`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnActionBegin) event are as follows.
458+
The `ActionType` that can be checked within the [`OnActionBegin`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnActionBegin) event are as follows.
459459

460460
| ActionType | Description |
461461
|------|-------------|
@@ -513,7 +513,7 @@ The request type that can be checked within the [`OnActionBegin`](https://help.s
513513

514514
## OnActionFailure
515515

516-
[`OnActionFailure`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnActionFailure) event triggers when a Scheduler action gets failed or interrupted.
516+
[`OnActionFailure`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnActionFailure) event triggers when a Scheduler action fails or is interrupted.
517517

518518
```cshtml
519519
@using Syncfusion.Blazor.Schedule
@@ -558,7 +558,7 @@ The request type that can be checked within the [`OnActionBegin`](https://help.s
558558

559559
## OnCellClick
560560

561-
[`OnCellClick`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnCellClick) event triggers when the Scheduler cells are single clicked or on single tap on the same cells in mobile devices.
561+
[`OnCellClick`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnCellClick) event triggers when Scheduler cells are single-clicked or upon single-tapping the same cells on mobile devices.
562562

563563
```cshtml
564564
@using Syncfusion.Blazor.Schedule
@@ -695,7 +695,7 @@ The request type that can be checked within the [`OnActionBegin`](https://help.s
695695

696696
## OnEventClick
697697

698-
[`OnEventClick`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnEventClick) event triggers when the events are single clicked or on single tapping the events on the mobile devices.
698+
[`OnEventClick`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnEventClick) event triggers when an event is single-clicked or upon single-tapping an event on mobile devices.
699699

700700
```cshtml
701701
@using Syncfusion.Blazor.Schedule
@@ -742,7 +742,7 @@ The request type that can be checked within the [`OnActionBegin`](https://help.s
742742

743743
## OnEventDoubleClick
744744

745-
[`OnEventDoubleClick`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnEventDoubleClick) event triggers when the events are double clicked.
745+
[`OnEventDoubleClick`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnEventDoubleClick) event triggers when an event is double-clicked.
746746

747747
```cshtml
748748
@using Syncfusion.Blazor.Schedule
@@ -790,9 +790,9 @@ The request type that can be checked within the [`OnActionBegin`](https://help.s
790790

791791
## OnPopupClose
792792

793-
[`OnPopupClose`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnPopupClose) event triggers before any of the Scheduler popups close on the page.
793+
[`OnPopupClose`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnPopupClose) event triggers before any Scheduler popups close on the page.
794794

795-
In case, if you need to prevent only specific popups on Scheduler, then you can check the condition based on the popup type. The types of the popup that can be checked within the [`OnPopupClose`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnPopupClose) event are as follows.
795+
To prevent only specific popups in the Scheduler, the condition can be checked based on the popup type. The `PopupType` values that can be checked within the [`OnPopupClose`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnPopupClose) event are as follows.
796796

797797
| PopupType | Description |
798798
|------|-------------|
@@ -852,9 +852,9 @@ In case, if you need to prevent only specific popups on Scheduler, then you can
852852

853853
## OnPopupOpen
854854

855-
[`OnPopupOpen`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnPopupOpen) event triggers before any of the Scheduler popups opens on the page.
855+
[`OnPopupOpen`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnPopupOpen) event triggers before any Scheduler popups open on the page.
856856

857-
In case, if you need to prevent only specific popups on Scheduler, then you can check the condition based on the popup type. The types of the popup that can be checked within the [`OnPopupOpen`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnPopupOpen) event are as follows.
857+
To prevent only specific popups in the Scheduler, the condition can be checked based on the popup type. The `PopupType` values that can be checked within the [`OnPopupOpen`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnPopupOpen) event are as follows.
858858

859859
| PopupType | Description |
860860
|------|-------------|
@@ -914,7 +914,7 @@ In case, if you need to prevent only specific popups on Scheduler, then you can
914914

915915
## OnRenderCell
916916

917-
[`OnRenderCell`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnRenderCell) event triggers before each element of the Schedule rendering on the page.
917+
[`OnRenderCell`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnRenderCell) event triggers before each element of the Scheduler renders on the page.
918918

919919
The ElementType that can be checked within the [`OnRenderCell`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnRenderCell) event are as follows.
920920

@@ -983,7 +983,7 @@ The ElementType that can be checked within the [`OnRenderCell`](https://help.syn
983983

984984
## OnResizeStart
985985

986-
[`OnResizeStart`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnResizeStart) event triggers when an appointment is started to resize.
986+
[`OnResizeStart`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Schedule.ScheduleEvents-1.html#Syncfusion_Blazor_Schedule_ScheduleEvents_1_OnResizeStart) event triggers when an appointment begins to be resized.
987987

988988
```cshtml
989989
@using Syncfusion.Blazor.Schedule

0 commit comments

Comments
 (0)