UmAlQuraCalendar Class

July 28, 2014

Represents the Saudi Hijri (Um Al Qura) calendar.

System.Object
  System.Globalization.Calendar
    System.Globalization.UmAlQuraCalendar

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

'Declaration
Public Class UmAlQuraCalendar _
	Inherits Calendar

The UmAlQuraCalendar type exposes the following members.

  NameDescription
Public methodUmAlQuraCalendarInitializes a new instance of the UmAlQuraCalendar class.
Top

  NameDescription
Public propertyErasGets a list of the eras that are supported by the current UmAlQuraCalendar. (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 this calendar. (Overrides Calendar.MaxSupportedDateTime.)
Public propertyMinSupportedDateTimeGets the earliest date and time supported by this calendar. (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 methodAddMonthsCalculates a date that is a specified number of months away from a specified initial date. (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 methodAddYearsCalculates a date that is a specified number of years away from a specified initial date. (Overrides Calendar.AddYears(DateTime, Int32).)
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 the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetDayOfMonthCalculates on which day of the month a specified date occurs. (Overrides Calendar.GetDayOfMonth(DateTime).)
Public methodGetDayOfWeekCalculates on which day of the week a specified date occurs. (Overrides Calendar.GetDayOfWeek(DateTime).)
Public methodGetDayOfYearCalculates on which day of the year a specified date occurs. (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)Calculates 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)Calculates the number of days in the specified year of the specified era. (Overrides Calendar.GetDaysInYear(Int32, Int32).)
Public methodGetEraReturns the era of a specified DateTime value. (Overrides Calendar.GetEra(DateTime).)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetHourReturns the hours value in the specified DateTime. (Inherited from Calendar.)
Public methodGetLeapMonthCalculates 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 methodGetMonthCalculates the month in which a specified date occurs. (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)Calculates 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 methodGetYearCalculates the year of a date represented by a specified DateTime. (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 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 by using the TwoDigitYearMax property to determine the appropriate century. (Overrides Calendar.ToFourDigitYear(Int32).)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The UmAlQuraCalendar class is nearly identical to the HijriCalendar class, except that the UmAlQuraCalendar class:

  • Uses a table-based algorithm licensed from the Saudi government to calculate dates.

  • Consists of months that have either 29 or 30 days, although the precise number of days in a month is usually not predictable. Although the documentation for the HijriCalendar class includes a table that shows the corresponding days in each month, no such general table can be produced for the UmAlQuraCalendar class.

  • Can express dates to the year 1450 A.H. (Latin "Anno Hegirae", which means "the year of the migration," in reference to the migration of Muhammad from Mecca).

  • Does not support the HijriCalendar.HijriAdjustment property.

Each CultureInfo object supports a set of calendars. The CultureInfo.Calendar property returns the default calendar for the culture, and the CultureInfo.OptionalCalendars property returns an array that contains all the calendars supported by the culture. To change the calendar used by a CultureInfo object, the application can set the Calendar property of CultureInfo.DateTimeFormat to a new Calendar object if the new calendar is one of the culture's optional calendars. The following example shows how to change the calendar for the ar-AE culture to the Um Al Qura calendar.


' Change the calendar used by a ar-AE CultureInfo object from Gregorian to Um Al Qura. 
Dim uaeCulture As New CultureInfo("ar-AE")
Dim originalCalendar As Calendar = uaeCulture.Calendar
Dim message As String = Nothing

' Confirm that the default calendar is not the Um Al Qura calendar.
If originalCalendar.ToString() <> "System.Globalization.UmAlQuraCalendar" Then
   ' Check whether the culture supports the Gregorian calendar.
   Dim supported As Boolean = False
   For Each supportedCal As Calendar In uaeCulture.OptionalCalendars
      If supportedCal.ToString() = "System.Globalization.UmAlQuraCalendar" Then
         supported = True
         uaeCulture.DateTimeFormat.Calendar = supportedCal
         message = String.Format("Changed the current calendar for the {0} culture from {1} to {2}.", _
                                 uaeCulture.ToString(), _
                                 originalCalendar.ToString().Replace("System.Globalization.", ""), _
                                 supportedCal.ToString().Replace("System.Globalization.", ""))                                 
         Exit For
      End If
      If Not supported Then message = "The Um Al Qura calendar is not supported."
   Next        
Else
   message = String.Format("Um Al Qura is the default calendar for the {0} culture.", _
                           uaeCulture.ToString())
End If
outputBlock.Text += message + vbCrLf
' The example displays the following output:
'   Changed the current calendar for the ar-AE culture from GregorianCalendar to UmAlQuraCalendar.


Note   The UmAlQuraCalendar class supports only dates from 04/30/1900 00.00.00 (Gregorian date) through 05/13/2029 23:59:59 (Gregorian date). An ArgumentOutOfRangeException is thrown if the calendar attempts to handle any date outside that range.

Version Notes

Windows Phone

This type is present but is not currently supported in Windows Phone.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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