PersianCalendar Class

 

Represents the Persian calendar.

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

System.Object
  System.Globalization.Calendar
    System.Globalization.PersianCalendar

[SerializableAttribute]
public class PersianCalendar : Calendar

NameDescription
System_CAPS_pubmethodPersianCalendar()

Initializes a new instance of the PersianCalendar class.

NameDescription
System_CAPS_pubpropertyAlgorithmType

Gets a value indicating whether the current calendar is solar-based, lunar-based, or lunisolar-based.(Overrides Calendar.AlgorithmType.)

System_CAPS_protpropertyDaysInYearBeforeMinSupportedYear

Gets the number of days in the year that precedes the year that is specified by the MinSupportedDateTime property.(Inherited from Calendar.)

System_CAPS_pubpropertyEras

Gets the list of eras in a PersianCalendar object.(Overrides Calendar.Eras.)

System_CAPS_pubpropertyIsReadOnly

Gets a value indicating whether this Calendar object is read-only.(Inherited from Calendar.)

System_CAPS_pubpropertyMaxSupportedDateTime

Gets the latest date and time supported by the PersianCalendar class.(Overrides Calendar.MaxSupportedDateTime.)

System_CAPS_pubpropertyMinSupportedDateTime

Gets the earliest date and time supported by the PersianCalendar class.(Overrides Calendar.MinSupportedDateTime.)

System_CAPS_pubpropertyTwoDigitYearMax

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.(Overrides Calendar.TwoDigitYearMax.)

NameDescription
System_CAPS_pubmethodAddDays(DateTime, Int32)

Returns a DateTime that is the specified number of days away from the specified DateTime.(Inherited from Calendar.)

System_CAPS_pubmethodAddHours(DateTime, Int32)

Returns a DateTime that is the specified number of hours away from the specified DateTime.(Inherited from Calendar.)

System_CAPS_pubmethodAddMilliseconds(DateTime, Double)

Returns a DateTime that is the specified number of milliseconds away from the specified DateTime.(Inherited from Calendar.)

System_CAPS_pubmethodAddMinutes(DateTime, Int32)

Returns a DateTime that is the specified number of minutes away from the specified DateTime.(Inherited from Calendar.)

System_CAPS_pubmethodAddMonths(DateTime, Int32)

Returns a DateTime object that is offset the specified number of months from the specified DateTime object.(Overrides Calendar.AddMonths(DateTime, Int32).)

System_CAPS_pubmethodAddSeconds(DateTime, Int32)

Returns a DateTime that is the specified number of seconds away from the specified DateTime.(Inherited from Calendar.)

System_CAPS_pubmethodAddWeeks(DateTime, Int32)

Returns a DateTime that is the specified number of weeks away from the specified DateTime.(Inherited from Calendar.)

System_CAPS_pubmethodAddYears(DateTime, Int32)

Returns a DateTime object that is offset the specified number of years from the specified DateTime object.(Overrides Calendar.AddYears(DateTime, Int32).)

System_CAPS_pubmethodClone()

