System.Globalization.HebrewCalendar.AddYears Method

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

Syntax

public override DateTime AddYears (DateTime time, int years)

Parameters

time
The DateTime to which to add years.
years
The number of years to add.

Returns

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

Remarks

This implementation of the System.Globalization.HebrewCalendar class recognizes only the Hebrew years 5343 to 5999 (1583 to 2239 in the Gregorian calendar).

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. For example, Cheshvan can have 29 or 30 days, depending on the placement of Jewish holidays. Suppose that Cheshvan has 30 days in the current year and 29 in the following year. If the specified date is the 30th day of Cheshvan in the current year and the value of years is 1, the resulting date will be the 29th day of Cheshvan in the following year.

The month part of the resulting DateTime is affected if the resulting month is not a valid month in the resulting year. It is changed to the last valid month in the resulting year. For example, if the month in the time parameter is the 13th month of a leap year and the value of years is 1, the month in the resulting DateTime is the 12th month of the following year, which is a non-leap year. Note that even when the month part does not change, it might still refer to a different month. For example, Adar Beit is the 7th month in leap years, but Nissan is the 7th month in common years.

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.

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

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

code reference: System.Globalization.Calendar.AddMethods#8

Requirements

Namespace: System.Globalization
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0