Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class System.Globalization.PersianCalendar
Assembly: System.Runtime
Inheritance: object → Calendar → PersianCalendar
Implemented Interfaces
- ICloneable Implemented by: Calendar
Represents the Persian calendar.
Fields and Constants
public static readonly
int
PersianEra
Represents the current era. This field is constant.
Properties
public
CalendarAlgorithmType
AlgorithmType
Gets a value indicating whether the current calendar is solar-based, lunar-based, or lunisolar-based.
public
int[]
Eras
Gets the list of eras in a <see cref="T:System.Globalization.PersianCalendar" /> object.
public
DateTime
MaxSupportedDateTime
Gets the latest date and time supported by the <see cref="T:System.Globalization.PersianCalendar" /> class.
public
DateTime
MinSupportedDateTime
Gets the earliest date and time supported by the <see cref="T:System.Globalization.PersianCalendar" /> class.
public
int
TwoDigitYearMax
Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.
protected
int
DaysInYearBeforeMinSupportedYear
Gets the number of days in the year that precedes the year that is specified by the <see cref="P:System.Globalization.Calendar.MinSupportedDateTime" /> property.
public
bool
IsReadOnly
Gets a value indicating whether this <see cref="T:System.Globalization.Calendar" /> object is read-only.
Methods
public
DateTime
AddMonths(DateTime time,
int months)
Returns a <see cref="T:System.DateTime" /> object that is offset the specified number of months from the specified <see cref="T:System.DateTime" /> object.
Returns A <see cref="T:System.DateTime" /> object that represents the date yielded by adding the number of months specified by the <paramref name="months" /> parameter to the date specified by the <paramref name="time" /> parameter.
time
The <see cref="T:System.DateTime" /> to which to add months.
months
The positive or negative number of months to add.
public
DateTime
AddYears(DateTime time,
int years)
Returns a <see cref="T:System.DateTime" /> object that is offset the specified number of years from the specified <see cref="T:System.DateTime" /> object.
Returns The <see cref="T:System.DateTime" /> object that results from adding the specified number of years to the specified <see cref="T:System.DateTime" /> object.
time
The <see cref="T:System.DateTime" /> to which to add years.
years
The positive or negative number of years to add.
public
int
GetDayOfMonth(DateTime time)
Returns the day of the month in the specified <see cref="T:System.DateTime" /> object.
Returns An integer from 1 through 31 that represents the day of the month in the specified <see cref="T:System.DateTime" /> object.
time
The <see cref="T:System.DateTime" /> to read.
public
DayOfWeek
GetDayOfWeek(DateTime time)
Returns the day of the week in the specified <see cref="T:System.DateTime" /> object.
Returns A <see cref="T:System.DayOfWeek" /> value that represents the day of the week in the specified <see cref="T:System.DateTime" /> object.
time
The <see cref="T:System.DateTime" /> to read.
public
int
GetDayOfYear(DateTime time)
Returns the day of the year in the specified <see cref="T:System.DateTime" /> object.
Returns An integer from 1 through 366 that represents the day of the year in the specified <see cref="T:System.DateTime" /> object.
time
The <see cref="T:System.DateTime" /> to read.
public
int
GetDaysInMonth(int year,
int month,
int era)
Returns the number of days in the specified month of the specified year and era.
Returns The number of days in the specified month of the specified year and era.
year
An integer from 1 through 9378 that represents the year.
month
An integer that represents the month, and ranges from 1 through 12 if <paramref name="year" /> is not 9378, or 1 through 10 if <paramref name="year" /> is 9378.
era
An integer from 0 through 1 that represents the era.
public
int
GetDaysInYear(int year,
int era)
Returns the number of days in the specified year of the specified era.
Returns The number of days in the specified year and era. The number of days is 365 in a common year or 366 in a leap year.
year
An integer from 1 through 9378 that represents the year.
era
An integer from 0 through 1 that represents the era.
public
int
GetEra(DateTime time)
Returns the era in the specified <see cref="T:System.DateTime" /> object.
Returns Always returns <see cref="F:System.Globalization.PersianCalendar.PersianEra" /> .
time
The <see cref="T:System.DateTime" /> to read.
public
int
GetLeapMonth(int year,
int era)
Returns the leap month for a specified year and era.
Returns The return value is always 0.
year
An integer from 1 through 9378 that represents the year to convert.
era
An integer from 0 through 1 that represents the era.
public
int
GetMonth(DateTime time)
Returns the month in the specified <see cref="T:System.DateTime" /> object.
Returns An integer from 1 through 12 that represents the month in the specified <see cref="T:System.DateTime" /> object.
time
The <see cref="T:System.DateTime" /> to read.
public
int
GetMonthsInYear(int year,
int era)
Returns the number of months in the specified year of the specified era.
Returns Returns 10 if the <paramref name="year" /> parameter is 9378; otherwise, always returns 12.
year
An integer from 1 through 9378 that represents the year.
era
An integer from 0 through 1 that represents the era.
public
int
GetYear(DateTime time)
Returns the year in the specified <see cref="T:System.DateTime" /> object.
Returns An integer from 1 through 9378 that represents the year in the specified <see cref="T:System.DateTime" /> .
time
The <see cref="T:System.DateTime" /> to read.
public
bool
IsLeapDay(int year,
int month,
int day,
int era)
Determines whether the specified date is a leap day.
Returns <see langword="true" /> if the specified day is a leap day; otherwise, <see langword="false" /> .
year
An integer from 1 through 9378 that represents the year.
month
An integer that represents the month and ranges from 1 through 12 if <paramref name="year" /> is not 9378, or 1 through 10 if <paramref name="year" /> is 9378.
day
An integer from 1 through 31 that represents the day.
era
An integer from 0 through 1 that represents the era.
public
bool
IsLeapMonth(int year,
int month,
int era)
Determines whether the specified month in the specified year and era is a leap month.
Returns Always returns <see langword="false" /> because the <see cref="T:System.Globalization.PersianCalendar" /> class does not support the notion of a leap month.
year
An integer from 1 through 9378 that represents the year.
month
An integer that represents the month and ranges from 1 through 12 if <paramref name="year" /> is not 9378, or 1 through 10 if <paramref name="year" /> is 9378.
era
An integer from 0 through 1 that represents the era.
public
bool
IsLeapYear(int year,
int era)
Determines whether the specified year in the specified era is a leap year.
Returns <see langword="true" /> if the specified year is a leap year; otherwise, <see langword="false" /> .
year
An integer from 1 through 9378 that represents the year.
era
An integer from 0 through 1 that represents the era.
public
DateTime
ToDateTime(int year,
int month,
int day,
int hour,
int minute,
int second,
int millisecond,
int era)
Returns a <see cref="T:System.DateTime" /> object that is set to the specified date, time, and era.
Returns A <see cref="T:System.DateTime" /> object that is set to the specified date and time in the current era.
year
An integer from 1 through 9378 that represents the year.
month
An integer from 1 through 12 that represents the month.
day
An integer from 1 through 31 that represents the day.
hour
An integer from 0 through 23 that represents the hour.
minute
An integer from 0 through 59 that represents the minute.
second
An integer from 0 through 59 that represents the second.
millisecond
An integer from 0 through 999 that represents the millisecond.
era
An integer from 0 through 1 that represents the era.
public
int
ToFourDigitYear(int year)
Converts the specified year to a four-digit year representation.
Returns An integer that contains the four-digit representation of <paramref name="year" /> .
year
An integer from 1 through 9378 that represents the year to convert.
public
DateTime
AddDays(DateTime time,
int days)
Inherited from Calendar
Returns a <see cref="T:System.DateTime" /> that is the specified number of days away from the specified <see cref="T:System.DateTime" /> .
Returns The <see cref="T:System.DateTime" /> that results from adding the specified number of days to the specified <see cref="T:System.DateTime" /> .
time
The <see cref="T:System.DateTime" /> to which to add days.
days
The number of days to add.
public
DateTime
AddHours(DateTime time,
int hours)
Inherited from Calendar
Returns a <see cref="T:System.DateTime" /> that is the specified number of hours away from the specified <see cref="T:System.DateTime" /> .
Returns The <see cref="T:System.DateTime" /> that results from adding the specified number of hours to the specified <see cref="T:System.DateTime" /> .
time
The <see cref="T:System.DateTime" /> to which to add hours.
hours
The number of hours to add.
public
DateTime
AddMilliseconds(DateTime time,
double milliseconds)
Inherited from Calendar
Returns a <see cref="T:System.DateTime" /> that is the specified number of milliseconds away from the specified <see cref="T:System.DateTime" /> .
Returns The <see cref="T:System.DateTime" /> that results from adding the specified number of milliseconds to the specified <see cref="T:System.DateTime" /> .
time
The <see cref="T:System.DateTime" /> to add milliseconds to.
milliseconds
The number of milliseconds to add.
public
DateTime
AddMinutes(DateTime time,
int minutes)
Inherited from Calendar
Returns a <see cref="T:System.DateTime" /> that is the specified number of minutes away from the specified <see cref="T:System.DateTime" /> .
Returns The <see cref="T:System.DateTime" /> that results from adding the specified number of minutes to the specified <see cref="T:System.DateTime" /> .
time
The <see cref="T:System.DateTime" /> to which to add minutes.
minutes
The number of minutes to add.
public
DateTime
AddSeconds(DateTime time,
int seconds)
Inherited from Calendar
Returns a <see cref="T:System.DateTime" /> that is the specified number of seconds away from the specified <see cref="T:System.DateTime" /> .
Returns The <see cref="T:System.DateTime" /> that results from adding the specified number of seconds to the specified <see cref="T:System.DateTime" /> .
time
The <see cref="T:System.DateTime" /> to which to add seconds.
seconds
The number of seconds to add.
public
DateTime
AddWeeks(DateTime time,
int weeks)
Inherited from Calendar
Returns a <see cref="T:System.DateTime" /> that is the specified number of weeks away from the specified <see cref="T:System.DateTime" /> .
Returns The <see cref="T:System.DateTime" /> that results from adding the specified number of weeks to the specified <see cref="T:System.DateTime" /> .
time
The <see cref="T:System.DateTime" /> to which to add weeks.
weeks
The number of weeks to add.
public
object
Clone()
Inherited from Calendar
Creates a new object that is a copy of the current <see cref="T:System.Globalization.Calendar" /> object.
Returns A new instance of <see cref="T:System.Object" /> that is the memberwise clone of the current <see cref="T:System.Globalization.Calendar" /> object.
public
int
GetDaysInMonth(int year,
int month)
Inherited from Calendar
Returns the number of days in the specified month and year of the current era.
Returns The number of days in the specified month in the specified year in the current era.
year
An integer that represents the year.
month
A positive integer that represents the month.
public
int
GetDaysInYear(int year)
Inherited from Calendar
Returns the number of days in the specified year of the current era.
Returns The number of days in the specified year in the current era.
year
An integer that represents the year.
public
int
GetHour(DateTime time)
Inherited from Calendar
Returns the hours value in the specified <see cref="T:System.DateTime" /> .
Returns An integer from 0 to 23 that represents the hour in <paramref name="time" /> .
time
The <see cref="T:System.DateTime" /> to read.
public
int
GetLeapMonth(int year)
Inherited from Calendar
Calculates the leap month for a specified year.
Returns A positive integer that indicates the leap month in the specified year.
-or-
Zero if this calendar does not support a leap month or if the <paramref name="year" /> parameter does not represent a leap year.
year
A year.
public
double
GetMilliseconds(DateTime time)
Inherited from Calendar
Returns the milliseconds value in the specified <see cref="T:System.DateTime" /> .
Returns A double-precision floating-point number from 0 to 999 that represents the milliseconds in the <paramref name="time" /> parameter.
time
The <see cref="T:System.DateTime" /> to read.
public
int
GetMinute(DateTime time)
Inherited from Calendar
Returns the minutes value in the specified <see cref="T:System.DateTime" /> .
Returns An integer from 0 to 59 that represents the minutes in <paramref name="time" /> .
time
The <see cref="T:System.DateTime" /> to read.
public
int
GetMonthsInYear(int year)
Inherited from Calendar
Returns the number of months in the specified year in the current era.
Returns The number of months in the specified year in the current era.
year
An integer that represents the year.
public
int
GetSecond(DateTime time)
Inherited from Calendar
Returns the seconds value in the specified <see cref="T:System.DateTime" /> .
Returns An integer from 0 to 59 that represents the seconds in <paramref name="time" /> .
time
The <see cref="T:System.DateTime" /> to read.
public
int
GetWeekOfYear(DateTime time,
CalendarWeekRule rule,
DayOfWeek firstDayOfWeek)
Inherited from Calendar
Returns the week of the year that includes the date in the specified <see cref="T:System.DateTime" /> value.
Returns A positive integer that represents the week of the year that includes the date in the <paramref name="time" /> parameter.
time
A date and time value.
rule
An enumeration value that defines a calendar week.
firstDayOfWeek
An enumeration value that represents the first day of the week.
public
bool
IsLeapDay(int year,
int month,
int day)
Inherited from Calendar
Determines whether the specified date in the current era is a leap day.
Returns <see langword="true" /> if the specified day is a leap day; otherwise, <see langword="false" /> .
year
An integer that represents the year.
month
A positive integer that represents the month.
day
A positive integer that represents the day.
public
bool
IsLeapMonth(int year,
int month)
Inherited from Calendar
Determines whether the specified month in the specified year in the current era is a leap month.
Returns <see langword="true" /> if the specified month is a leap month; otherwise, <see langword="false" /> .
year
An integer that represents the year.
month
A positive integer that represents the month.
public
bool
IsLeapYear(int year)
Inherited from Calendar
Determines whether the specified year in the current era is a leap year.
Returns <see langword="true" /> if the specified year is a leap year; otherwise, <see langword="false" /> .
year
An integer that represents the year.
public
DateTime
ToDateTime(int year,
int month,
int day,
int hour,
int minute,
int second,
int millisecond)
Inherited from Calendar
Returns a <see cref="T:System.DateTime" /> that is set to the specified date and time in the current era.
Returns The <see cref="T:System.DateTime" /> that is set to the specified date and time in the current era.
year
An integer that represents the year.
month
A positive integer that represents the month.
day
A positive integer that represents the day.
hour
An integer from 0 to 23 that represents the hour.
minute
An integer from 0 to 59 that represents the minute.
second
An integer from 0 to 59 that represents the second.
millisecond
An integer from 0 to 999 that represents the millisecond.
public
bool
Equals(object obj)
Inherited from object
Determines whether the specified object is equal to the current object.
Returns <see langword="true" /> if the specified object is equal to the current object; otherwise, <see langword="false" /> .
obj
The object to compare with the current object.
protected
void
Finalize()
Inherited from object
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
public
int
GetHashCode()
Inherited from object
Serves as the default hash function.
Returns A hash code for the current object.
public
Type
GetType()
Inherited from object
Gets the <see cref="T:System.Type" /> of the current instance.
Returns The exact runtime type of the current instance.
protected
object
MemberwiseClone()
Inherited from object
Creates a shallow copy of the current <see cref="T:System.Object" /> .
Returns A shallow copy of the current <see cref="T:System.Object" /> .
public
string
ToString()
Inherited from object
Returns a string that represents the current object.
Returns A string that represents the current object.