CalendarDay.IsToday Property

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

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.

public:
 property bool IsToday { bool get(); };
public bool IsToday { get; }
member this.IsToday : bool
Public ReadOnly Property IsToday As Boolean

Property Value

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.

Examples

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>

<%@ Page Language="VB" 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="VB" runat="server">
        Sub DayRender(source As Object, e As DayRenderEventArgs)
            If e.Day.IsToday Then
                e.Cell.BackColor = System.Drawing.Color.Yellow
                e.Cell.ForeColor = System.Drawing.Color.Red
            End If
        End Sub 'DayRender  
   </script>
 
</head>
 
<body>
 
   <form id="form1" runat="server">
 
      <asp:Calendar id="calendar1" runat="server"
           WeekendDayStyle-BackColor="gray"
           OnDayRender="DayRender"/>
                   
   </form>
         
</body>
</html>

Remarks

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.

Note

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

Applies to

See also