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)

'Declaration
Public ReadOnly Property IsToday As Boolean
'Usage
Dim instance As CalendarDay
Dim value As Boolean

value = instance.IsToday

/** @property */
public boolean get_IsToday ()

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.

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="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>


Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0
Show: