ASPxScheduler.HtmlTimeCellPrepared Event

Occurs when the HTML code representing the time cell is prepared for display.

Namespace: DevExpress.Web.ASPxScheduler

Assembly: DevExpress.Web.ASPxScheduler.v20.2.dll

NuGet Package: DevExpress.Web.Scheduler

Declaration

C#

public event ASPxSchedulerTimeCellPreparedEventHandler HtmlTimeCellPrepared

VB.NET

Public Event HtmlTimeCellPrepared As ASPxSchedulerTimeCellPreparedEventHandler

Event Data

The HtmlTimeCellPrepared event's data class is ASPxSchedulerTimeCellPreparedEventArgs. The following properties provide information specific to this event:

Property	Description
Cell	Provides access to the HTML table cell which represents the current time cell of the Scheduler.
Interval	Gets the time interval which characterizes the current time cell.
Resource	Gets the resource of a cell related to the ASPxScheduler.HtmlTimeCellPrepared event.
View	Provides access to the Scheduler View.

Remarks

The HtmlTimeCellPrepared event occurs before a time cell is rendered. Handling this event enables you to specify the style and color of a particular time cell, and even insert a Literal control to display text.

Note

Subscribing to the HtmlTimeCellPrepared event automatically disables client-side rendering of view elements.

The following code snippet uses the HtmlTimeCellPrepared event to highlight dinner time.

View Example

Default.aspx.cs

using DevExpress.Web.ASPxScheduler;
using DevExpress.Web.Internal;
using DevExpress.XtraScheduler;
    protected void OnHtmlTimeCellPrepared(object sender, ASPxSchedulerTimeCellPreparedEventArgs e) {
        TimeInterval cellInterval = e.Interval;
        if (e.View.Type == DevExpress.XtraScheduler.SchedulerViewType.Day) {
            TimeSpan dinnerStart = new TimeSpan(15, 0, 0);
            TimeSpan dinnerEnd = new TimeSpan(17, 0, 0);
            TimeSpan cellStart = cellInterval.Start.TimeOfDay;
            TimeSpan cellEnd = cellInterval.End.TimeOfDay;
            if (cellStart >= dinnerStart && cellStart <= dinnerEnd && cellEnd <= dinnerEnd) {
                e.Cell.BackColor = Color.Red;
                string valueString = HtmlConvertor.ToHtml(Color.Yellow);
                e.Cell.Style.Add("border-bottom-color", valueString);
                e.Cell.Style.Add("text-align", "center");
                e.Cell.Controls.Add(new LiteralControl("dinner"));
            }
        }
        if (e.View.Type == SchedulerViewType.Week) {
            DateTime specialDate = new DateTime(2008, 7, 24);
            if (cellInterval.Start == specialDate) 
                e.Cell.BackColor = Color.Green;
        }
    }

DefaultObjectDataSources.ascx (C#)

<%@ Control Language="C#" AutoEventWireup="true" CodeFile="DefaultObjectDataSources.ascx.cs" Inherits="DefaultObjectDataSources" %>
<asp:ObjectDataSource ID="appointmentDataSourceObject" runat="server" DataObjectTypeName="CustomEvent" TypeName="CustomEventDataSource" DeleteMethod="DeleteMethodHandler" SelectMethod="SelectMethodHandler" InsertMethod="InsertMethodHandler" OnObjectCreated="temporaryAppointmentDataSource_ObjectCreated" UpdateMethod="UpdateMethodHandler">
</asp:ObjectDataSource>
<asp:ObjectDataSource ID="resourceDataSourceObject" runat="server" DataObjectTypeName="CustomResource" TypeName="CustomResourceDataSource" DeleteMethod="DeleteMethodHandler" SelectMethod="SelectMethodHandler" InsertMethod="InsertMethodHandler" OnObjectCreated="temporaryResourceDataSource_ObjectCreated" UpdateMethod="UpdateMethodHandler">
</asp:ObjectDataSource>

DefaultObjectDataSources.ascx (VB.NET)

<%@ Control Language="vb" AutoEventWireup="true" CodeFile="DefaultObjectDataSources.ascx.vb" Inherits="DefaultObjectDataSources" %>
<asp:ObjectDataSource ID="appointmentDataSourceObject" runat="server" DataObjectTypeName="CustomEvent" TypeName="CustomEventDataSource" DeleteMethod="DeleteMethodHandler" SelectMethod="SelectMethodHandler" InsertMethod="InsertMethodHandler" OnObjectCreated="temporaryAppointmentDataSource_ObjectCreated" UpdateMethod="UpdateMethodHandler">
</asp:ObjectDataSource>
<asp:ObjectDataSource ID="resourceDataSourceObject" runat="server" DataObjectTypeName="CustomResource" TypeName="CustomResourceDataSource" DeleteMethod="DeleteMethodHandler" SelectMethod="SelectMethodHandler" InsertMethod="InsertMethodHandler" OnObjectCreated="temporaryResourceDataSource_ObjectCreated" UpdateMethod="UpdateMethodHandler">
</asp:ObjectDataSource>

Default.aspx.vb

Imports DevExpress.Web.ASPxScheduler
Imports DevExpress.Web.Internal
Imports DevExpress.XtraScheduler
    Protected Sub OnHtmlTimeCellPrepared(ByVal sender As Object, ByVal e As ASPxSchedulerTimeCellPreparedEventArgs)
        Dim cellInterval As TimeInterval = e.Interval
        If e.View.Type = DevExpress.XtraScheduler.SchedulerViewType.Day Then
            Dim dinnerStart As New TimeSpan(15, 0, 0)
            Dim dinnerEnd As New TimeSpan(17, 0, 0)
            Dim cellStart As TimeSpan = cellInterval.Start.TimeOfDay
            Dim cellEnd As TimeSpan = cellInterval.End.TimeOfDay
            If cellStart >= dinnerStart AndAlso cellStart <= dinnerEnd AndAlso cellEnd <= dinnerEnd Then
                e.Cell.BackColor = Color.Red
                Dim valueString As String = HtmlConvertor.ToHtml(Color.Yellow)
                e.Cell.Style.Add("border-bottom-color", valueString)
                e.Cell.Style.Add("text-align", "center")
                e.Cell.Controls.Add(New LiteralControl("dinner"))
            End If
        End If
        If e.View.Type = SchedulerViewType.Week Then
            Dim specialDate As New Date(2008, 7, 24)
            If cellInterval.Start = specialDate Then
                e.Cell.BackColor = Color.Green
            End If
        End If
    End Sub