Article
11/17/2011

DateTimeOffset.Add Method

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

Adds a specified time interval to a DateTimeOffset object.

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

Syntax

'Declaration
Public Function Add ( _
    timeSpan As TimeSpan _
) As DateTimeOffset

public DateTimeOffset Add(
    TimeSpan timeSpan
)

Parameters

timeSpan
Type: System.TimeSpan
A TimeSpan object that represents a positive or a negative time interval.

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 time interval represented by timeSpan.

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

You can use the Add method to add more than one kind of time interval (days, hours, minutes, seconds, or milliseconds) in a single operation. This method's behavior is identical to the addition operator. The DateTimeOffset structure also supports specialized addition methods (such as AddDays, AddHours, and AddMinutes) for each time interval.

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

The Add method does not affect the value of the current DateTimeOffset object's Offset property.

Because a DateTimeOffset object does not represent the date and time in a specific time zone, the Add method does not consider a particular time zone's adjustment rules when it performs date and time arithmetic.

If the timeSpan parameter is nulla null reference (Nothing in Visual Basic), this method returns the value of the original DateTimeOffset object unchanged.

Examples

The following example creates an array of TimeSpan objects that represent the flight times between destinations. The Add method then adds these times to a DateTimeOffset object that represents a flight's initial takeoff time. The result reflects the scheduled arrival time at each destination.

Dim takeOff As New DateTimeOffset(#6/1/2007 7:55:00 AM#, _
                                  New TimeSpan(-5, 0, 0))
Dim currentTime As DateTimeOffset = takeOff
Dim flightTimes() As TimeSpan = New TimeSpan() _
                  {New TimeSpan(2, 25, 0), New TimeSpan(1, 48, 0)}
outputBlock.Text += String.Format("Takeoff is scheduled for {0:d} at {0:T}.", _
                  takeOff) + vbCrLf
For ctr As Integer = flightTimes.GetLowerBound(0) To _
                     flightTimes.GetUpperBound(0)
   currentTime = currentTime.Add(flightTimes(ctr))
   outputBlock.Text += String.Format("Destination #{0} at {1}.", ctr + 1, currentTime) & vbCrLf
Next

DateTimeOffset takeOff = new DateTimeOffset(2007, 6, 1, 7, 55, 0,
                             new TimeSpan(-5, 0, 0));
DateTimeOffset currentTime = takeOff;
TimeSpan[] flightTimes = new TimeSpan[] { new TimeSpan(2, 25, 0), new TimeSpan(1, 48, 0) };
outputBlock.Text += String.Format("Takeoff is scheduled for {0:d} at {0:T}.",
                  takeOff) + "\n";
for (int ctr = flightTimes.GetLowerBound(0);
     ctr <= flightTimes.GetUpperBound(0); ctr++)
{
   currentTime = currentTime.Add(flightTimes[ctr]);
   outputBlock.Text += String.Format("Destination #{0} at {1}.", ctr + 1, currentTime) + "\n";
}

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