Article
11/18/2011

UmAlQuraCalendar Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Represents the Saudi Hijri (Um Al Qura) calendar.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class UmAlQuraCalendar _
    Inherits Calendar

public class UmAlQuraCalendar : Calendar

The UmAlQuraCalendar type exposes the following members.

Constructors

	Name	Description
	UmAlQuraCalendar	Initializes a new instance of the UmAlQuraCalendar class.

Top

Properties

	Name	Description
	Eras	Gets a list of the eras that are supported by the current UmAlQuraCalendar. (Overrides Calendar.Eras.)
	IsReadOnly	Gets a value indicating whether this Calendar object is read-only. (Inherited from Calendar.)
	MaxSupportedDateTime	Gets the latest date and time supported by this calendar. (Overrides Calendar.MaxSupportedDateTime.)
	MinSupportedDateTime	Gets the earliest date and time supported by this calendar. (Overrides Calendar.MinSupportedDateTime.)
	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
	AddDays	Returns a DateTime that is the specified number of days away from the specified DateTime. (Inherited from Calendar.)
	AddHours	Returns a DateTime that is the specified number of hours away from the specified DateTime. (Inherited from Calendar.)
	AddMilliseconds	Returns a DateTime that is the specified number of milliseconds away from the specified DateTime. (Inherited from Calendar.)
	AddMinutes	Returns a DateTime that is the specified number of minutes away from the specified DateTime. (Inherited from Calendar.)
	AddMonths	Calculates a date that is a specified number of months away from a specified initial date. (Overrides Calendar.AddMonths(DateTime, Int32).)
	AddSeconds	Returns a DateTime that is the specified number of seconds away from the specified DateTime. (Inherited from Calendar.)
	AddWeeks	Returns a DateTime that is the specified number of weeks away from the specified DateTime. (Inherited from Calendar.)
	AddYears	Calculates a date that is a specified number of years away from a specified initial date. (Overrides Calendar.AddYears(DateTime, Int32).)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	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.)
	GetDayOfMonth	Calculates on which day of the month a specified date occurs. (Overrides Calendar.GetDayOfMonth(DateTime).)
	GetDayOfWeek	Calculates on which day of the week a specified date occurs. (Overrides Calendar.GetDayOfWeek(DateTime).)
	GetDayOfYear	Calculates on which day of the year a specified date occurs. (Overrides Calendar.GetDayOfYear(DateTime).)
	GetDaysInMonth(Int32, Int32)	Returns the number of days in the specified month and year of the current era. (Inherited from Calendar.)
	GetDaysInMonth(Int32, Int32, Int32)	Calculates the number of days in the specified month of the specified year and era. (Overrides Calendar.GetDaysInMonth(Int32, Int32, Int32).)
	GetDaysInYear(Int32)	Returns the number of days in the specified year of the current era. (Inherited from Calendar.)
	GetDaysInYear(Int32, Int32)	Calculates the number of days in the specified year of the specified era. (Overrides Calendar.GetDaysInYear(Int32, Int32).)
	GetEra	Returns the era of a specified DateTime value. (Overrides Calendar.GetEra(DateTime).)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetHour	Returns the hours value in the specified DateTime. (Inherited from Calendar.)
	GetLeapMonth	Calculates the leap month for a specified year and era. (Overrides Calendar.GetLeapMonth(Int32, Int32).)
	GetMilliseconds	Returns the milliseconds value in the specified DateTime. (Inherited from Calendar.)
	GetMinute	Returns the minutes value in the specified DateTime. (Inherited from Calendar.)
	GetMonth	Calculates the month in which a specified date occurs. (Overrides Calendar.GetMonth(DateTime).)
	GetMonthsInYear(Int32)	Returns the number of months in the specified year in the current era. (Inherited from Calendar.)
	GetMonthsInYear(Int32, Int32)	Calculates the number of months in the specified year of the specified era. (Overrides Calendar.GetMonthsInYear(Int32, Int32).)
	GetSecond	Returns the seconds value in the specified DateTime. (Inherited from Calendar.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetWeekOfYear	Returns the week of the year that includes the date in the specified DateTime value. (Inherited from Calendar.)
	GetYear	Calculates the year of a date represented by a specified DateTime. (Overrides Calendar.GetYear(DateTime).)
	IsLeapDay(Int32, Int32, Int32)	Determines whether the specified date in the current era is a leap day. (Inherited from Calendar.)
	IsLeapDay(Int32, Int32, Int32, Int32)	Determines whether the specified date is a leap day. (Overrides Calendar.IsLeapDay(Int32, Int32, Int32, Int32).)
	IsLeapMonth(Int32, Int32)	Determines whether the specified month in the specified year in the current era is a leap month. (Inherited from Calendar.)
	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).)
	IsLeapYear(Int32)	Determines whether the specified year in the current era is a leap year. (Inherited from Calendar.)
	IsLeapYear(Int32, Int32)	Determines whether the specified year in the specified era is a leap year. (Overrides Calendar.IsLeapYear(Int32, Int32).)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	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.)
	ToDateTime(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).)
	ToFourDigitYear	Converts the specified year to a four-digit year by using the TwoDigitYearMax property to determine the appropriate century. (Overrides Calendar.ToFourDigitYear(Int32).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

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.

// Change the calendar used by a ar-AE CultureInfo object from Gregorian to Um Al Qura. 
CultureInfo uaeCulture = new CultureInfo("ar-AE");
Calendar originalCalendar = uaeCulture.Calendar;
string message = null;

// Confirm that the default calendar is not the Um Al Qura calendar.
if (originalCalendar.ToString() != "System.Globalization.UmAlQuraCalendar")
{
   // Check whether the culture supports the Gregorian calendar.
   bool supported = false;
   foreach (Calendar supportedCal in uaeCulture.OptionalCalendars)
{
      if (supportedCal.ToString() == "System.Globalization.UmAlQuraCalendar")
      {
         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.", ""));                                 
         break;
      }
   }        
   if (! supported) message = "The Um Al Qura calendar is not supported.";
}
else
{
   message = String.Format("Um Al Qura is the default calendar for the {0} culture.",
                           uaeCulture.ToString());
}
outputBlock.Text += message + "\n";
// 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.

Platform Notes

Silverlight for Windows Phone

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

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

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.