DateTimeOffset.AddMonths(Int32) Method

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Source:

DateTimeOffset.cs

Returns a new DateTimeOffset object that adds a specified number of months to the value of this instance.

public:
 DateTimeOffset AddMonths(int months);

public DateTimeOffset AddMonths (int months);

member this.AddMonths : int -> DateTimeOffset

Public Function AddMonths (months As Integer) As DateTimeOffset

Parameters

months

Int32

A number of whole months. The number can be negative or positive.

Returns

DateTimeOffset

An object whose value is the sum of the date and time represented by the current DateTimeOffset object and the number of months represented by months.

Exceptions

ArgumentOutOfRangeException

The resulting DateTimeOffset value is less than DateTimeOffset.MinValue.

-or-

The resulting DateTimeOffset value is greater than DateTimeOffset.MaxValue.

Examples

The following example uses the AddMonths method to display the start date of each quarter of the year 2007.

DateTimeOffset quarterDate = new DateTimeOffset(2007, 1, 1, 0, 0, 0,
                                 DateTimeOffset.Now.Offset);
for (int ctr = 1; ctr <= 4; ctr++)
{
   Console.WriteLine("Quarter {0}: {1:MMMM d}", ctr, quarterDate);
   quarterDate = quarterDate.AddMonths(3);
}
// This example produces the following output:
//       Quarter 1: January 1
//       Quarter 2: April 1
//       Quarter 3: July 1
//       Quarter 4: October 1

let mutable quarterDate = DateTimeOffset(2007, 1, 1, 0, 0, 0, DateTimeOffset.Now.Offset)
for i = 1 to 4 do
    printfn $"""Quarter {i}: {quarterDate.ToString "MMMM d"}"""
    quarterDate <- quarterDate.AddMonths 3

// This example produces the following output:
//       Quarter 1: January 1
//       Quarter 2: April 1
//       Quarter 3: July 1
//       Quarter 4: October 1

Dim quarterDate As New DateTimeOffset(#01/01/2007#, DateTimeOffset.Now.Offset)
For ctr As Integer = 1 To 4
   Console.WriteLine("Quarter {0}: {1:MMMM d}", ctr, quarterDate)
   quarterDate = quarterDate.AddMonths(3)
Next   
' This example produces the following output:
'       Quarter 1: January 1
'       Quarter 2: April 1
'       Quarter 3: July 1
'       Quarter 4: October 1

Remarks

Unlike most of the other methods that add a single time interval unit (such as minutes or days) to a date and time value, AddMonths does not enable you to add fractional parts of a month. To add a time that consists of other time units in addition to months to a DateTimeOffset object, use the Add method.

Note

This method returns a new DateTimeOffset object. It does not modify the value of the current object by adding months to its date and time.