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.

[Visual Basic]
Public ReadOnly Property IsToday As Boolean
[C#]
public bool IsToday {get;}
[C++]
public: __property bool get_IsToday();
[JScript]
public function get IsToday() : Boolean;

Property Value

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.

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.

Example

[Visual Basic, C#, JScript] 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.

[Visual Basic] 
<%@ Page Language="VB" AutoEventWireup="True" %>

<html>
<head>

   <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 runat="server">
 
      <asp:Calendar id="calendar1" runat="server"
           WeekendDayStyle-BackColor="gray"
           OnDayRender="DayRender"/>
                   
   </form>
         
</body>
</html>


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

<html>
<head>

   <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 runat="server">
 
      <asp:Calendar id="calendar1" runat="server"
           WeekendDayStyle-BackColor="gray"
           OnDayRender="DayRender"/>
                   
   </form>
         
</body>
</html>


[JScript] 
<%@ Page Language="JScript" AutoEventWireup="True" %>

<html>
<head>

   <script language="JScript" runat="server">

      function DayRender(source : Object, e : DayRenderEventArgs) 
      {
      
         if (e.Day.IsToday)
         {
            e.Cell.BackColor=System.Drawing.Color.Yellow;
            e.Cell.ForeColor=System.Drawing.Color.Red;
         }  
      
      }

   </script>
 
</head>
 
<body>
 
   <form runat="server">
 
      <asp:Calendar id="calendar1" runat="server"
           WeekendDayStyle-BackColor="gray"
           OnDayRender="DayRender"/>
                   
   </form>
         
</body>
</html>

[C++] No example is available for C++. To view a Visual Basic, C#, or JScript example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

See Also

CalendarDay Class | CalendarDay Members | System.Web.UI.WebControls Namespace | Calendar | DayRender | DayRenderEventArgs | Day | IsOtherMonth | IsSelectable | IsSelected | IsWeekend

Show: