This documentation is archived and is not being maintained.

CalendarDay.IsToday Property

Gets a value that indicates whether the date represented by an instance of this class is the same date specified by the TodaysDate property of the Calendar control. This property is read-only.

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public bool IsToday { get; }

Property Value

Type: System.Boolean
true if the date represented by an instance of this class is the same date specified by the TodaysDate property of the Calendar control; otherwise, false.

Use the IsToday property to programmatically determine whether the date represented by an instance of this class is the same date specified by the TodaysDate property of the Calendar control. This allows you to programmatically control the appearance or behavior of the day, based on this value.

NoteNote

Although the date specified by the TodaysDate property is usually the system date on the server, it is possible to change it, if necessary.

The following example demonstrates how to use the IsToday property to determine if the date being rendered in the DayRender event is the current date. If the date is the current date, it is displayed in a yellow cell with red text on the Calendar. Note that the Day property of the DayRenderEventArgs object passed into the DayRender event handler is the CalendarDay object.


<%@ Page Language="C#" AutoEventWireup="True" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>ASP.NET Example</title>
<script language="C#" runat="server">

      void DayRender(Object source, DayRenderEventArgs e) 
      {

         if (e.Day.IsToday)
         {
            e.Cell.BackColor=System.Drawing.Color.Yellow;
            e.Cell.ForeColor=System.Drawing.Color.Red;
         }  

      }

   </script>

</head>

<body>

   <form id="form1" runat="server">

      <asp:Calendar id="calendar1" runat="server"
           WeekendDayStyle-BackColor="gray"
           OnDayRender="DayRender"/>

   </form>

</body>
</html>



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: