Article
11/18/2011

DateTimeOffset.AddMonths Method

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

Adds a specified number of months to the current DateTimeOffset object.

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

Syntax

'Declaration
Public Function AddMonths ( _
    months As Integer _
) As DateTimeOffset

public DateTimeOffset AddMonths(
    int months
)

Parameters

months
Type: System.Int32
A number of whole months. The number can be negative or positive.

Return Value

Type: System.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

Exception	Condition
ArgumentOutOfRangeException	The resulting DateTimeOffset value is less than MinValue. -or- The resulting DateTimeOffset value is greater than MaxValue.

ArgumentOutOfRangeException

The resulting DateTimeOffset value is less than MinValue.

-or-

The resulting DateTimeOffset value is greater than MaxValue.

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.

Examples

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

Dim quarterDate As New DateTimeOffset(#1/1/2007#, DateTimeOffset.Now.Offset)
For ctr As Integer = 1 To 4
   outputBlock.Text += String.Format("Quarter {0}: {1:MMMM d}", ctr, quarterDate) & vbCrLf
   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

DateTimeOffset quarterDate = new DateTimeOffset(2007, 1, 1, 0, 0, 0,
                                 DateTimeOffset.Now.Offset);
for (int ctr = 1; ctr <= 4; ctr++)
{
   outputBlock.Text += String.Format("Quarter {0}: {1:MMMM d}", ctr, quarterDate) + "\n";
   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

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.

Partager via