Creates a new object that is a copy of the current Calendar object.(Inherited from Calendar.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetDayOfMonth(DateTime)

Returns the day of the month in the specified DateTime object.(Overrides Calendar.GetDayOfMonth(DateTime).)

System_CAPS_pubmethodGetDayOfWeek(DateTime)

Returns the day of the week in the specified DateTime object.(Overrides Calendar.GetDayOfWeek(DateTime).)

System_CAPS_pubmethodGetDayOfYear(DateTime)

Returns the day of the year in the specified DateTime object.(Overrides Calendar.GetDayOfYear(DateTime).)

System_CAPS_pubmethodGetDaysInMonth(Int32, Int32)

Returns the number of days in the specified month and year of the current era.(Inherited from Calendar.)

System_CAPS_pubmethodGetDaysInMonth(Int32, Int32, Int32)

Returns the number of days in the specified month of the specified year and era.(Overrides Calendar.GetDaysInMonth(Int32, Int32, Int32).)

System_CAPS_pubmethodGetDaysInYear(Int32)

Returns the number of days in the specified year of the current era.(Inherited from Calendar.)

System_CAPS_pubmethodGetDaysInYear(Int32, Int32)

Returns the number of days in the specified year of the specified era.(Overrides Calendar.GetDaysInYear(Int32, Int32).)

System_CAPS_pubmethodGetEra(DateTime)

Returns the era in the specified DateTime object.(Overrides Calendar.GetEra(DateTime).)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetHour(DateTime)

Returns the hours value in the specified DateTime.(Inherited from Calendar.)

System_CAPS_pubmethodGetLeapMonth(Int32)

Calculates the leap month for a specified year.(Inherited from Calendar.)

System_CAPS_pubmethodGetLeapMonth(Int32, Int32)

Returns the leap month for a specified year and era.(Overrides Calendar.GetLeapMonth(Int32, Int32).)

System_CAPS_pubmethodGetMilliseconds(DateTime)

Returns the milliseconds value in the specified DateTime.(Inherited from Calendar.)

System_CAPS_pubmethodGetMinute(DateTime)

Returns the minutes value in the specified DateTime.(Inherited from Calendar.)

System_CAPS_pubmethodGetMonth(DateTime)

Returns the month in the specified DateTime object.(Overrides Calendar.GetMonth(DateTime).)

System_CAPS_pubmethodGetMonthsInYear(Int32)

Returns the number of months in the specified year in the current era.(Inherited from Calendar.)

System_CAPS_pubmethodGetMonthsInYear(Int32, Int32)

Returns the number of months in the specified year of the specified era.(Overrides Calendar.GetMonthsInYear(Int32, Int32).)

System_CAPS_pubmethodGetSecond(DateTime)

Returns the seconds value in the specified DateTime.(Inherited from Calendar.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetWeekOfYear(DateTime, CalendarWeekRule, DayOfWeek)

Returns the week of the year that includes the date in the specified DateTime value.(Inherited from Calendar.)

System_CAPS_pubmethodGetYear(DateTime)

Returns the year in the specified DateTime object.(Overrides Calendar.GetYear(DateTime).)

System_CAPS_pubmethodIsLeapDay(Int32, Int32, Int32)

Determines whether the specified date in the current era is a leap day.(Inherited from Calendar.)

System_CAPS_pubmethodIsLeapDay(Int32, Int32, Int32, Int32)

Determines whether the specified date is a leap day.(Overrides Calendar.IsLeapDay(Int32, Int32, Int32, Int32).)

System_CAPS_pubmethodIsLeapMonth(Int32, Int32)

Determines whether the specified month in the specified year in the current era is a leap month.(Inherited from Calendar.)

System_CAPS_pubmethodIsLeapMonth(Int32, Int32, Int32)

Determines whether the specified month in the specified year and era is a leap month.(Overrides Calendar.IsLeapMonth(Int32, Int32, Int32).)

System_CAPS_pubmethodIsLeapYear(Int32)

Determines whether the specified year in the current era is a leap year.(Inherited from Calendar.)

System_CAPS_pubmethodIsLeapYear(Int32, Int32)

Determines whether the specified year in the specified era is a leap year.(Overrides Calendar.IsLeapYear(Int32, Int32).)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToDateTime(Int32, Int32, Int32, Int32, Int32, Int32, Int32)

Returns a DateTime that is set to the specified date and time in the current era.(Inherited from Calendar.)

System_CAPS_pubmethodToDateTime(Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32)

Returns a DateTime object that is set to the specified date, time, and era.(Overrides Calendar.ToDateTime(Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32).)

System_CAPS_pubmethodToFourDigitYear(Int32)

Converts the specified year to a four-digit year representation.(Overrides Calendar.ToFourDigitYear(Int32).)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticPersianEra

Represents the current era. This field is constant.

The Persian calendar is used in most countries where Persian is spoken, although some regions use different month names. The Persian calendar is the official calendar of Iran and Afghanistan, and it is one of the alternative calendars in regions such as Kazakhstan and Tajikistan.

System_CAPS_noteNote

For information about using the PersianCalendar class and the other calendar classes in the .NET Framework, see Working with Calendars.

Dates in the Persian calendar start from the year of the Hijra, which corresponds to 622 C.E. and is the year when Muhammad (PBUH) migrated from Mecca to Medina. For example, the date March 21, 2002 C.E. corresponds to the first day of the month of Farvardeen in the year 1381 Anno Persico.

The Persian calendar is based on a solar year and is approximately 365 days long. A year cycles through four seasons, and a new year begins when the sun appears to cross the equator from the southern hemisphere to the northern hemisphere as viewed from the center of the Earth. The new year marks the first day of the month of Farvardeen, which is the first day of spring in the northern hemisphere.

Each of the first six months in the Persian calendar has 31 days, each of the next five months has 30 days, and the last month has 29 days in a common year and 30 days in a leap year. A leap year is a year that, when divided by 33, has a remainder of 1, 5, 9, 13, 17, 22, 26, or 30. For example, the year 1370 is a leap year because dividing it by 33 yields a remainder of 17. There are approximately eight leap years in every 33-year cycle.

Starting with the .NET Framework 4.6, the PersianCalendar class uses the Hijri solar astronomical algorithm rather than an observational algorithm to calculate dates. This makes the PersianCalendar implementation consistent with the Persian calendar in use in Iran and Afghanistan, the two countries in which the Persian calendar is in most widespread use. The change affects all apps running on the .NET Framework 4 or later if the .NET Framework 4.6 is installed.

As a result of the changed algorithm:

  • The two algorithms should return identical results when converting dates between 1800 and 2123 in the Gregorian calendar.

  • The two algorithms may return different results when converting dates before 1800 and after 2123 in the Gregorian calendar.

  • The MinSupportedDateTime property value has changed from March 21, 0622 in the Gregorian calendar to March 22, 0622 in the Gregorian calendar.

  • The MaxSupportedDateTime property value has changed from the 10th day of the 10th month of the year 9378 in the Persian calendar to the 13th day of the 10th month of the year 9378 in the Persian calendar.

  • The IsLeapYear method may return a different result than it did previously.

Applications use a PersianCalendar object to calculate dates in the Persian calendar or convert Persian dates to and from Gregorian dates.

You cannot use a PersianCalendar object as the default calendar for a culture. The default calendar is specified by the CultureInfo.Calendar property and must be one of the calendars returned by the CultureInfo.OptionalCalendars property. Currently, the PersianCalendar class is not an optional calendar for any culture supported by the CultureInfo class and consequently cannot be a default calendar.

The following example instantiates DateTime objects by using the DateTime.Now property, a DateTime constructor, and the Persian calendar's ToDateTime(Int32, Int32, Int32, Int32, Int32, Int32, Int32) method. It then displays these dates in both the Gregorian and Persian calendars. It also displays the date range of the Persian calendar.

using System;
using System.Globalization;

public class Example
{
   public static void Main()
   {
        PersianCalendar pc = new PersianCalendar();
        DateTime thisDate = DateTime.Now;

        // Display the current date using the Gregorian and Persian calendars. 
        Console.WriteLine("Today in the Gregorian Calendar:  {0:dddd}, {0}", thisDate);
        Console.WriteLine("Today in the Persian Calendar:    {0}, {1}/{2}/{3} {4}:{5}:{6}\n",  
                      pc.GetDayOfWeek(thisDate), 
                      pc.GetMonth(thisDate), 
                      pc.GetDayOfMonth(thisDate),  
                      pc.GetYear(thisDate), 
                      pc.GetHour(thisDate), 
                      pc.GetMinute(thisDate), 
                      pc.GetSecond(thisDate));

        // Create a date using the Gregorian calendar.
        thisDate = new DateTime(2013, 5, 28, 10, 35, 0);
        Console.WriteLine("Gregorian Calendar:  {0:D} ", thisDate);
        Console.WriteLine("Persian Calendar:    {0}, {1}/{2}/{3} {4}:{5}:{6}\n",  
                          pc.GetDayOfWeek(thisDate), 
                          pc.GetMonth(thisDate), 
                          pc.GetDayOfMonth(thisDate),  
                          pc.GetYear(thisDate), 
                          pc.GetHour(thisDate), 
                          pc.GetMinute(thisDate), 
                          pc.GetSecond(thisDate));

        // Create a date using the Persian calendar.
        thisDate = pc.ToDateTime(1395, 4, 22, 12, 30, 0, 0);
        Console.WriteLine("Gregorian Calendar:  {0:D} ", thisDate);
        Console.WriteLine("Persian Calendar:    {0}, {1}/{2}/{3} {4}:{5}:{6}\n",  
                      pc.GetDayOfWeek(thisDate), 
                      pc.GetMonth(thisDate), 
                      pc.GetDayOfMonth(thisDate),  
                      pc.GetYear(thisDate), 
                      pc.GetHour(thisDate), 
                      pc.GetMinute(thisDate), 
                      pc.GetSecond(thisDate));

        // Show the Persian Calendar date range.
        Console.WriteLine("Minimum Persian Calendar date (Gregorian Calendar):  {0:D} ", 
                          pc.MinSupportedDateTime);
        Console.WriteLine("Minimum Persian Calendar date (Persian Calendar):  " +    
                          "{0}, {1}/{2}/{3} {4}:{5}:{6}\n",  
                          pc.GetDayOfWeek(pc.MinSupportedDateTime), 
                          pc.GetMonth(pc.MinSupportedDateTime), 
                          pc.GetDayOfMonth(pc.MinSupportedDateTime),  
                          pc.GetYear(pc.MinSupportedDateTime), 
                          pc.GetHour(pc.MinSupportedDateTime), 
                          pc.GetMinute(pc.MinSupportedDateTime), 
                          pc.GetSecond(pc.MinSupportedDateTime));

        Console.WriteLine("Maximum Persian Calendar date (Gregorian Calendar):  {0:D} ", 
                          pc.MaxSupportedDateTime);
        Console.WriteLine("Maximum Persian Calendar date (Persian Calendar):  " +   
                          "{0}, {1}/{2}/{3} {4}:{5}:{6}\n",  
                          pc.GetDayOfWeek(pc.MaxSupportedDateTime), 
                          pc.GetMonth(pc.MaxSupportedDateTime), 
                          pc.GetDayOfMonth(pc.MaxSupportedDateTime),  
                          pc.GetYear(pc.MaxSupportedDateTime), 
                          pc.GetHour(pc.MinSupportedDateTime), 
                          pc.GetMinute(pc.MaxSupportedDateTime), 
                          pc.GetSecond(pc.MaxSupportedDateTime));
   }
}
// The example displays the following output when run under the .NET Framework 4.6:
//    Today in the Gregorian Calendar:  Monday, 2/4/2013 9:11:36 AM
//    Today in the Persian Calendar:    Monday, 11/16/1391 9:11:36
//
//    Gregorian Calendar:  Tuesday, May 28, 2013
//    Persian Calendar:    Tuesday, 3/7/1392 10:35:0
//
//    Gregorian Calendar:  Tuesday, July 12, 2016
//    Persian Calendar:    Tuesday, 4/22/1395 12:30:0
//
//    Minimum Persian Calendar date (Gregorian Calendar):  Friday, March 22, 0622
//    Minimum Persian Calendar date (Persian Calendar):  Friday, 1/1/1 0:0:0
//
//    Maximum Persian Calendar date (Gregorian Calendar):  Friday, December 31, 9999
//    Maximum Persian Calendar date (Persian Calendar):  Friday, 10/13/9378 0:59:59
//
// The example displays the following output when run under versions of
// the .NET Framework before the .NET Framework 4.6:
//    Today in the Gregorian Calendar:  Monday, 2/4/2013 9:11:36 AM
//    Today in the Persian Calendar:    Monday, 11/16/1391 9:11:36
//    
//    Gregorian Calendar:  Tuesday, May 28, 2013
//    Persian Calendar:    Tuesday, 3/7/1392 10:35:0
//    
//    Gregorian Calendar:  Tuesday, July 12, 2016
//    Persian Calendar:    Tuesday, 4/22/1395 12:30:0
//    
//    Minimum Persian Calendar date (Gregorian Calendar):  Thursday, March 21, 0622
//    Minimum Persian Calendar date (Persian Calendar):  Thursday, 1/1/1 0:0:0
//    
//    Maximum Persian Calendar date (Gregorian Calendar):  Friday, December 31, 9999
//    Maximum Persian Calendar date (Persian Calendar):  Friday, 10/10/9378 0:59:59

The following example demonstrates the field, property, and method members of the PersianCalendar class.

using System;
using System.Globalization;

class Sample 
{
    public static void Main() 
    {
      PersianCalendar jc = new PersianCalendar();
      DateTime thisDate = DateTime.Now;

		//--------------------------------------------------------------------------------
		// Properties
		//--------------------------------------------------------------------------------
      Console.WriteLine("\n........... Selected Properties .....................\n");
      Console.Write("Eras:");
      foreach (int era in jc.Eras)
      {
         Console.WriteLine(" era = {0}", era);
      }
		//--------------------------------------------------------------------------------
      Console.WriteLine("\nTwoDigitYearMax = {0}", jc.TwoDigitYearMax);
		//--------------------------------------------------------------------------------
		// Methods
		//--------------------------------------------------------------------------------
      Console.WriteLine("\n............ Selected Methods .......................\n");

		//--------------------------------------------------------------------------------
      Console.WriteLine("GetDayOfYear: day = {0}", jc.GetDayOfYear(thisDate));
		//--------------------------------------------------------------------------------
      Console.WriteLine("GetDaysInMonth: days = {0}", 
                        jc.GetDaysInMonth( thisDate.Year, thisDate.Month, 
                        PersianCalendar.PersianEra));
		//--------------------------------------------------------------------------------
      Console.WriteLine("GetDaysInYear: days = {0}", 
                        jc.GetDaysInYear(thisDate.Year, PersianCalendar.PersianEra));
		//--------------------------------------------------------------------------------
      Console.WriteLine("GetLeapMonth: leap month (if any) = {0}", 
                        jc.GetLeapMonth(thisDate.Year, PersianCalendar.PersianEra));
		//-------------------------------------------------------------
      Console.WriteLine("GetMonthsInYear: months in a year = {0}", 
                        jc.GetMonthsInYear(thisDate.Year, PersianCalendar.PersianEra));
		//--------------------------------------------------------------------------------
      Console.WriteLine("IsLeapDay: This is a leap day = {0}", 
                        jc.IsLeapDay(thisDate.Year, thisDate.Month, thisDate.Day, 
                        PersianCalendar.PersianEra));
		//--------------------------------------------------------------------------------
      Console.WriteLine("IsLeapMonth: This is a leap month = {0}", 
                        jc.IsLeapMonth(thisDate.Year, thisDate.Month, 
                        PersianCalendar.PersianEra));
		//--------------------------------------------------------------------------------
      Console.WriteLine("IsLeapYear: 1370 is a leap year = {0}", 
                        jc.IsLeapYear(1370, PersianCalendar.PersianEra));
		//--------------------------------------------------------------------------------

		// Get the 4-digit year for a year whose last two digits are 99. The 4-digit year 
		// depends on the current value of the TwoDigitYearMax property.

      Console.WriteLine("ToFourDigitYear:");
      Console.WriteLine("  If TwoDigitYearMax = {0}, ToFourDigitYear(99) = {1}", 
                         jc.TwoDigitYearMax, jc.ToFourDigitYear(99));
      jc.TwoDigitYearMax = thisDate.Year;
      Console.WriteLine("  If TwoDigitYearMax = {0}, ToFourDigitYear(99) = {1}", 
                        jc.TwoDigitYearMax, jc.ToFourDigitYear(99));
    }
}
// The example displays the following output:
//       ........... Selected Properties .....................
//       
//       Eras: era = 1
//       
//       TwoDigitYearMax = 99
//       
//       ............ Selected Methods .......................
//       
//       GetDayOfYear: day = 1
//       GetDaysInMonth: days = 31
//       GetDaysInYear: days = 365
//       GetLeapMonth: leap month (if any) = 0
//       GetMonthsInYear: months in a year = 12
//       IsLeapDay: This is a leap day = False
//       IsLeapMonth: This is a leap month = False
//       IsLeapYear: 1370 is a leap year = True
//       ToFourDigitYear:
//         If TwoDigitYearMax = 99, ToFourDigitYear(99) = 99
//         If TwoDigitYearMax = 2012, ToFourDigitYear(99) = 1999

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Silverlight
Available since 5.0

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

Return to top
Show: