AddYears Method

HijriCalendar.AddYears Method

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

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

'Declaration
Public Overrides Function AddYears ( _
	time As DateTime, _
	years As Integer _
) As DateTime

Parameters

time
Type: System.DateTime
The DateTime to add years to.
years
Type: System.Int32
The number of years to add.

Return Value

Type: System.DateTime
The DateTime that results from adding the specified number of years to the specified DateTime.

ExceptionCondition
ArgumentException

The resulting DateTime is outside the supported range.

The day part of the resulting DateTime is affected if the resulting day is not a valid day in the resulting month of the resulting year. It is changed to the last valid day in the resulting month of the resulting year. The month part of the resulting DateTime remains the same as the specified DateTime. This implementation supports only the current era. Therefore, ArgumentException is thrown if the resulting year is outside the era of the specified DateTime. The time-of-day part of the resulting DateTime remains the same as the specified DateTime.

For example, Zulhijjah has 29 days, except during leap years when it has 30 days. If the specified date is the 30th day of Zulhijjah in a leap year and the value of years is 1, the resulting date will be the 29th day of Zulhijjah in the following year.

If years is negative, the resulting DateTime is earlier than the specified DateTime.

The Kind property of the returned DateTime value always equals DateTimeKind.Unspecified. You can preserve the Kind property of the time parameter by calling the DateTime.SpecifyKind method, as the following example shows.


returnTime = DateTime.SpecifyKind(cal.AddYears(time, years), time.Kind)


The following code example displays the values of several components of a DateTime in terms of the Hijri calendar.


Imports System.Globalization

Public Class Example
   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      ' Sets a DateTime to April 3, 2002 of the Gregorian calendar.
      Dim myDT As New DateTime(2002, 4, 3, New GregorianCalendar())

      ' Creates an instance of the HijriCalendar.
      Dim myCal As New HijriCalendar()

      ' Displays the values of the DateTime.
      outputBlock.Text += String.Format("April 3, 2002 of the Gregorian calendar equals the following in the Hijri calendar:") & vbCrLf
      DisplayValues(outputBlock, myCal, myDT)

      ' Adds two years and ten months.
      myDT = myCal.AddYears(myDT, 2)
      myDT = myCal.AddMonths(myDT, 10)

      ' Displays the values of the DateTime.
      outputBlock.Text &= "After adding two years and ten months:" & vbCrLf
      DisplayValues(outputBlock, myCal, myDT)
   End Sub 

   Public Shared Sub DisplayValues(ByVal outputBlock As System.Windows.Controls.TextBlock, ByVal myCal As Calendar, ByVal myDT As DateTime)
      outputBlock.Text += String.Format("   Era:        {0}", myCal.GetEra(myDT)) & vbCrLf
      outputBlock.Text += String.Format("   Year:       {0}", myCal.GetYear(myDT)) & vbCrLf
      outputBlock.Text += String.Format("   Month:      {0}", myCal.GetMonth(myDT)) & vbCrLf
      outputBlock.Text += String.Format("   DayOfYear:  {0}", myCal.GetDayOfYear(myDT)) & vbCrLf
      outputBlock.Text += String.Format("   DayOfMonth: {0}", myCal.GetDayOfMonth(myDT)) & vbCrLf
      outputBlock.Text += String.Format("   DayOfWeek:  {0}", myCal.GetDayOfWeek(myDT)) & vbCrLf
      outputBlock.Text &= vbCrLf
   End Sub
End Class  
' This example produces the following output.
'    April 3, 2002 of the Gregorian calendar equals the following in the Hijri calendar:
'       Era:        1
'       Year:       1423
'       Month:      1
'       DayOfYear:  21
'       DayOfMonth: 21
'       DayOfWeek:  Wednesday
'    
'    After adding two years and ten months:
'       Era:        1
'       Year:       1425
'       Month:      11
'       DayOfYear:  316
'       DayOfMonth: 21
'       DayOfWeek:  Saturday


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2017 Microsoft