mscorlib(4.0.0.0) API with additions
System.Globalization.HijriCalendar Class Reference

Represents the Hijri calendar. More...

Inheritance diagram for System.Globalization.HijriCalendar:
[legend]
Collaboration diagram for System.Globalization.HijriCalendar:
[legend]

Public Member Functions

override DateTime AddMonths (DateTime time, int months)
 Returns a T:System.DateTime that is the specified number of months away from the specified T:System.DateTime. More...
 
override DateTime AddYears (DateTime time, int years)
 Returns a T:System.DateTime that is the specified number of years away from the specified T:System.DateTime. More...
 
override int GetDayOfMonth (DateTime time)
 Returns the day of the month in the specified T:System.DateTime. More...
 
override DayOfWeek GetDayOfWeek (DateTime time)
 Returns the day of the week in the specified T:System.DateTime. More...
 
override int GetDayOfYear (DateTime time)
 Returns the day of the year in the specified T:System.DateTime. More...
 
override int GetDaysInMonth (int year, int month, int era)
 Returns the number of days in the specified month of the specified year and era. More...
 
override int GetDaysInYear (int year, int era)
 Returns the number of days in the specified year and era. More...
 
override int GetEra (DateTime time)
 Returns the era in the specified T:System.DateTime. More...
 
override int GetMonth (DateTime time)
 Returns the month in the specified T:System.DateTime. More...
 
override int GetMonthsInYear (int year, int era)
 Returns the number of months in the specified year and era. More...
 
override int GetYear (DateTime time)
 Returns the year in the specified T:System.DateTime. More...
 
override bool IsLeapDay (int year, int month, int day, int era)
 Determines whether the specified date is a leap day. More...
 
override int GetLeapMonth (int year, int era)
 Calculates the leap month for a specified year and era. More...
 
override bool IsLeapMonth (int year, int month, int era)
 Determines whether the specified month in the specified year and era is a leap month. More...
 
override bool IsLeapYear (int year, int era)
 Determines whether the specified year in the specified era is a leap year. More...
 
override DateTime ToDateTime (int year, int month, int day, int hour, int minute, int second, int millisecond, int era)
 Returns a T:System.DateTime that is set to the specified date, time, and era. More...
 
override int ToFourDigitYear (int year)
 Converts the specified year to a four-digit year by using the P:System.Globalization.HijriCalendar.TwoDigitYearMax property to determine the appropriate century. More...
 
- Public Member Functions inherited from System.Globalization.Calendar
virtual object Clone ()
 Creates a new object that is a copy of the current T:System.Globalization.Calendar object. More...
 
virtual DateTime AddMilliseconds (DateTime time, double milliseconds)
 Returns a T:System.DateTime that is the specified number of milliseconds away from the specified T:System.DateTime. More...
 
virtual DateTime AddDays (DateTime time, int days)
 Returns a T:System.DateTime that is the specified number of days away from the specified T:System.DateTime. More...
 
virtual DateTime AddHours (DateTime time, int hours)
 Returns a T:System.DateTime that is the specified number of hours away from the specified T:System.DateTime. More...
 
virtual DateTime AddMinutes (DateTime time, int minutes)
 Returns a T:System.DateTime that is the specified number of minutes away from the specified T:System.DateTime. More...
 
virtual DateTime AddSeconds (DateTime time, int seconds)
 Returns a T:System.DateTime that is the specified number of seconds away from the specified T:System.DateTime. More...
 
virtual DateTime AddWeeks (DateTime time, int weeks)
 Returns a T:System.DateTime that is the specified number of weeks away from the specified T:System.DateTime. More...
 
virtual int GetDaysInMonth (int year, int month)
 Returns the number of days in the specified month and year of the current era. More...
 
virtual int GetDaysInYear (int year)
 Returns the number of days in the specified year of the current era. More...
 
virtual int GetHour (DateTime time)
 Returns the hours value in the specified T:System.DateTime. More...
 
virtual double GetMilliseconds (DateTime time)
 Returns the milliseconds value in the specified T:System.DateTime. More...
 
virtual int GetMinute (DateTime time)
 Returns the minutes value in the specified T:System.DateTime. More...
 
virtual int GetMonthsInYear (int year)
 Returns the number of months in the specified year in the current era. More...
 
