Customization in ASP.NET WebForms Schedule
26 Jul 202224 minutes to read
The Scheduler can be customized in various aspects like -
- Setting different Start/end hour limits
- Highlighting the working hours
- Setting different Date format
- Specifying minimum and maximum date ranges
- Customize the entire appointment window with the user required fields
- Setting different time Slot duration
- Complete Scheduler customization using QueryCellInfo event
- Setting different FirstDayOfWeek
Hour Customization
It includes customization of displaying Scheduler with specific Start/End hours and also defining the working hour time range which is differentiated as business hours.
Schedule Display Hours
It denotes the start and end hour time limits to be displayed on the Scheduler. To set this time limit, two properties namely StartHour and EndHour can be used.
- StartHour - The hour from which the Scheduler time display actually starts.
- EndHour - The hour on which the Scheduler time display should end.
The following code example renders the scheduler from 7.00 AM to 6.00 PM.
<!--Container for ejScheduler widget-->
<ej:Schedule ClientIDMode="Static" runat="server" ID="Schedule1" DataSourceID="SqlData" Width="100%" Height="525px" StartHour="7" EndHour="18" CurrentDate="5/2/2014">
<AppointmentSettings Id="Id" Subject="Subject" AllDay="AllDay" StartTime="StartTime" EndTime="EndTime" Description="Description" Recurrence="Recurrence" RecurrenceRule="RecurrenceRule"/>
</ej:Schedule>
<asp:SqlDataSource ID="SqlData" runat="server" ConnectionString="<%$ ConnectionStrings:ScheduleConnectionString %>"
SelectCommand="SELECT * FROM [DefaultSchedule]"></asp:SqlDataSource>Hide Weekend days
The Scheduler can be customized to display only the working days, thus hiding the weekend days from it. The working days render based on the values given in the WorkWeek property. The days that are not mentioned in the WorkWeek collection is considered to be the weekend days and it can be hidden from the Scheduler by setting false to the ShowWeekend property.
The following code example renders the Scheduler by hiding the weekend days.
<!--Container for ejScheduler widget-->
<ej:Schedule ClientIDMode="Static" runat="server" ID="Schedule1" DataSourceID="SqlData" Width="100%" Height="525px" CurrentDate="5/2/2014" ShowWeekend="false">
<AppointmentSettings Id="Id" Subject="Subject" AllDay="AllDay" StartTime="StartTime" EndTime="EndTime" Description="Description" Recurrence="Recurrence" RecurrenceRule="RecurrenceRule"/>
</ej:Schedule>
<asp:SqlDataSource ID="SqlData" runat="server" ConnectionString="<%$ ConnectionStrings:ScheduleConnectionString %>"
SelectCommand="SELECT * FROM [DefaultSchedule]"></asp:SqlDataSource>Working Hours
Working hours indicates the work hour limit within the Scheduler, which is highlighted visually with white colored work cells. To enable the highlighting of work hours on the Scheduler, set the Highlight option available within the WorkHours property to true. By default, it is set to true. WorkHours property includes the below options,
- Highlight – enables/disables the highlighting of work hours.
- Start - sets the start time of the working/business hour in a day.
- End - sets the end time limit of the working/business hour in a day.
<!--Container for ejScheduler widget-->
<ej:Schedule ClientIDMode="Static" runat="server" ID="Schedule1" DataSourceID="SqlData" Width="100%" Height="525px" CurrentDate="5/2/2014">
<WorkHours Highlight="true" Start="8" End="16" />
<AppointmentSettings Id="Id" Subject="Subject" AllDay="AllDay" StartTime="StartTime" EndTime="EndTime" Description="Description" Recurrence="Recurrence" RecurrenceRule="RecurrenceRule"/>
</ej:Schedule>
<asp:SqlDataSource ID="SqlData" runat="server" ConnectionString="<%$ ConnectionStrings:ScheduleConnectionString %>"
SelectCommand="SELECT * FROM [DefaultSchedule]"></asp:SqlDataSource>NOTE
By default, work hour Start is set to 9 and End is set to 18. Also, the Scheduler cells automatically scrolls up or down based on the starting work hour, to make the user to view that particular time initially.
TimeScale
The TimeScale allows the user to set the required time slot duration for the work cells that displays on the Scheduler. It provides option to customize both the major and minor slots using template option. It includes the below properties such as,
-
Enable- It accepts true or false value, denoting whether to show or hide the time slots. Its default value istrue. -
MajorSlot– Specifies the major time slot duration. -
MinorSlotCount– Specifies the value, based on which the minor time slots are divided into appropriate count. - TimeScale templates - 2 template options available for customizing time scales namely
MinorSlotTemplateIdandMajorSlotTemplateId.
The MajorSlot and MinorSlot can be set on the Scheduler with the following code example.
<!--Container for ejScheduler widget-->
<ej:Schedule ClientIDMode="Static" runat="server" ID="Schedule1" DataSourceID="SqlData" Width="100%" Height="525px" CurrentDate="5/2/2014" OnServerDragOver="Schedule1_ServerDragOver" OnServerResizing="Schedule1_ServerResizing">
<TimeScale MinorSlotCount="5" MajorSlot="60" />
<AppointmentSettings Id="Id" Subject="Subject" AllDay="AllDay" StartTime="StartTime" EndTime="EndTime" Description="Description" Recurrence="Recurrence" RecurrenceRule="RecurrenceRule"/>
</ej:Schedule>
<asp:SqlDataSource ID="SqlData" runat="server" ConnectionString="<%$ ConnectionStrings:ScheduleConnectionString %>"
SelectCommand="SELECT * FROM [DefaultSchedule]"></asp:SqlDataSource>Date Customization
The date in the Scheduler can be customized by setting specific minimum and maximum date ranges and also defining various date formats to it.
Current Date
The Current date indicates the date with which the Scheduler loads initially and based on which the appropriate date range displays in the week/workweek/month/agenda views. To set the current date to the Scheduler – use the following code example,
<!--Container for ejScheduler widget-->
<ej:Schedule ClientIDMode="Static" runat="server" ID="Schedule1" DataSourceID="SqlData" Width="100%" Height="525px" CurrentDate="5/2/2014">
<AppointmentSettings Id="Id" Subject="Subject" AllDay="AllDay" StartTime="StartTime" EndTime="EndTime" Description="Description" Recurrence="Recurrence" RecurrenceRule="RecurrenceRule"/>
</ej:Schedule>
<asp:SqlDataSource ID="SqlData" runat="server" ConnectionString="<%$ ConnectionStrings:ScheduleConnectionString %>"
SelectCommand="SELECT * FROM [DefaultSchedule]"></asp:SqlDataSource>NOTE
By default, the System current date will be taken as Scheduler’s current date.
MinDate and MaxDate
Providing the MinDate and MaxDate property with some date values, allows the Scheduler to set the minimum and maximum date range. The Scheduler date that lies beyond these minimum and maximum date range will be in a disabled state, so that the date navigation is blocked beyond these specified date range. Also, the appointments that lies beyond these date ranges will not be displayed on the Scheduler.
The following code example shows how to set the MinDate and MaxDate properties of the Scheduler.
<!--Container for ejScheduler widget-->
<ej:Schedule ClientIDMode="Static" runat="server" ID="Schedule1" DataSourceID="SqlData" Width="100%" Height="525px" MinDate="5/4/2014" MaxDate="5/9/2014">
<AppointmentSettings Id="Id" Subject="Subject" AllDay="AllDay" StartTime="StartTime" EndTime="EndTime" Description="Description" Recurrence="Recurrence" RecurrenceRule="RecurrenceRule"/>
</ej:Schedule>
<asp:SqlDataSource ID="SqlData" runat="server" ConnectionString="<%$ ConnectionStrings:ScheduleConnectionString %>"
SelectCommand="SELECT * FROM [DefaultSchedule]"></asp:SqlDataSource>NOTE
The MaxDate value provided should always be greater than that of MinDate value.
Appointment Window Customization
It is possible to use the custom appointment window option to design it with the user-required extra fields apart from the other default available fields. To make use of the customized appointment window, it is necessary to use the AppointmentWindowOpen event within which the display of default appointment window is prevented.
The following code example lets you create the custom appointment window (using recurrence editor feature) with a single extra field for defining the appointment type.
<!--Container for ejScheduler widget-->
<asp:Content ID="ControlContent" runat="server" ContentPlaceHolderID="ControlsSection">
<div>
<ej:Schedule ClientIDMode="Static" runat="server" ID="Schedule1" DataSourceID="SqlData" Width="100%" Height="525px" CurrentDate="5/2/2014" AppointmentWindowOpen="onAppointmentWindowOpen">
<AppointmentSettings Id="Id" Subject="Subject" AllDay="AllDay" StartTime="StartTime" EndTime="EndTime" Description="Description" Recurrence="Recurrence" RecurrenceRule="RecurrenceRule"/>
</ej:Schedule>
</div>
<ej:Dialog runat="server" ClientIDMode="Static" ID="customWindow" Width="600" Height="auto" EnableModal="true" ShowOnInit="false" Title="Create Appointment" EnableResize="false" AllowKeyboardNavigation="false" ClientSideOnClose="clearFields" Containment=".custom">
<DialogContent>
<div>
<div id="customWindow" style="display: none">
<div id="appWindow">
<div id="custom">
<table width="100%" cellpadding="5">
<tbody>
<tr style="display: none">
<td>Id:
</td>
<td colspan="2">
<input id="customId" type="text" name="Id" />
</td>
</tr>
<tr>
<td>Subject:
</td>
<td colspan="2">
<input id="subject" type="text" value="" name="Subject" onfocus="temp()" style="width: 100%" />
</td>
</tr>
<tr>
<td>Description:
</td>
<td colspan="2">
<textarea id="customDescription" name="Description" rows="3" cols="50" style="width: 100%; resize: vertical"></textarea>
</td>
</tr>
<tr>
<td>StartTime:
</td>
<td>
<ej:DateTimePicker ClientIDMode="Static" runat="server" ID="StartTime" Width="150"></ej:DateTimePicker>
</td>
</tr>
<tr>
<td>EndTime:
</td>
<td>
<ej:DateTimePicker ClientIDMode="Static" runat="server" ID="EndTime" Width="150"></ej:DateTimePicker>
</td>
</tr>
<tr>
<td colspan="3">
<div class="customcheck">AllDay:</div>
<div class="customcheck">
<input id="allDay" type="checkbox" name="AllDay" onchange="allDayCheck()" />
</div>
<div class="customcheck">Recurrence:</div>
<div>
<input id="recurrence" type="checkbox" name="Recurrence" onchange="recurCheck()" />
</div>
</td>
</tr>
<tr id="summaryTr" style="display: none;">
<td colspan="3">
<div class="recSummary">Summary:</div>
<div>
<label id="recSummary" name="Summary"></label>
</div>
</td>
</tr>
<tr id="editor" style="display: none;">
<td colspan="3">
<div><a id="recEdit" onclick="recurrenceRule()">Edit</a></div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<button type="submit" onclick="cancel()" id="buttonCancel" style="float: right; margin-right: 20px; margin-bottom: 10px;">Cancel</button>
<button type="submit" onclick="save()" id="buttonSubmit" style="float: right; margin-right: 20px; margin-bottom: 10px;">Submit</button>
</div>
</div>
<div id="recWindow" style="display: none">
<div style="margin: 0 15%;">
<ej:RecurrenceEditor ClientIDMode="Static" ID="recurrenceEditor" SelectedRecurrenceType="0" Frequencies="daily,weekly,monthly,yearly,everyweekday" runat="server"></ej:RecurrenceEditor>
</div>
<div>
<button type="submit" id="recCancel">Cancel</button>
<button type="submit" id="recSubmit">Submit</button>
</div>
</div>
</div>
</DialogContent>
</ej:Dialog>
<asp:SqlDataSource ID="SqlData" runat="server" ConnectionString="<%$ ConnectionStrings:ScheduleConnectionString %>"
SelectCommand="SELECT * FROM [DefaultSchedule]"></asp:SqlDataSource>
</asp:Content>The styles to be applied for the controls within the custom appointment window are as follows.
<asp:Content runat="server" ID="Style" ContentPlaceHolderID="StyleSection">
<style type="text/css">
.customcheck {
float: left;
margin-right: 10px;
}
.error {
background-color: #FF8A8A;
}
#custom table td {
padding: 5px;
}
.custom {
position:relative;
}
.btn{
float:right;
margin-right:20px;
margin-bottom:10px;
}
</style>
</asp:Content>The following function needs to be defined within script section, which gets called before the default appointment window opens.
<asp:Content ID="ScriptContent" runat="server" ContentPlaceHolderID="ScriptSection">
<script type="text/javascript">
$(function () {
// defining sub-controls used within custom appointment window
$("#buttonCancel").ejButton({ width: '85px' });
$("#buttonSubmit").ejButton({ width: '85px' });
$("#recurrence").ejCheckBox({ change: "recurCheck" });
$("#recCancel,#recSubmit").ejButton({ click: "onRecurrenceClick" });
});
function onAppointmentWindowOpen(args) {
args.cancel = true; // prevents the display of default appointment window
var schObj = $("#Schedule1").data("ejSchedule");
// When double clicked on the Scheduler cells, fills the StartTime and EndTime fields appropriately
$("#StartTime").ejDateTimePicker({ value: args.startTime });
$("#EndTime").ejDateTimePicker({ value: args.endTime });
$("#recWindow").css("display", "none");
$("#appWindow").css("display", "");
if (!ej.isNullOrUndefined(args.target)) {
// When double clicked on the Scheduler cells, if the target is all day or month cells – only then enable check mark on the all day checkbox
if ($(args.target.currentTarget).hasClass("e-alldaycells") || (args.startTime.getHours() == 0 && args.endTime.getHours() == 23))
$("#allDay").prop("checked", true);
else
args.model.currentView == "month" ? $("#allDay").prop("checked", true) : $("#allDay").prop("checked", false);
// If the target is all day or month cells – disable the StartTime and EndTime fields
$("#StartTime,#EndTime").ejDateTimePicker({
enabled: ($(args.target.currentTarget).hasClass("e-alldaycells") || (args.startTime.getHours() == 0 && args.endTime.getHours() == 23) || $(args.target.currentTarget).hasClass("e-monthcells") || args.model.currentView == "month") ? false : true
});
}
// If double clicked on the appointments, fill the custom appointment window fields with appropriate values.
if (!ej.isNullOrUndefined(args.appointment)) {
$("#customId").val(args.appointment.Id);
$("#subject").val(args.appointment.Subject);
$("#StartTime").ejDateTimePicker({ value: new Date(args.appointment.StartTime) });
$("#EndTime").ejDateTimePicker({ value: new Date(args.appointment.EndTime) });
$("#recurrence").ejCheckBox({ checked: args.appointment.Recurrence });
if (args.appointment.Recurrence) {
$("#editor").css("display", "");
$("#recSummary").html(args.appointment.RecurrenceRule);
$("#summaryTr").css("display", "");
recObj._recRule = args.appointment.RecurrenceRule; // app recurrence rule is stored in Recurrence editor object
recObj.recurrenceRuleSplit(args.appointment.RecurrenceRule, args.appointment.recurrenceExDate); //splitting the recurrence rule
recObj.showRecurrenceSummary(args.appointment.Id); // updating the recurrence rule in Recurrence editor
}
}
$("#customWindow").ejDialog("open");
}
</script>
</asp:Content>On clicking the Submit button within the Custom Appointment window, the following function gets executed – which will validate the appointment fields and then save it appropriately.
<asp:Content ID="ScriptContent" runat="server" ContentPlaceHolderID="ScriptSection">
<script type="text/javascript">
function save() {
// checks if the subject value is not left blank before saving it.
if ($.trim($("#subject").val()) == "") {
$("#subject").addClass("error");
return false;
}
var obj = {}, temp = {}, rType;
var formElement = $("#customWindow").find("#custom").get(0);
// looping through the custom form elements to get each value and form a JSON object
obj["Id"] = $("#customId").val() == "" ? $("#customId").val() : parseInt($("#customId").val());
obj["Subject"] = $("#subject")[0].value;
obj["Description"] = $("#customDescription")[0].value;
obj["StartTime"] = new Date($("#StartTime")[0].value);
obj["EndTime"] = new Date($("#EndTime")[0].value);
obj["AllDay"] = $("#allDay")[0].checked;
obj["Recurrence"] = $("#recurrence")[0].checked;
obj["RecurrenceRule"] = (obj.Recurrence) ? recurRule : null;
$("#customWindow").ejDialog("close");
var object = $("#Schedule1").data("ejSchedule");
object.saveAppointment(obj);
clearFields();
}
// This function executes when the submit/cancel button in the recurrence editor window is pressed.
function onRecurrenceClick(args) {
if ($(args.e.currentTarget).attr("id") == "recSubmit") {
recObj = $("#recurrenceEditor").ejRecurrenceEditor('instance');
recObj.closeRecurPublic();
recurRule = recObj._recRule;
$("#recSummary").html(recurRule);
}
else
if (($(args.e.currentTarget).attr("id") == "recCancel")) {
if ($("#recSummary").html() == "") {
$("#editor").css("display", "none");
$("#recurrence").ejCheckBox({ checked: false });
}
else
$("#recurrence").ejCheckBox({ checked: true });
}
$("#recWindow").css("display", "none");
$("#appWindow").css("display", "");
if ($("#recSummary").html() != "")
$("#summaryTr").css("display", "");
}
// Clears all the field values of the custom window after saving appointments
function clearFields() {
$("#customId").val("");
recObj.clearRecurrenceFields();
$("#subject").val("");
$("#recSummary").html("");
$("#summaryTr").css("display", "none");
$("#recurrence").ejCheckBox({ checked: false });
$("#editor").css("display", "none");
$("#StartTime,#EndTime").ejDateTimePicker({ enabled: true });
}
// This function executes when the recurrence checkbox is checked in the custom appointment window
function recurCheck(args) {
if (args.isInteraction) {
if ($("#recurrence").get(0).checked == true) { // Displays the recurrence field, when recurrence checkbox is checked.
$("#recWindow").css("display", "");
$("#appWindow").css("display", "none");
$("#editor").css("display", "");
}
else {
$("#recWindow").css("display", "none");
$("#editor").css("display", "none");
$("#recSummary").html("");
$("#summaryTr").css("display", "none");
}
}
}
// This function executes when the All-day checkbox is checked in the custom appointment window
function allDayCheck() {
// Disables and sets the specific hours to the StartTime and EndTime fields, when the all-day checkbox is checked
if ($("#allDay").prop("checked")) {
var a = $("#StartTime").data("ejDateTimePicker").model.value;
a.setHours(0, 0, 0);
var b = $("#EndTime").data("ejDateTimePicker").model.value;
b.setHours(23, 59, 0);
$("#StartTime").ejDateTimePicker({
value: new Date(a),
enabled: false
});
$("#EndTime").ejDateTimePicker({
value: new Date(b),
enabled: false
});
} else {
$("#StartTime").ejDateTimePicker({
enabled: true
});
$("#EndTime").ejDateTimePicker({
enabled: true
});
}
}
// This function executes when the submit/cancel button in the recurrence editor window is pressed.
function onRecurrenceClick(args) {
if ($(args.e.currentTarget).attr("id") == "recSubmit") {
recObj = $("#recurrenceEditor").ejRecurrenceEditor('instance');
recObj.closeRecurPublic();
recurRule = recObj._recRule;
$("#recSummary").html(recurRule);
}
else
if (($(args.e.currentTarget).attr("id") == "recCancel")) {
if ($("#recSummary").html() == "") {
$("#editor").css("display", "none");
$("#recurrence").ejCheckBox({ checked: false });
}
else
$("#recurrence").ejCheckBox({ checked: true });
}
$("#recWindow").css("display", "none");
$("#appWindow").css("display", "");
if ($("#recSummary").html() != "")
$("#summaryTr").css("display", "");
}
// This function executes when the Edit anchor tag in the edit appointment window is clicked.
function recurrenceRule() {
$("#recWindow").css("display", "");
$("#appWindow").css("display", "none");
}
// This function executes when the subject text field is currently being focused
function temp() {
$("#subject").removeClass("error");
}
// This function executes when the cancel button in the custom appointment window is pressed.
function cancel() {
recObj = $("#recurrenceEditor").ejRecurrenceEditor('instance');
clearFields();
$("#customWindow").ejDialog("close");
}
</script>
</asp:Content>Scheduler Customization using QueryCellInfo
It is possible to format and customize almost every child elements of scheduler such as work cells, header cells, time cells and so on using QueryCellInfo event.
The following code snippet shows how to customize the appointment and work cells based on the query cell info event.
<!--Container for ejScheduler widget-->
<asp:Content ID="ControlContent" runat="server" ContentPlaceHolderID="ControlsSection">
<div>
<ej:Schedule ClientIDMode="Static" runat="server" ID="Schedule1" QueryCellInfo="checkFormat" Width="100%" Height="525px" CurrentDate="5/2/2014">
<AppointmentSettings Id="Id" Subject="Subject" AllDay="AllDay" StartTime="StartTime" EndTime="EndTime" Description="Description" Recurrence="Recurrence" RecurrenceRule="RecurrenceRule"/>
</ej:Schedule>
</div>
</asp:Content>While loading the scheduler using above code, the below function gets triggered by the QueryCellInfo event which customizes the corresponding DOM element.
<asp:Content ID="ScriptContent" runat="server" ContentPlaceHolderID="ScriptSection">
<script type="text/javascript">
function checkFormat(args) {
switch (args.requestType) {
case "workcells":
args.element.css("background-color", "#ffe9cc");
break;
case "monthcells":
args.element.css("background-color", "#faa41a");
args.element.css("border-color", "#faa41a");
break;
}
}
</script>
</asp:Content>The Scheduler elements are listed below which can be formatted through this event. The names are listed in the format with which it can be accessed or used within the requestType argument of the event.
| Request Type | Description |
|---|---|
| appointment | Depicts the appointment element within the Scheduler. |
| agendacells | Depicts the Agenda Cell element within the Scheduler. |
| alldaycells | Depicts the AllDay cell element within the Scheduler. |
| headercells | Depicts the header cell element within the Scheduler. |
| resourceheadercells | Depicts the resource header cell element within the Scheduler. |
| leftheadercells | Depicts the left empty space on header cell element within the Scheduler. |
| leftindentcells | Depicts the left empty space on date cell element within the Scheduler. |
| timecells | Depicts the left side time panel cell element within the Scheduler. |
| headerdate | Depicts the header date cell element within the Scheduler. |
| emptytd | Depicts the empty space above the vertical scroller within the Scheduler. |
| resourcegroupheader | Depicts the header group cell in horizontal orientation in the Scheduler. |
| monthcells | Depicts the month cell element within the Scheduler. |
| workcells | Depicts the work cell element within the Scheduler. |