PersianCalendar Class

Represents the Persian calendar.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class PersianCalendar _
    Inherits Calendar
public class PersianCalendar : Calendar

The PersianCalendar type exposes the following members.

Constructors

  Name Description
Public method PersianCalendar Initializes a new instance of the PersianCalendar class.

Top

Properties

  Name Description
Public property Eras Gets the list of eras in a PersianCalendar object. (Overrides Calendar.Eras.)
Public property IsReadOnly Gets a value indicating whether this Calendar object is read-only. (Inherited from Calendar.)
Public property MaxSupportedDateTime Gets the latest date and time supported by the PersianCalendar class. (Overrides Calendar.MaxSupportedDateTime.)
Public property MinSupportedDateTime Gets the earliest date and time supported by the PersianCalendar class. (Overrides Calendar.MinSupportedDateTime.)
Public property TwoDigitYearMax Gets or sets the last year of a 100-year range that can be represented by a 2-digit year. (Overrides Calendar.TwoDigitYearMax.)

Top

Methods

  Name Description
Public method AddDays Returns a DateTime that is the specified number of days away from the specified DateTime. (Inherited from Calendar.)
Public method AddHours Returns a DateTime that is the specified number of hours away from the specified DateTime. (Inherited from Calendar.)
Public method AddMilliseconds Returns a DateTime that is the specified number of milliseconds away from the specified DateTime. (Inherited from Calendar.)
Public method AddMinutes Returns a DateTime that is the specified number of minutes away from the specified DateTime. (Inherited from Calendar.)
Public method AddMonths Returns a DateTime object that is offset the specified number of months from the specified DateTime object. (Overrides Calendar.AddMonths(DateTime, Int32).)
Public method AddSeconds Returns a DateTime that is the specified number of seconds away from the specified DateTime. (Inherited from Calendar.)
Public method AddWeeks Returns a DateTime that is the specified number of weeks away from the specified DateTime. (Inherited from Calendar.)
Public method AddYears Returns a DateTime object that is offset the specified number of years from the specified DateTime object. (Overrides Calendar.AddYears(DateTime, Int32).)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method GetDayOfMonth Returns the day of the month in the specified DateTime object. (Overrides Calendar.GetDayOfMonth(DateTime).)
Public method GetDayOfWeek Returns the day of the week in the specified DateTime object. (Overrides Calendar.GetDayOfWeek(DateTime).)
Public method GetDayOfYear Returns the day of the year in the specified DateTime object. (Overrides Calendar.GetDayOfYear(DateTime).)
Public method GetDaysInMonth(Int32, Int32) Returns the number of days in the specified month and year of the current era. (Inherited from Calendar.)
Public method GetDaysInMonth(Int32, Int32, Int32) Returns the number of days in the specified month of the specified year and era. (Overrides Calendar.GetDaysInMonth(Int32, Int32, Int32).)
Public method GetDaysInYear(Int32) Returns the number of days in the specified year of the current era. (Inherited from Calendar.)
Public method GetDaysInYear(Int32, Int32) Returns the number of days in the specified year of the specified era. (Overrides Calendar.GetDaysInYear(Int32, Int32).)
Public method GetEra Returns the era in the specified DateTime object. (Overrides Calendar.GetEra(DateTime).)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetHour Returns the hours value in the specified DateTime. (Inherited from Calendar.)
Public method GetLeapMonth Returns the leap month for a specified year and era. (Overrides Calendar.GetLeapMonth(Int32, Int32).)
Public method GetMilliseconds Returns the milliseconds value in the specified DateTime. (Inherited from Calendar.)
Public method GetMinute Returns the minutes value in the specified DateTime. (Inherited from Calendar.)
Public method GetMonth Returns the month in the specified DateTime object. (Overrides Calendar.GetMonth(DateTime).)
Public method GetMonthsInYear(Int32) Returns the number of months in the specified year in the current era. (Inherited from Calendar.)
Public method GetMonthsInYear(Int32, Int32) Returns the number of months in the specified year of the specified era. (Overrides Calendar.GetMonthsInYear(Int32, Int32).)
Public method GetSecond Returns the seconds value in the specified DateTime. (Inherited from Calendar.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetWeekOfYear Returns the week of the year that includes the date in the specified DateTime value. (Inherited from Calendar.)
Public method GetYear Returns the year in the specified DateTime object. (Overrides Calendar.GetYear(DateTime).)
Public method IsLeapDay(Int32, Int32, Int32) Determines whether the specified date in the current era is a leap day. (Inherited from Calendar.)
Public method IsLeapDay(Int32, Int32, Int32, Int32) Determines whether the specified date is a leap day. (Overrides Calendar.IsLeapDay(Int32, Int32, Int32, Int32).)
Public method IsLeapMonth(Int32, Int32) Determines whether the specified month in the specified year in the current era is a leap month. (Inherited from Calendar.)
Public method IsLeapMonth(Int32, Int32, Int32) Determines whether the specified month in the specified year and era is a leap month. (Overrides Calendar.IsLeapMonth(Int32, Int32, Int32).)
Public method IsLeapYear(Int32) Determines whether the specified year in the current era is a leap year. (Inherited from Calendar.)
Public method IsLeapYear(Int32, Int32) Determines whether the specified year in the specified era is a leap year. (Overrides Calendar.IsLeapYear(Int32, Int32).)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToDateTime(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.)
Public method ToDateTime(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).)
Public method ToFourDigitYear Converts the specified year to a four-digit year representation. (Overrides Calendar.ToFourDigitYear(Int32).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

  Name Description
Public fieldStatic member PersianEra Represents the current era. This field is constant.

Top

Remarks

The Persian calendar is used in most countries or regions 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 countries/regions such as Kazakhstan and Tajikistan.

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.

Using the PersianCalendar

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

Your application should not 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.

Examples

The following example demonstrates the fields, properties, and methods of the PersianCalendar class.

using System;
using System.Globalization;

class Example
{
    public static void Demo(System.Windows.Controls.TextBlock outputBlock) 
    {
        //--------------------------------------------------------------------------------
        // Get today's date.
        //--------------------------------------------------------------------------------
      outputBlock.Text += "\n................. Today ...........................\n";
      PersianCalendar jc = new PersianCalendar();
      DateTime thisDate = DateTime.Now;

        // Display the current date using the Gregorian and Persian calendars.
      outputBlock.Text += "Today is:\n";
      outputBlock.Text += String.Format("   {0:dddd}, {0} in the Gregorian calendar.\n", thisDate);
      outputBlock.Text += String.Format("   {0}, {1}/{2}/{3} {4}:{5}:{6} in the Persian calendar.\n", 
                                        jc.GetDayOfWeek(thisDate), 
                                        jc.GetMonth(thisDate), 
                                        jc.GetDayOfMonth(thisDate), 
                                        jc.GetYear(thisDate), 
                                        jc.GetHour(thisDate), 
                                        jc.GetMinute(thisDate), 
                                        jc.GetSecond(thisDate));
        //--------------------------------------------------------------------------------
        // Fields
        //--------------------------------------------------------------------------------
      outputBlock.Text += "\n............... Fields .............................\n";
      outputBlock.Text += String.Format("PersianEra = {0}\n", PersianCalendar.PersianEra);
        //--------------------------------------------------------------------------------
        // Properties
        //--------------------------------------------------------------------------------
      outputBlock.Text += "\n............... Properties .........................\n";
      outputBlock.Text += "Eras:";
      foreach (int era in jc.Eras)
      {
         outputBlock.Text += String.Format(" era = {0}\n", era);
      }
        //--------------------------------------------------------------------------------
      outputBlock.Text += "\nGregorian Date Range Supported by the Persian Calendar:\n";
      outputBlock.Text += String.Format("   From {0:G}\n", jc.MinSupportedDateTime);
      outputBlock.Text += String.Format("   To {0:G}\n", jc.MaxSupportedDateTime);
        //--------------------------------------------------------------------------------
      outputBlock.Text += String.Format("\nTwoDigitYearMax = {0}\n", jc.TwoDigitYearMax);
        //--------------------------------------------------------------------------------
        // Methods
        //--------------------------------------------------------------------------------
      outputBlock.Text += "\n............ Selected Methods .......................\n";

        //--------------------------------------------------------------------------------
      outputBlock.Text += String.Format("GetDayOfYear: day = {0}\n", jc.GetDayOfYear(thisDate));
        //--------------------------------------------------------------------------------
      outputBlock.Text += String.Format("GetDaysInMonth: days = {0}\n", 
                                        jc.GetDaysInMonth( thisDate.Year, thisDate.Month, 
                                        PersianCalendar.PersianEra));
        //--------------------------------------------------------------------------------
      outputBlock.Text += String.Format("GetDaysInYear: days = {0}\n", 
                        jc.GetDaysInYear(thisDate.Year, PersianCalendar.PersianEra));
        //--------------------------------------------------------------------------------
      outputBlock.Text += String.Format("GetLeapMonth: leap month (if any) = {0}\n", 
                        jc.GetLeapMonth(thisDate.Year, PersianCalendar.PersianEra));
        //-------------------------------------------------------------
      outputBlock.Text += String.Format("GetMonthsInYear: months in a year = {0}\n", 
                        jc.GetMonthsInYear(thisDate.Year, PersianCalendar.PersianEra));
        //--------------------------------------------------------------------------------
      outputBlock.Text += String.Format("IsLeapDay: This is a leap day = {0}\n", 
                        jc.IsLeapDay(thisDate.Year, thisDate.Month, thisDate.Day, 
                        PersianCalendar.PersianEra));
        //--------------------------------------------------------------------------------
      outputBlock.Text += String.Format("IsLeapMonth: This is a leap month = {0}\n", 
                        jc.IsLeapMonth(thisDate.Year, thisDate.Month, 
                        PersianCalendar.PersianEra));
        //--------------------------------------------------------------------------------
      outputBlock.Text += String.Format("IsLeapYear: 1370 is a leap year = {0}\n", 
                        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.

      outputBlock.Text += "ToFourDigitYear:\n";
      outputBlock.Text += String.Format("  If TwoDigitYearMax = {0}, ToFourDigitYear(99) = {1}\n", 
                         jc.TwoDigitYearMax, jc.ToFourDigitYear(99));
      jc.TwoDigitYearMax = thisDate.Year;
      outputBlock.Text += String.Format("  If TwoDigitYearMax = {0}, ToFourDigitYear(99) = {1}\n", 
                        jc.TwoDigitYearMax, jc.ToFourDigitYear(99));
    }
}
/*
The example produces the following results:

................. Today ...........................

Today is Wednesday, 6/14/2006 11:31:13 AM

............... Fields .............................

PersianEra = 1

............... Properties .........................

Eras: era = 1
MaxSupportedDateTime = 12/31/9999 11:59:59 PM
MinSupportedDateTime = 3/21/0622 12:00:00 AM
TwoDigitYearMax = 1410

................ Methods ...........................

AddMonths: thisDate + 6 months = 12/15/2006 11:31:13 AM
           thisDate - 6 months = 12/15/2005 11:31:13 AM
AddYears:  thisDate + 5 years =  6/14/2011 11:31:13 AM
           thisDate - 3 years =  6/14/2003 11:31:13 AM
GetDayOfMonth: month = 24
GetDayOfWeek: day = Wednesday
GetDayOfYear: day = 86
GetDaysInMonth: days = 31
GetDaysInYear: days = 366
GetEra: era = 1
GetLeapMonth: leap month (if any) = 0
GetMonth: month = 3
GetMonthsInYear: months in a year = 12
GetYear: year = 1385
IsLeapDay: This is a leap day = False
IsLeapMonth: This is a leap month = False
IsLeapYear: 1370 is a leap year = True
ToDateTime:
  Gregorian calendar: 6/10/2006 8:30:15 PM
  Persian calendar:   3/20/1385 8:30:15 PM
ToFourDigitYear:
  If TwoDigitYearMax = 1410, ToFourDigitYear(99) = 1399
  If TwoDigitYearMax = 2006, ToFourDigitYear(99) = 1999

*/

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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.