virtual int GetSecond (DateTime time)
 Returns the seconds value in the specified T:System.DateTime. More...
 
virtual int GetWeekOfYear (DateTime time, CalendarWeekRule rule, DayOfWeek firstDayOfWeek)
 Returns the week of the year that includes the date in the specified T:System.DateTime value. More...
 
virtual bool IsLeapDay (int year, int month, int day)
 Determines whether the specified date in the current era is a leap day. More...
 
virtual bool IsLeapMonth (int year, int month)
 Determines whether the specified month in the specified year in the current era is a leap month. More...
 
virtual int GetLeapMonth (int year)
 Calculates the leap month for a specified year. More...
 
virtual bool IsLeapYear (int year)
 Determines whether the specified year in the current era is a leap year. More...
 
virtual DateTime ToDateTime (int year, int month, int day, int hour, int minute, int second, int millisecond)
 Returns a T:System.DateTime that is set to the specified date and time in the current era. More...
 

Public Attributes

override int [] Eras
 Gets the list of eras in the T:System.Globalization.HijriCalendar. More...
 
- Public Attributes inherited from System.Globalization.Calendar
const int CurrentEra = 0
 Represents the current era of the current calendar. More...
 

Static Public Attributes

static readonly int HijriEra = 1
 Represents the current era. This field is constant. More...
 

Protected Attributes

override int DaysInYearBeforeMinSupportedYear => 354
 Gets the number of days in the year that precedes the year that is specified by the P:System.Globalization.HijriCalendar.MinSupportedDateTime property. More...
 
- Protected Attributes inherited from System.Globalization.Calendar
virtual int DaysInYearBeforeMinSupportedYear => 365
 Gets the number of days in the year that precedes the year that is specified by the P:System.Globalization.Calendar.MinSupportedDateTime property. More...
 

Properties

override DateTime MinSupportedDateTime [get]
 Gets the earliest date and time supported by this calendar. More...
 
override DateTime MaxSupportedDateTime [get]
 Gets the latest date and time supported by this calendar. More...
 
override CalendarAlgorithmType AlgorithmType [get]
 Gets a value that indicates whether the current calendar is solar-based, lunar-based, or a combination of both. More...
 
int HijriAdjustment [get, set]
 Gets or sets the number of days to add or subtract from the calendar to accommodate the variances in the start and the end of Ramadan and to accommodate the date difference between countries/regions. More...
 
override int TwoDigitYearMax [get, set]
 Gets or sets the last year of a 100-year range that can be represented by a 2-digit year. More...
 
- Properties inherited from System.Globalization.Calendar
virtual DateTime MinSupportedDateTime [get]
 Gets the earliest date and time supported by this T:System.Globalization.Calendar object. More...
 
virtual DateTime MaxSupportedDateTime [get]
 Gets the latest date and time supported by this T:System.Globalization.Calendar object. More...
 
virtual CalendarAlgorithmType AlgorithmType [get]
 Gets a value indicating whether the current calendar is solar-based, lunar-based, or a combination of both. More...
 
bool IsReadOnly [get]
 Gets a value indicating whether this T:System.Globalization.Calendar object is read-only. More...
 
abstract int [] Eras [get]
 When overridden in a derived class, gets the list of eras in the current calendar. More...
 
virtual int TwoDigitYearMax [get, set]
 Gets or sets the last year of a 100-year range that can be represented by a 2-digit year. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from System.Globalization.Calendar
static Calendar ReadOnly (Calendar calendar)
 Returns a read-only version of the specified T:System.Globalization.Calendar object. More...
 
- Protected Member Functions inherited from System.Globalization.Calendar
 Calendar ()
 Initializes a new instance of the T:System.Globalization.Calendar class. More...
 

Detailed Description

Represents the Hijri calendar.

Definition at line 10 of file HijriCalendar.cs.

Member Function Documentation

◆ AddMonths()

override DateTime System.Globalization.HijriCalendar.AddMonths ( DateTime  time,
int  months 
)
virtual

Returns a T:System.DateTime that is the specified number of months away from the specified T:System.DateTime.

Parameters
timeThe T:System.DateTime to add months to.
monthsThe number of months to add.
Returns
The T:System.DateTime that results from adding the specified number of months to the specified T:System.DateTime.
Exceptions
T:System.ArgumentExceptionThe resulting T:System.DateTime.
T:System.ArgumentOutOfRangeExceptionmonths is less than -120000.-or- months is greater than 120000.

