Export (0) Print
Expand All

PersianCalendar Class

Represents the Persian calendar.

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

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

'Declaration
<SerializableAttribute> _
Public Class PersianCalendar _
	Inherits Calendar

The PersianCalendar type exposes the following members.

  NameDescription
Public methodPersianCalendarInitializes a new instance of the PersianCalendar class.
Top

  NameDescription
Public propertyAlgorithmTypeGets a value indicating whether the current calendar is solar-based, lunar-based, or lunisolar-based. (Overrides Calendar.AlgorithmType.)
Protected propertyDaysInYearBeforeMinSupportedYearGets the number of days in the year that precedes the year that is specified by the MinSupportedDateTime property. (Inherited from Calendar.)
Public propertyErasGets the list of eras in a PersianCalendar object. (Overrides Calendar.Eras.)
Public propertyIsReadOnlyGets a value indicating whether this Calendar object is read-only. (Inherited from Calendar.)
Public propertyMaxSupportedDateTimeGets the latest date and time supported by the PersianCalendar class. (Overrides Calendar.MaxSupportedDateTime.)
Public propertyMinSupportedDateTimeGets the earliest date and time supported by the PersianCalendar class. (Overrides Calendar.MinSupportedDateTime.)
Public propertyTwoDigitYearMaxGets or sets the last year of a 100-year range that can be represented by a 2-digit year. (Overrides Calendar.TwoDigitYearMax.)
Top

  NameDescription
