DateTimeOffset.ToLocalTime Method
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Converts the current DateTimeOffset object to a DateTimeOffset object that represents the local time.
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Public Function ToLocalTime As DateTimeOffset
public DateTimeOffset ToLocalTime()
Return Value
Type: System.DateTimeOffset
An object that represents the date and time of the current DateTimeOffset object converted to local time.
Remarks
In performing the conversion to local time, the method first converts the current DateTimeOffset object's date and time to Coordinated Universal Time (UTC) by subtracting the offset from the time. It then converts the UTC date and time to local time by adding the local time zone offset. In doing this, it takes account of any adjustment rules for the local time zone.
Both the value of the current DateTimeOffset object and the value of the DateTimeOffset object returned by the method call represent the same point in time. That is, if both are passed to the DateTimeOffset.Equals(DateTimeOffset, DateTimeOffset) method, the method will return true.
If the conversion causes a time that is out of range of the DateTimeOffset type, the ToLocalTime method returns a DateTimeOffset object that has the date and time set to either MaxValue or MinValue and the offset set to the local time zone offset.
Examples
The following example uses the ToLocalTime method to convert a DateTimeOffset value to local time in the Pacific Standard Time zone. It also illustrates the method's support for the local time zone's adjustment rules.
' Local time changes on 3/11/2007 at 2:00 AM
Dim originalTime, localTime As DateTimeOffset
originalTime = New DateTimeOffset(#3/11/2007 3:00:00 AM#, _
New TimeSpan(-6, 0, 0))
localTime = originalTime.ToLocalTime()
outputBlock.Text += String.Format("Converted {0} to {1}.", originalTime.ToString() & vbCrLf, _
localTime.ToString())
originalTime = New DateTimeOffset(#3/11/2007 4:00:00 AM#, _
New TimeSpan(-6, 0, 0))
localTime = originalTime.ToLocalTime()
outputBlock.Text += String.Format("Converted {0} to {1}.", originalTime.ToString() & vbCrLf, _
localTime.ToString())
' Define a summer UTC time
originalTime = New DateTimeOffset(#6/15/2007 8:00:00 AM#, _
TimeSpan.Zero)
localTime = originalTime.ToLocalTime()
outputBlock.Text += String.Format("Converted {0} to {1}.", originalTime.ToString() & vbCrLf, _
localTime.ToString())
' Define a winter time
originalTime = New DateTimeOffset(#11/30/2007 2:00:00 PM#, _
New TimeSpan(3, 0, 0))
localTime = originalTime.ToLocalTime()
outputBlock.Text += String.Format("Converted {0} to {1}.", originalTime.ToString() & vbCrLf, _
localTime.ToString())
' The example produces the following output:
' Converted 3/11/2007 3:00:00 AM -06:00 to 3/11/2007 1:00:00 AM -08:00.
' Converted 3/11/2007 4:00:00 AM -06:00 to 3/11/2007 3:00:00 AM -07:00.
' Converted 6/15/2007 8:00:00 AM +00:00 to 6/15/2007 1:00:00 AM -07:00.
' Converted 11/30/2007 2:00:00 PM +03:00 to 11/30/2007 3:00:00 AM -08:00.
// Local time changes on 3/11/2007 at 2:00 AM
DateTimeOffset originalTime, localTime;
originalTime = new DateTimeOffset(2007, 3, 11, 3, 0, 0,
new TimeSpan(-6, 0, 0));
localTime = originalTime.ToLocalTime();
outputBlock.Text += String.Format("Converted {0} to {1}.", originalTime.ToString(),
localTime.ToString()) + "\n";
originalTime = new DateTimeOffset(2007, 3, 11, 4, 0, 0,
new TimeSpan(-6, 0, 0));
localTime = originalTime.ToLocalTime();
outputBlock.Text += String.Format("Converted {0} to {1}.", originalTime.ToString(),
localTime.ToString()) + "\n";
// Define a summer UTC time
originalTime = new DateTimeOffset(2007, 6, 15, 8, 0, 0,
TimeSpan.Zero);
localTime = originalTime.ToLocalTime();
outputBlock.Text += String.Format("Converted {0} to {1}.", originalTime.ToString(),
localTime.ToString()) + "\n";
// Define a winter time
originalTime = new DateTimeOffset(2007, 11, 30, 14, 0, 0,
new TimeSpan(3, 0, 0));
localTime = originalTime.ToLocalTime();
outputBlock.Text += String.Format("Converted {0} to {1}.", originalTime.ToString(),
localTime.ToString()) + "\n";
// The example produces the following output:
// Converted 3/11/2007 3:00:00 AM -06:00 to 3/11/2007 1:00:00 AM -08:00.
// Converted 3/11/2007 4:00:00 AM -06:00 to 3/11/2007 3:00:00 AM -07:00.
// Converted 6/15/2007 8:00:00 AM +00:00 to 6/15/2007 1:00:00 AM -07:00.
// Converted 11/30/2007 2:00:00 PM +03:00 to 11/30/2007 3:00:00 AM -08:00.
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.