Implements System.Globalization.Calendar.

Definition at line 342 of file HijriCalendar.cs.

◆ AddYears()

override DateTime System.Globalization.HijriCalendar.AddYears ( DateTime  time,
int  years 
)
virtual

Returns a T:System.DateTime that is the specified number of years away from the specified T:System.DateTime.

Parameters
timeThe T:System.DateTime to add years to.
yearsThe number of years to add.
Returns
The T:System.DateTime that results from adding the specified number of years to the specified T:System.DateTime.
Exceptions
T:System.ArgumentExceptionThe resulting T:System.DateTime is outside the supported range.

Implements System.Globalization.Calendar.

Definition at line 377 of file HijriCalendar.cs.

◆ GetDayOfMonth()

override int System.Globalization.HijriCalendar.GetDayOfMonth ( DateTime  time)
virtual

Returns the day of the month in the specified T:System.DateTime.

Parameters
timeThe T:System.DateTime to read.
Returns
An integer from 1 to 30 that represents the day of the month in the specified T:System.DateTime.

Implements System.Globalization.Calendar.

Definition at line 385 of file HijriCalendar.cs.

◆ GetDayOfWeek()

override DayOfWeek System.Globalization.HijriCalendar.GetDayOfWeek ( DateTime  time)
virtual

Returns the day of the week in the specified T:System.DateTime.

Parameters
timeThe T:System.DateTime to read.
Returns
A T:System.DayOfWeek value that represents the day of the week in the specified T:System.DateTime.

Implements System.Globalization.Calendar.

Definition at line 393 of file HijriCalendar.cs.

◆ GetDayOfYear()

override int System.Globalization.HijriCalendar.GetDayOfYear ( DateTime  time)
virtual

Returns the day of the year in the specified T:System.DateTime.

Parameters
timeThe T:System.DateTime to read.
Returns
An integer from 1 to 355 that represents the day of the year in the specified T:System.DateTime.

Implements System.Globalization.Calendar.

Definition at line 401 of file HijriCalendar.cs.

◆ GetDaysInMonth()

override int System.Globalization.HijriCalendar.GetDaysInMonth ( int  year,
int  month,
int  era 
)
virtual

Returns the number of days in the specified month of the specified year and era.

Parameters
yearAn integer that represents the year.
monthAn integer from 1 to 12 that represents the month.
eraAn integer that represents the era.
Returns
The number of days in the specified month in the specified year in the specified era.
Exceptions
T:System.ArgumentOutOfRangeExceptionera is outside the range supported by this calendar. -or- year is outside the range supported by this calendar.-or- month is outside the range supported by this calendar.

Implements System.Globalization.Calendar.

Definition at line 415 of file HijriCalendar.cs.

◆ GetDaysInYear()

override int System.Globalization.HijriCalendar.GetDaysInYear ( int  year,
int  era 
)
virtual

Returns the number of days in the specified year and era.

Parameters
yearAn integer that represents the year.
eraAn integer that represents the era.
Returns
The number of days in the specified year and era. The number of days is 354 in a common year or 355 in a leap year.
Exceptions
T:System.ArgumentOutOfRangeExceptionyear or era is outside the range supported by this calendar.

Implements System.Globalization.Calendar.

Definition at line 439 of file HijriCalendar.cs.

◆ GetEra()

override int System.Globalization.HijriCalendar.GetEra ( DateTime  time)
virtual

Returns the era in the specified T:System.DateTime.

Parameters
timeThe T:System.DateTime to read.
Returns
An integer that represents the era in the specified T:System.DateTime.

Implements System.Globalization.Calendar.

Definition at line 452 of file HijriCalendar.cs.

◆ GetLeapMonth()

override int System.Globalization.HijriCalendar.GetLeapMonth ( int  year,
int  era 
)
virtual

Calculates the leap month for a specified year and era.

Parameters
yearA year.
eraAn era. Specify F:System.Globalization.Calendar.CurrentEra or F:System.Globalization.HijriCalendar.HijriEra.
Returns
Always 0 because the T:System.Globalization.HijriCalendar type does not support the notion of a leap month.
Exceptions
T:System.ArgumentOutOfRangeExceptionyear is less than the Hijri calendar year 1 or greater than the year 9666.-or- era is not F:System.Globalization.Calendar.CurrentEra or F:System.Globalization.HijriCalendar.HijriEra.

