Calendar Class[MSDN]

Link : http://msdn.microsoft.com/en-us/library/system.globalization.calendar(v=vs.110).aspx

Calendar Class

.NET Framework 4.5

Other Versions

1 out of 5 rated this helpful - Rate this topic

Represents time in divisions, such as weeks, months, and years.

Inheritance Hierarchy

System.Object 
  System.Globalization.Calendar
    More...

Namespace:  System.Globalization
Assembly:  mscorlib (in mscorlib.dll)

Syntax

C#

C++

F#

VB

[SerializableAttribute]
[ComVisibleAttribute(true)]
public abstract class Calendar : ICloneable

The Calendar type exposes the following members.

Constructors

Show: Inherited Protected

	Name	Description
	Calendar	Initializes a new instance of the Calendar class.

Top

Properties

Show: Inherited Protected

	Name	Description
	AlgorithmType	Gets a value indicating whether the current calendar is solar-based, lunar-based, or a combination of both.
	DaysInYearBeforeMinSupportedYear	Gets the number of days in the year that precedes the year that is specified by theMinSupportedDateTime property.
	Eras	When overridden in a derived class, gets the list of eras in the current calendar.
	IsReadOnly	Gets a value indicating whether this Calendar object is read-only.
	MaxSupportedDateTime	Gets the latest date and time supported by thisCalendar object.
	MinSupportedDateTime	Gets the earliest date and time supported by thisCalendar object.
	TwoDigitYearMax	Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Top

Methods

Show: Inherited Protected

	Name	Description
	AddDays	Returns a DateTime that is the specified number of days away from the specified DateTime.
	AddHours	Returns a DateTime that is the specified number of hours away from the specified DateTime.
	AddMilliseconds	Returns a DateTime that is the specified number of milliseconds away from the specified DateTime.
	AddMinutes	Returns a DateTime that is the specified number of minutes away from the specified DateTime.
	AddMonths	When overridden in a derived class, returns a DateTime that is the specified number of months away from the specifiedDateTime.
	AddSeconds	Returns a DateTime that is the specified number of seconds away from the specified DateTime.
	AddWeeks	Returns a DateTime that is the specified number of weeks away from the specified DateTime.
	AddYears	When overridden in a derived class, returns a DateTime that is the specified number of years away from the specifiedDateTime.
	Clone	Creates a new object that is a copy of the current Calendarobject.
	Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetDayOfMonth	When overridden in a derived class, returns the day of the month in the specified DateTime.
	GetDayOfWeek	When overridden in a derived class, returns the day of the week in the specified DateTime.
	GetDayOfYear	When overridden in a derived class, returns the day of the year in the specified DateTime.
	GetDaysInMonth(Int32, Int32)	Returns the number of days in the specified month and year of the current era.
	GetDaysInMonth(Int32, Int32, Int32)	When overridden in a derived class, returns the number of days in the specified month, year, and era.
	GetDaysInYear(Int32)	Returns the number of days in the specified year of the current era.
	GetDaysInYear(Int32, Int32)	When overridden in a derived class, returns the number of days in the specified year and era.
	GetEra	When overridden in a derived class, returns the era in the specified DateTime.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetHour	Returns the hours value in the specified DateTime.
	GetLeapMonth(Int32)	Calculates the leap month for a specified year.
	GetLeapMonth(Int32, Int32)	Calculates the leap month for a specified year and era.
	GetMilliseconds	Returns the milliseconds value in the specified DateTime.
	GetMinute	Returns the minutes value in the specified DateTime.
	GetMonth	When overridden in a derived class, returns the month in the specified DateTime.
	GetMonthsInYear(Int32)	Returns the number of months in the specified year in the current era.
	GetMonthsInYear(Int32, Int32)	When overridden in a derived class, returns the number of months in the specified year in the specified era.
	GetSecond	Returns the seconds value in the specified DateTime.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetWeekOfYear	Returns the week of the year that includes the date in the specified DateTime value.
	GetYear	When overridden in a derived class, returns the year in the specified DateTime.
	IsLeapDay(Int32, Int32, Int32)	Determines whether the specified date in the current era is a leap day.
	IsLeapDay(Int32, Int32, Int32, Int32)	When overridden in a derived class, determines whether the specified date in the specified era is a leap day.
	IsLeapMonth(Int32, Int32)	Determines whether the specified month in the specified year in the current era is a leap month.
	IsLeapMonth(Int32, Int32, Int32)	When overridden in a derived class, determines whether the specified month in the specified year in the specified era is a leap month.
	IsLeapYear(Int32)	Determines whether the specified year in the current era is a leap year.
	IsLeapYear(Int32, Int32)	When overridden in a derived class, determines whether the specified year in the specified era is a leap year.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited fromObject.)
	ReadOnly	Returns a read-only version of the specified Calendar object.
	ToDateTime(Int32, Int32, Int32, Int32, Int32, Int32, Int32)	Returns a DateTime that is set to the specified date and time in the current era.
	ToDateTime(Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32)	When overridden in a derived class, returns a DateTime that is set to the specified date and time in the specified era.
	ToFourDigitYear	Converts the specified year to a four-digit year by using theTwoDigitYearMax property to determine the appropriate century.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

Show: Inherited Protected

	Name	Description
	CurrentEra	Represents the current era of the current calendar.

Top

Remarks

A calendar divides time into units, such as weeks, months, and years. The number, length, and start of the divisions vary in each calendar.

Note
For information about using the calendar classes in the .NET Framework, see Working with Calendars.