Public methodAddDaysReturns a DateTime that is the specified number of days away from the specified DateTime. (Inherited from Calendar.)
Public methodAddHoursReturns a DateTime that is the specified number of hours away from the specified DateTime. (Inherited from Calendar.)
Public methodAddMillisecondsReturns a DateTime that is the specified number of milliseconds away from the specified DateTime. (Inherited from Calendar.)
Public methodAddMinutesReturns a DateTime that is the specified number of minutes away from the specified DateTime. (Inherited from Calendar.)
Public methodAddMonthsReturns a DateTime object that is offset the specified number of months from the specified DateTime object. (Overrides Calendar.AddMonths(DateTime, Int32).)
Public methodAddSecondsReturns a DateTime that is the specified number of seconds away from the specified DateTime. (Inherited from Calendar.)
Public methodAddWeeksReturns a DateTime that is the specified number of weeks away from the specified DateTime. (Inherited from Calendar.)
Public methodAddYearsReturns a DateTime object that is offset the specified number of years from the specified DateTime object. (Overrides Calendar.AddYears(DateTime, Int32).)
Public methodCloneCreates a new object that is a copy of the current Calendar object. (Inherited from Calendar.)
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 methodGetDayOfMonthReturns the day of the month in the specified DateTime object. (Overrides Calendar.GetDayOfMonth(DateTime).)
Public methodGetDayOfWeekReturns the day of the week in the specified DateTime object. (Overrides Calendar.GetDayOfWeek(DateTime).)
Public methodGetDayOfYearReturns the day of the year in the specified DateTime object. (Overrides Calendar.GetDayOfYear(DateTime).)
Public methodGetDaysInMonth(Int32, Int32)Returns the number of days in the specified month and year of the current era. (Inherited from Calendar.)
Public methodGetDaysInMonth(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 methodGetDaysInYear(Int32)Returns the number of days in the specified year of the current era. (Inherited from Calendar.)
Public methodGetDaysInYear(Int32, Int32)Returns the number of days in the specified year of the specified era. (Overrides Calendar.GetDaysInYear(Int32, Int32).)
Public methodGetEraReturns the era in the specified DateTime object. (Overrides Calendar.GetEra(DateTime).)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetHourReturns the hours value in the specified DateTime. (Inherited from Calendar.)
Public methodGetLeapMonth(Int32)Calculates the leap month for a specified year. (Inherited from Calendar.)
Public methodGetLeapMonth(Int32, Int32)Returns the leap month for a specified year and era. (Overrides Calendar.GetLeapMonth(Int32, Int32).)
Public methodGetMillisecondsReturns the milliseconds value in the specified DateTime. (Inherited from Calendar.)
Public methodGetMinuteReturns the minutes value in the specified DateTime. (Inherited from Calendar.)
Public methodGetMonthReturns the month in the specified DateTime object. (Overrides Calendar.GetMonth(DateTime).)
Public methodGetMonthsInYear(Int32)Returns the number of months in the specified year in the current era. (Inherited from Calendar.)
Public methodGetMonthsInYear(Int32, Int32)Returns the number of months in the specified year of the specified era. (Overrides Calendar.GetMonthsInYear(Int32, Int32).)
Public methodGetSecondReturns the seconds value in the specified DateTime. (Inherited from Calendar.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetWeekOfYearReturns the week of the year that includes the date in the specified DateTime value. (Inherited from Calendar.)
Public methodGetYearReturns the year in the specified DateTime object. (Overrides Calendar.GetYear(DateTime).)
Public methodIsLeapDay(Int32, Int32, Int32)Determines whether the specified date in the current era is a leap day. (Inherited from Calendar.)
Public methodIsLeapDay(Int32, Int32, Int32, Int32)Determines whether the specified date is a leap day. (Overrides Calendar.IsLeapDay(Int32, Int32, Int32, Int32).)
Public methodIsLeapMonth(Int32, Int32)Determines whether the specified month in the specified year in the current era is a leap month. (Inherited from Calendar.)
Public methodIsLeapMonth(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 methodIsLeapYear(Int32)Determines whether the specified year in the current era is a leap year. (Inherited from Calendar.)
Public methodIsLeapYear(Int32, Int32)Determines whether the specified year in the specified era is a leap year. (Overrides Calendar.IsLeapYear(Int32, Int32).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToDateTime(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 methodToDateTime(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 methodToFourDigitYearConverts the specified year to a four-digit year representation. (Overrides Calendar.ToFourDigitYear(Int32).)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberPersianEraRepresents the current era. This field is constant.
Top

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.

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.

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.

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.

Imports System.Globalization

Module Example
    Public Sub Main()
        Dim pc As New PersianCalendar()
        Dim thisDate As Date = Date.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}",  
                      pc.GetDayOfWeek(thisDate),
                      pc.GetMonth(thisDate),
                      pc.GetDayOfMonth(thisDate), 
                      pc.GetYear(thisDate),
                      pc.GetHour(thisDate),
                      pc.GetMinute(thisDate),
                      pc.GetSecond(thisDate))
        Console.WriteLine()

        ' 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}", 
                      pc.GetDayOfWeek(thisDate),
                      pc.GetMonth(thisDate),
                      pc.GetDayOfMonth(thisDate), 
                      pc.GetYear(thisDate),
                      pc.GetHour(thisDate),
                      pc.GetMinute(thisDate),
                      pc.GetSecond(thisDate))
        Console.WriteLine()

        ' 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}", 
                      pc.GetDayOfWeek(thisDate),
                      pc.GetMonth(thisDate),
                      pc.GetDayOfMonth(thisDate), 
                      pc.GetYear(thisDate),
                      pc.GetHour(thisDate),
                      pc.GetMinute(thisDate),
                      pc.GetSecond(thisDate))
        Console.WriteLine()

        ' 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}",  
                          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()

        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}",  
                          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))
        Console.WriteLine()
    End Sub 
End Module  
' The example displays output like the following:  
'    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.

Imports System.Globalization

Class Sample
    Public Shared Sub Main()
        '-------------------------------------------------------------------------------- 
        ' Get today's date. 
        '-------------------------------------------------------------------------------- 
        Dim jc As New PersianCalendar()
        Dim thisDate As Date = Date.Now

        '-------------------------------------------------------------------------------- 
        ' Properties 
        '--------------------------------------------------------------------------------
        Console.WriteLine(vbCrLf & _
                          "........... Selected Properties ....................." & vbCrLf)
        Console.Write("Eras:")
        Dim era As Integer 
        For Each era In jc.Eras
            Console.WriteLine(" era = {0}", era)
        Next era
        '--------------------------------------------------------------------------------
        Console.WriteLine("TwoDigitYearMax = {0}", jc.TwoDigitYearMax)
        '-------------------------------------------------------------------------------- 
        ' Methods 
        '--------------------------------------------------------------------------------
        Console.WriteLine(vbCrLf & _
                          "............ Selected Methods ......................." & vbCrLf)

        '--------------------------------------------------------------------------------
        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))
    End Sub 
End Class  
' The example displays output like the following:  
'       ........... Seleted 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

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

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