Reimplemented from System.Globalization.Calendar.

Definition at line 521 of file HijriCalendar.cs.

◆ GetMonth()

override int System.Globalization.HijriCalendar.GetMonth ( DateTime  time)
virtual

Returns the month in the specified T:System.DateTime.

Parameters
timeThe T:System.DateTime to read.
Returns
An integer from 1 to 12 that represents the month in the specified T:System.DateTime.

Implements System.Globalization.Calendar.

Definition at line 461 of file HijriCalendar.cs.

◆ GetMonthsInYear()

override int System.Globalization.HijriCalendar.GetMonthsInYear ( int  year,
int  era 
)
virtual

Returns the number of months in the specified year and era.

Parameters
yearAn integer that represents the year.
eraAn integer that represents the era.
Returns
The number of months in the specified year and era.
Exceptions
T:System.ArgumentOutOfRangeExceptionera is outside the range supported by this calendar. -or- year is outside the range supported by this calendar.

Implements System.Globalization.Calendar.

Definition at line 473 of file HijriCalendar.cs.

◆ GetYear()

override int System.Globalization.HijriCalendar.GetYear ( DateTime  time)
virtual

Returns the year in the specified T:System.DateTime.

Parameters
timeThe T:System.DateTime to read.
Returns
An integer that represents the year in the specified T:System.DateTime.

Implements System.Globalization.Calendar.

Definition at line 482 of file HijriCalendar.cs.

◆ IsLeapDay()

override bool System.Globalization.HijriCalendar.IsLeapDay ( int  year,
int  month,
int  day,
int  era 
)
virtual

Determines whether the specified date is a leap day.

Parameters
yearAn integer that represents the year.
monthAn integer from 1 to 12 that represents the month.
dayAn integer from 1 to 30 that represents the day.
eraAn integer that represents the era.
Returns
true if the specified day is a leap day; otherwise, false.
Exceptions
T:System.ArgumentOutOfRangeExceptionera is outside the range supported by this calendar. -or- year is outside the range supported by this calendar.-or- month is outside the range supported by this calendar.-or- day is outside the range supported by this calendar.

Implements System.Globalization.Calendar.

Definition at line 499 of file HijriCalendar.cs.

◆ IsLeapMonth()

override bool System.Globalization.HijriCalendar.IsLeapMonth ( int  year,
int  month,
int  era 
)
virtual

Determines whether the specified month in the specified year and era is a leap month.

Parameters
yearAn integer that represents the year.
monthAn integer from 1 to 12 that represents the month.
eraAn integer that represents the era.
Returns
This method always returns false.
Exceptions
T:System.ArgumentOutOfRangeExceptionera is outside the range supported by this calendar. -or- year is outside the range supported by this calendar.-or- month is outside the range supported by this calendar.

Implements System.Globalization.Calendar.

Definition at line 536 of file HijriCalendar.cs.

◆ IsLeapYear()

override bool System.Globalization.HijriCalendar.IsLeapYear ( int  year,
int  era 
)
virtual

Determines whether the specified year in the specified era is a leap year.

Parameters
yearAn integer that represents the year.
eraAn integer that represents the era.
Returns
true if the specified year is a leap year; otherwise, false.
Exceptions
T:System.ArgumentOutOfRangeExceptionera is outside the range supported by this calendar. -or- year is outside the range supported by this calendar.

Implements System.Globalization.Calendar.

Definition at line 550 of file HijriCalendar.cs.

◆ ToDateTime()

override DateTime System.Globalization.HijriCalendar.ToDateTime ( int  year,
int  month,
int  day,
int  hour,
int  minute,
int  second,
int  millisecond,
int  era 
)
virtual

Returns a T:System.DateTime that is set to the specified date, time, and era.