Any moment in time can be represented as a set of numeric values using a particular calendar. For example, a vernal equinox occurred at (1999, 3, 20, 8, 46, 0, 0.0) in the Gregorian calendar, that is, March 20, 1999 C.E. at 8:46:00:0.0. An implementation of Calendar can map any date in the range of a specific calendar to a similar set of numeric values, and DateTime can map such sets of numeric values to a textual representation using information from Calendar and DateTimeFormatInfo. The textual representation can be culture-sensitive, for example, "8:46 AM March 20th 1999 AD" for the en-US culture, or culture-insensitive, for example, "1999-03-20T08:46:00" in ISO 8601 format.

A Calendar implementation can define one or more eras. The Calendar class identifies the eras as enumerated integers, where the current era (CurrentEra) has the value 0.

To make up for the difference between the calendar year and the actual time that the earth rotates around the sun or the actual time that the moon rotates around the earth, a leap year has a different number of days from a standard calendar year. Each Calendar implementation defines leap years differently.

For consistency, the first unit in each interval (the first month, for example) is assigned the value 1.

The System.Globalization namespace includes the following Calendar implementations:

• ChineseLunisolarCalendar

• EastAsianLunisolarCalendar

• GregorianCalendar

• HebrewCalendar

• HijriCalendar

• JapaneseCalendar

• JapaneseLunisolarCalendar

• JulianCalendar

• KoreanCalendar

• KoreanLunisolarCalendar

• PersianCalendar

• TaiwanCalendar

• TaiwanLunisolarCalendar

• ThaiBuddhistCalendar

• UmAlQuraCalendar

Examples

The following code example demonstrates the members of the Calendar class.

C#

C++

VB

using System;
using System.Globalization;


public class SamplesCalendar  {

   public static void Main()  {

      // Sets a DateTime to April 3, 2002 of the Gregorian calendar.
      DateTime myDT = new DateTime( 2002, 4, 3, new GregorianCalendar() );

      // Uses the default calendar of the InvariantCulture.
      Calendar myCal = CultureInfo.InvariantCulture.Calendar;

      // Displays the values of the DateTime.
      Console.WriteLine( "April 3, 2002 of the Gregorian calendar:" );
      DisplayValues( myCal, myDT );

      // Adds 5 to every component of the DateTime.
      myDT = myCal.AddYears( myDT, 5 );
      myDT = myCal.AddMonths( myDT, 5 );
      myDT = myCal.AddWeeks( myDT, 5 );
      myDT = myCal.AddDays( myDT, 5 );
      myDT = myCal.AddHours( myDT, 5 );
      myDT = myCal.AddMinutes( myDT, 5 );
      myDT = myCal.AddSeconds( myDT, 5 );
      myDT = myCal.AddMilliseconds( myDT, 5 );

      // Displays the values of the DateTime.
      Console.WriteLine( "After adding 5 to each component of the DateTime:" );
      DisplayValues( myCal, myDT );

   }

   public static void DisplayValues( Calendar myCal, DateTime myDT )  {
      Console.WriteLine( "   Era:          {0}", myCal.GetEra( myDT ) );
      Console.WriteLine( "   Year:         {0}", myCal.GetYear( myDT ) );
      Console.WriteLine( "   Month:        {0}", myCal.GetMonth( myDT ) );
      Console.WriteLine( "   DayOfYear:    {0}", myCal.GetDayOfYear( myDT ) );
      Console.WriteLine( "   DayOfMonth:   {0}", myCal.GetDayOfMonth( myDT ) );
      Console.WriteLine( "   DayOfWeek:    {0}", myCal.GetDayOfWeek( myDT ) );
      Console.WriteLine( "   Hour:         {0}", myCal.GetHour( myDT ) );
      Console.WriteLine( "   Minute:       {0}", myCal.GetMinute( myDT ) );
      Console.WriteLine( "   Second:       {0}", myCal.GetSecond( myDT ) );
      Console.WriteLine( "   Milliseconds: {0}", myCal.GetMilliseconds( myDT ) );
      Console.WriteLine();
   }

}


/*
This code produces the following output.

April 3, 2002 of the Gregorian calendar:
   Era:          1
   Year:         2002
   Month:        4
   DayOfYear:    93
   DayOfMonth:   3
   DayOfWeek:    Wednesday
   Hour:         0
   Minute:       0
   Second:       0
   Milliseconds: 0

After adding 5 to each component of the DateTime:
   Era:          1
   Year:         2007
   Month:        10
   DayOfYear:    286
   DayOfMonth:   13
   DayOfWeek:    Saturday
   Hour:         5
   Minute:       5
   Second:       5
   Milliseconds: 5

*/

Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Platforms

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Globalization Namespace

DateTime

DateTimeFormatInfo

ChineseLunisolarCalendar

EastAsianLunisolarCalendar

GregorianCalendar

HebrewCalendar

HijriCalendar

JapaneseCalendar

JapaneseLunisolarCalendar

JulianCalendar

KoreanCalendar

KoreanLunisolarCalendar

PersianCalendar

TaiwanCalendar

TaiwanLunisolarCalendar

ThaiBuddhistCalendar

UmAlQuraCalendar

Other Resources

Working with Calendars

Sample: Calendar Week Range Utility

Inheritance Hierarchy

System.Object
  System.Globalization.Calendar
    System.Globalization.EastAsianLunisolarCalendar
    System.Globalization.GregorianCalendar
    System.Globalization.HebrewCalendar
    System.Globalization.HijriCalendar
    System.Globalization.JapaneseCalendar
    System.Globalization.JulianCalendar
    System.Globalization.KoreanCalendar
    System.Globalization.PersianCalendar
    System.Globalization.TaiwanCalendar
    System.Globalization.ThaiBuddhistCalendar
    System.Globalization.UmAlQuraCalendar