Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

CalendarDay Class

Represents a date in the Calendar control.

System.Object
  System.Web.UI.WebControls.CalendarDay

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

The CalendarDay type exposes the following members.

  NameDescription
Public methodCalendarDayInitializes a new instance of the CalendarDay class.
Top
  NameDescription
Public propertyDateGets the date represented by an instance of this class. This property is read-only.
Public propertyDayNumberTextGets the string equivalent of the day number for the date represented by an instance of the CalendarDay class. This property is read-only.
Public propertyIsOtherMonthGets a value that indicates whether the date represented by an instance of this class is in a month other than the month displayed in the Calendar control. This property is read-only.
Public propertyIsSelectableGets or sets a value that indicates whether the date represented by an instance of this class can be selected in the Calendar control.
Public propertyIsSelectedGets a value that indicates whether the date represented by an instance of this class is selected in the Calendar control. This property is read-only.
Public propertyIsTodayGets 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 propertyIsWeekendGets a value that indicates whether the date represented by an instance of this class is a either Saturday or Sunday. This property is read-only.
Top
  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

A CalendarDay object represents a date in the Calendar control. You can use this class in the DayRender event handler to programmatically access the properties of a date as it is rendered on the Calendar control. This allows you to determine the properties of the day (such as whether the date is selectable, selected, today's date, or a weekend date) and programmatically control the appearance or behavior of the day.

For a list of initial property values for an instance of CalendarDay, see the CalendarDay constructor.

The following example demonstrates how to use the properties of a CalendarDay object to determine whether the date being rendered in the DayRender event is in the displayed month and do not fall on Saturday or Sunday. These dates are displayed in yellow. 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.IsOtherMonth && !e.Day.IsWeekend)
            e.Cell.BackColor=System.Drawing.Color.Yellow;

      }

   </script>

</head>

<body>

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

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

   </form>

</body>
</html>
   



<%@ 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 runat="server">
    <title>Calendar DayRender Example</title>
<script runat="server">

      void DayRender(Object sender, DayRenderEventArgs e) 
      {

         // Change the background color of the days in the month
         // to yellow.
         if (!e.Day.IsOtherMonth && !e.Day.IsWeekend)
         {
            e.Cell.BackColor=System.Drawing.Color.Yellow;
         }

         // Add custom text to cell in the Calendar control.
         if (e.Day.Date.Day == 18)
         {
            e.Cell.Controls.Add(new LiteralControl("<br />Holiday"));
         }

      }

      void Page_Load(Object sender, EventArgs e)
      {

         // Manually register the event-handling method for the DayRender  
         // event of the Calendar control.
         Calendar1.DayRender += new DayRenderEventHandler(this.DayRender);

      }

   </script>

</head>

<body>

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

      <h3>Calendar DayRender Example</h3>

      <asp:Calendar id="Calendar1" 
                    runat="server">

         <WeekendDayStyle BackColor="gray">
         </WeekendDayStyle>

      </asp:Calendar>

   </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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.