Parameters
yearAn integer that represents the year.
monthAn integer from 1 to 12 that represents the month.
dayAn integer from 1 to 30 that represents the day.
hourAn integer from 0 to 23 that represents the hour.
minuteAn integer from 0 to 59 that represents the minute.
secondAn integer from 0 to 59 that represents the second.
millisecondAn integer from 0 to 999 that represents the millisecond.
eraAn integer that represents the era.
Returns
The T:System.DateTime that is set to the specified date and time in the current era.
Exceptions
T:System.ArgumentOutOfRangeExceptionera is outside the range supported by this calendar. -or- year is outside the range supported by this calendar.-or- month is outside the range supported by this calendar.-or- day is outside the range supported by this calendar.-or- hour is less than zero or greater than 23.-or- minute is less than zero or greater than 59.-or- second is less than zero or greater than 59.-or- millisecond is less than zero or greater than 999.

Implements System.Globalization.Calendar.

Definition at line 575 of file HijriCalendar.cs.

◆ ToFourDigitYear()

override int System.Globalization.HijriCalendar.ToFourDigitYear ( int  year)
virtual

Converts the specified year to a four-digit year by using the P:System.Globalization.HijriCalendar.TwoDigitYearMax property to determine the appropriate century.

Parameters
yearA two-digit or four-digit integer that represents the year to convert.
Returns
An integer that contains the four-digit representation of year .
Exceptions
T:System.ArgumentOutOfRangeExceptionyear is outside the range supported by this calendar.

Reimplemented from System.Globalization.Calendar.

Definition at line 595 of file HijriCalendar.cs.

Member Data Documentation

◆ DaysInYearBeforeMinSupportedYear

override int System.Globalization.HijriCalendar.DaysInYearBeforeMinSupportedYear => 354
protected

Gets the number of days in the year that precedes the year that is specified by the P:System.Globalization.HijriCalendar.MinSupportedDateTime property.

Returns
The number of days in the year that precedes the year specified by P:System.Globalization.HijriCalendar.MinSupportedDateTime.

Definition at line 99 of file HijriCalendar.cs.

◆ Eras

override int [] System.Globalization.HijriCalendar.Eras
Initial value:
=> new int[1]
{
}

Gets the list of eras in the T:System.Globalization.HijriCalendar.

Returns
An array of integers that represents the eras in the T:System.Globalization.HijriCalendar.

Definition at line 128 of file HijriCalendar.cs.

◆ HijriEra

readonly int System.Globalization.HijriCalendar.HijriEra = 1
static

Represents the current era. This field is constant.

Definition at line 13 of file HijriCalendar.cs.

Property Documentation

◆ AlgorithmType

override CalendarAlgorithmType System.Globalization.HijriCalendar.AlgorithmType
get

Gets a value that indicates whether the current calendar is solar-based, lunar-based, or a combination of both.

Returns
Always returns F:System.Globalization.CalendarAlgorithmType.LunarCalendar.

Definition at line 88 of file HijriCalendar.cs.

◆ HijriAdjustment

int System.Globalization.HijriCalendar.HijriAdjustment
getset

Gets or sets the number of days to add or subtract from the calendar to accommodate the variances in the start and the end of Ramadan and to accommodate the date difference between countries/regions.

Returns
An integer from -2 to 2 that represents the number of days to add or subtract from the calendar.
Exceptions
T:System.ArgumentOutOfRangeExceptionThe property is being set to an invalid value.

Definition at line 105 of file HijriCalendar.cs.

◆ MaxSupportedDateTime

override DateTime System.Globalization.HijriCalendar.MaxSupportedDateTime
get

Gets the latest date and time supported by this calendar.

Returns
The latest date and time supported by the T:System.Globalization.HijriCalendar type, which is equivalent to the last moment of December 31, 9999 C.E. in the Gregorian calendar.

Definition at line 77 of file HijriCalendar.cs.

◆ MinSupportedDateTime

override DateTime System.Globalization.HijriCalendar.MinSupportedDateTime
get

Gets the earliest date and time supported by this calendar.

Returns
The earliest date and time supported by the T:System.Globalization.HijriCalendar type, which is equivalent to the first moment of July 18, 622 C.E. in the Gregorian calendar.

Definition at line 66 of file HijriCalendar.cs.

◆ TwoDigitYearMax

override int System.Globalization.HijriCalendar.TwoDigitYearMax
getset

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Returns
The last year of a 100-year range that can be represented by a 2-digit year.
Exceptions
T:System.InvalidOperationExceptionThis calendar is read-only.
T:System.ArgumentOutOfRangeExceptionThe value in a set operation is less than 100 or greater than 9666.

Definition at line 138 of file HijriCalendar.cs.


The documentation for this class was generated from the following file: