Struct ZonedDateTime
A
LocalDateTime in a specific time zone and with a particular offset to distinguish
between otherwise-ambiguous instants. A
ZonedDateTime is global, in that it maps to a single
Instant.
Since 1.4.x
Availability net45, netstandard1.3
Implements
IFormattable
IXmlSerializable
ISerializable
Inherited Members
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetType()
Assembly: NodaTime.dll
Syntax
[Serializable]
public struct ZonedDateTime : IEquatable<ZonedDateTime>, IFormattable, IXmlSerializable, ISerializable
Constructors
ZonedDateTime(Instant, DateTimeZone)
Initializes a new instance of the
ZonedDateTime struct in the specified time zone
and the ISO calendar.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public ZonedDateTime(Instant instant, DateTimeZone zone)
Parameters
Exceptions
Type |
Condition |
ArgumentNullException |
zone is null. |
ZonedDateTime(Instant, DateTimeZone, CalendarSystem)
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public ZonedDateTime(Instant instant, DateTimeZone zone, CalendarSystem calendar)
Parameters
Exceptions
Type |
Condition |
ArgumentNullException |
zone or calendar is null |
ZonedDateTime(LocalDateTime, DateTimeZone, Offset)
Initializes a new instance of the
ZonedDateTime struct in the specified time zone
from a given local time and offset. The offset is validated to be correct as part of initialization.
In most cases a local time can only map to a single instant anyway, but the offset is included here for cases
where the local time is ambiguous, usually due to daylight saving transitions.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public ZonedDateTime(LocalDateTime localDateTime, DateTimeZone zone, Offset offset)
Parameters
Type |
Name |
Description |
LocalDateTime |
localDateTime |
The local date and time. |
DateTimeZone |
zone |
The time zone. |
Offset |
offset |
The offset between UTC and local time at the desired instant. |
Exceptions
Type |
Condition |
ArgumentException |
offset is not a valid offset at the given
local date and time. |
ArgumentNullException |
zone is null. |
Properties
Calendar
Gets the calendar system associated with this zoned date and time.
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public CalendarSystem Calendar { get; }
Property Value
Type |
Description |
CalendarSystem |
The calendar system associated with this zoned date and time. |
ClockHourOfHalfDay
Gets the hour of the half-day of this zoned date and time, in the range 1 to 12 inclusive.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public int ClockHourOfHalfDay { get; }
Property Value
Type |
Description |
Int32 |
The hour of the half-day of this zoned date and time, in the range 1 to 12 inclusive. |
Date
Gets the local date represented by this zoned date and time.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public LocalDate Date { get; }
Property Value
Type |
Description |
LocalDate |
The local date represented by this zoned date and time. |
Day
Gets the day of this zoned date and time within the month.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
Property Value
Type |
Description |
Int32 |
The day of this zoned date and time within the month. |
DayOfWeek
Gets the week day of this zoned date and time expressed as an
IsoDayOfWeek value.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public IsoDayOfWeek DayOfWeek { get; }
Property Value
Type |
Description |
IsoDayOfWeek |
The week day of this zoned date and time expressed as an IsoDayOfWeek value. |
DayOfYear
Gets the day of this zoned date and time within the year.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public int DayOfYear { get; }
Property Value
Type |
Description |
Int32 |
The day of this zoned date and time within the year. |
Era
Gets the era for this zoned date and time.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
Property Value
Type |
Description |
Era |
The era for this zoned date and time. |
Hour
Gets the hour of day of this zoned date and time, in the range 0 to 23 inclusive.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
Property Value
Type |
Description |
Int32 |
The hour of day of this zoned date and time, in the range 0 to 23 inclusive. |
LocalDateTime
Gets the local date and time represented by this zoned date and time.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public LocalDateTime LocalDateTime { get; }
Property Value
Type |
Description |
LocalDateTime |
The local date and time represented by this zoned date and time. |
Millisecond
Gets the millisecond of this zoned date and time within the second, in the range 0 to 999 inclusive.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public int Millisecond { get; }
Property Value
Type |
Description |
Int32 |
The millisecond of this zoned date and time within the second, in the range 0 to 999 inclusive. |
Minute
Gets the minute of this zoned date and time, in the range 0 to 59 inclusive.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public int Minute { get; }
Property Value
Type |
Description |
Int32 |
The minute of this zoned date and time, in the range 0 to 59 inclusive. |
Month
Gets the month of this zoned date and time within the year.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public int Month { get; }
Property Value
Type |
Description |
Int32 |
The month of this zoned date and time within the year. |
NanosecondOfDay
Gets the nanosecond of this zoned date and time within the day, in the range 0 to 86,399,999,999,999 inclusive.
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public long NanosecondOfDay { get; }
Property Value
Type |
Description |
Int64 |
The nanosecond of this zoned date and time within the day, in the range 0 to 86,399,999,999,999 inclusive. |
NanosecondOfSecond
Gets the nanosecond of this zoned date and time within the second, in the range 0 to 999,999,999 inclusive.
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public int NanosecondOfSecond { get; }
Property Value
Type |
Description |
Int32 |
The nanosecond of this zoned date and time within the second, in the range 0 to 999,999,999 inclusive. |
Offset
Gets the offset of the local representation of this value from UTC.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public Offset Offset { get; }
Property Value
Type |
Description |
Offset |
The offset of the local representation of this value from UTC. |
Second
Gets the second of this zoned date and time within the minute, in the range 0 to 59 inclusive.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public int Second { get; }
Property Value
Type |
Description |
Int32 |
The second of this zoned date and time within the minute, in the range 0 to 59 inclusive. |
TickOfDay
Gets the tick of this zoned date and time within the day, in the range 0 to 863,999,999,999 inclusive.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public long TickOfDay { get; }
Property Value
Type |
Description |
Int64 |
The tick of this zoned date and time within the day, in the range 0 to 863,999,999,999 inclusive. |
TickOfSecond
Gets the tick of this zoned date and time within the second, in the range 0 to 9,999,999 inclusive.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public int TickOfSecond { get; }
Property Value
Type |
Description |
Int32 |
The tick of this zoned date and time within the second, in the range 0 to 9,999,999 inclusive. |
TimeOfDay
Gets the time portion of this zoned date and time.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public LocalTime TimeOfDay { get; }
Property Value
Type |
Description |
LocalTime |
The time portion of this zoned date and time. |
Year
Gets the year of this zoned date and time.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
Property Value
Type |
Description |
Int32 |
The year of this zoned date and time. |
YearOfEra
Gets the year of this zoned date and time within its era.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public int YearOfEra { get; }
Property Value
Type |
Description |
Int32 |
The year of this zoned date and time within its era. |
Zone
Gets the time zone associated with this value.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public DateTimeZone Zone { get; }
Property Value
Type |
Description |
DateTimeZone |
The time zone associated with this value. |
Methods
Add(ZonedDateTime, Duration)
Adds a duration to a zoned date and time.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public static ZonedDateTime Add(ZonedDateTime zonedDateTime, Duration duration)
Parameters
Type |
Name |
Description |
ZonedDateTime |
zonedDateTime |
The value to add the duration to. |
Duration |
duration |
The duration to add |
Returns
Type |
Description |
ZonedDateTime |
A new value with the time advanced by the given duration, in the same calendar system and time zone. |
Equals(ZonedDateTime)
Indicates whether the current object is equal to another object of the same type.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public bool Equals(ZonedDateTime other)
Parameters
Type |
Name |
Description |
ZonedDateTime |
other |
An object to compare with this object. |
Returns
Type |
Description |
Boolean |
true if the current object is equal to the other parameter; otherwise, false.
|
Equals(Object)
Indicates whether this instance and a specified object are equal.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public override bool Equals(object obj)
Parameters
Type |
Name |
Description |
Object |
obj |
Another object to compare to. |
Returns
Type |
Description |
Boolean |
true if obj and this instance are the same type and represent the same value; otherwise, false.
|
Overrides
System.ValueType.Equals(System.Object)
FromDateTimeOffset(DateTimeOffset)
Returns a new
ZonedDateTime representing the same instant in time as the given
System.DateTimeOffset.
The time zone used will be a fixed time zone, which uses the same offset throughout time.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public static ZonedDateTime FromDateTimeOffset(DateTimeOffset dateTimeOffset)
Parameters
Type |
Name |
Description |
DateTimeOffset |
dateTimeOffset |
Date and time value with an offset. |
Returns
GetHashCode()
Computes the hash code for this instance.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public override int GetHashCode()
Returns
Type |
Description |
Int32 |
A 32-bit signed integer that is the hash code for this instance.
|
Overrides
System.ValueType.GetHashCode()
GetZoneInterval()
Returns the
ZoneInterval containing this value, in the time zone this
value refers to.
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public ZoneInterval GetZoneInterval()
Returns
Type |
Description |
ZoneInterval |
The ZoneInterval containing this value. |
IsDaylightSavingTime()
Indicates whether or not this
ZonedDateTime is in daylight saving time
for its time zone. This is determined by checking the
Savings property
of the zone interval containing this value.
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public bool IsDaylightSavingTime()
Returns
Type |
Description |
Boolean |
true if the zone interval containing this value has a non-zero savings
component; false otherwise. |
See Also
Minus(Duration)
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public ZonedDateTime Minus(Duration duration)
Parameters
Type |
Name |
Description |
Duration |
duration |
The duration to subtract |
Returns
Minus(ZonedDateTime)
Returns the result of subtracting another zoned date and time from this one, resulting in the elapsed duration
between the two instants represented in the values.
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public Duration Minus(ZonedDateTime other)
Parameters
Type |
Name |
Description |
ZonedDateTime |
other |
The zoned date and time to subtract from this one. |
Returns
Type |
Description |
Duration |
The elapsed duration from other to this value. |
Plus(Duration)
Returns the result of adding a duration to this zoned date and time.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public ZonedDateTime Plus(Duration duration)
Parameters
Type |
Name |
Description |
Duration |
duration |
The duration to add |
Returns
PlusHours(Int32)
Returns the result of adding a increment of hours to this zoned date and time
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public ZonedDateTime PlusHours(int hours)
Parameters
Type |
Name |
Description |
Int32 |
hours |
The number of hours to add |
Returns
PlusMilliseconds(Int64)
Returns the result of adding an increment of milliseconds to this zoned date and time
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public ZonedDateTime PlusMilliseconds(long milliseconds)
Parameters
Type |
Name |
Description |
Int64 |
milliseconds |
The number of milliseconds to add |
Returns
PlusMinutes(Int32)
Returns the result of adding an increment of minutes to this zoned date and time
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public ZonedDateTime PlusMinutes(int minutes)
Parameters
Type |
Name |
Description |
Int32 |
minutes |
The number of minutes to add |
Returns
PlusNanoseconds(Int64)
Returns the result of adding an increment of nanoseconds to this zoned date and time
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public ZonedDateTime PlusNanoseconds(long nanoseconds)
Parameters
Type |
Name |
Description |
Int64 |
nanoseconds |
The number of nanoseconds to add |
Returns
PlusSeconds(Int64)
Returns the result of adding an increment of seconds to this zoned date and time
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public ZonedDateTime PlusSeconds(long seconds)
Parameters
Type |
Name |
Description |
Int64 |
seconds |
The number of seconds to add |
Returns
PlusTicks(Int64)
Returns the result of adding an increment of ticks to this zoned date and time
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public ZonedDateTime PlusTicks(long ticks)
Parameters
Type |
Name |
Description |
Int64 |
ticks |
The number of ticks to add |
Returns
Subtract(ZonedDateTime, Duration)
Subtracts a duration from a zoned date and time.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public static ZonedDateTime Subtract(ZonedDateTime zonedDateTime, Duration duration)
Parameters
Type |
Name |
Description |
ZonedDateTime |
zonedDateTime |
The value to subtract the duration from. |
Duration |
duration |
The duration to subtract. |
Returns
Type |
Description |
ZonedDateTime |
A new value with the time "rewound" by the given duration, in the same calendar system and time zone. |
Subtract(ZonedDateTime, ZonedDateTime)
Subtracts one zoned date and time from another, returning an elapsed duration.
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public static Duration Subtract(ZonedDateTime end, ZonedDateTime start)
Parameters
Type |
Name |
Description |
ZonedDateTime |
end |
The zoned date and time value to subtract from; if this is later than start
then the result will be positive. |
ZonedDateTime |
start |
The zoned date and time to subtract from end . |
Returns
Type |
Description |
Duration |
The elapsed duration from start to end . |
ToDateTimeOffset()
Constructs a System.DateTimeOffset value with the same local time and offset from
UTC as this value.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public DateTimeOffset ToDateTimeOffset()
Returns
Type |
Description |
DateTimeOffset |
A DateTimeOffset with the same local date/time and offset as this. The System.DateTime part of
the result always has a "kind" of Unspecified. |
Exceptions
Type |
Condition |
System.InvalidOperationException |
The date/time is outside the range of DateTimeOffset ,
or the offset is outside the range of +/-14 hours (the range supported by DateTimeOffset ). |
ToDateTimeUnspecified()
Constructs a
System.DateTime from this
ZonedDateTime which has a
System.DateTime.Kind of
System.DateTimeKind.Unspecified and represents the same local time as
this value rather than the same instant in time.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public DateTime ToDateTimeUnspecified()
Returns
Type |
Description |
DateTime |
A System.DateTime representation of this value with an "unspecified" kind, with the same
local date and time as this value. |
Exceptions
Type |
Condition |
System.InvalidOperationException |
The date/time is outside the range of DateTime . |
ToDateTimeUtc()
Constructs a
System.DateTime from this
ZonedDateTime which has a
System.DateTime.Kind of
System.DateTimeKind.Utc and represents the same instant of time as
this value rather than the same local time.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public DateTime ToDateTimeUtc()
Returns
Type |
Description |
DateTime |
A System.DateTime representation of this value with a "universal" kind, with the same
instant of time as this value. |
Exceptions
Type |
Condition |
System.InvalidOperationException |
The final date/time is outside the range of DateTime . |
ToInstant()
Converts this value to the instant it represents on the time line.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public Instant ToInstant()
Returns
Type |
Description |
Instant |
The instant corresponding to this value. |
ToOffsetDateTime()
Constructs an
OffsetDateTime with the same local date and time, and the same offset
as this zoned date and time, effectively just "removing" the time zone itself.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public OffsetDateTime ToOffsetDateTime()
Returns
Type |
Description |
OffsetDateTime |
An OffsetDateTime with the same local date/time and offset as this value. |
ToString()
Returns a System.String that represents this instance.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public override string ToString()
Returns
Type |
Description |
String |
The value of the current instance in the default format pattern ("G"), using the current thread's
culture to obtain a format provider.
|
Overrides
System.ValueType.ToString()
Formats the value of the current instance using the specified pattern.
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public string ToString(string patternText, IFormatProvider formatProvider)
Parameters
Type |
Name |
Description |
String |
patternText |
The System.String specifying the pattern to use,
or null to use the default format pattern ("G").
|
IFormatProvider |
formatProvider |
The System.IFormatProvider to use when formatting the value,
or null to use the current thread's culture to obtain a format provider.
|
Returns
Type |
Description |
String |
A System.String containing the value of the current instance in the specified format.
|
WithCalendar(CalendarSystem)
Creates a new ZonedDateTime representing the same physical date, time and offset, but in a different calendar.
The returned ZonedDateTime is likely to have different date field values to this one.
For example, January 1st 1970 in the Gregorian calendar was December 19th 1969 in the Julian calendar.
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public ZonedDateTime WithCalendar(CalendarSystem calendar)
Parameters
Type |
Name |
Description |
CalendarSystem |
calendar |
The calendar system to convert this zoned date and time to. |
Returns
Exceptions
Type |
Condition |
ArgumentNullException |
calendar is null. |
WithZone(DateTimeZone)
Creates a new
ZonedDateTime representing the same instant in time, in the
same calendar but a different time zone.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public ZonedDateTime WithZone(DateTimeZone targetZone)
Parameters
Type |
Name |
Description |
DateTimeZone |
targetZone |
The target time zone to convert to. |
Returns
Type |
Description |
ZonedDateTime |
A new value in the target time zone. |
Exceptions
Type |
Condition |
ArgumentNullException |
targetZone is null. |
Operators
Addition(ZonedDateTime, Duration)
Returns a new
ZonedDateTime with the time advanced by the given duration. Note that
due to daylight saving time changes this may not advance the local time by the same amount.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public static ZonedDateTime operator +(ZonedDateTime zonedDateTime, Duration duration)
Parameters
Returns
Type |
Description |
ZonedDateTime |
A new value with the time advanced by the given duration, in the same calendar system and time zone. |
Equality(ZonedDateTime, ZonedDateTime)
Implements the operator ==.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public static bool operator ==(ZonedDateTime left, ZonedDateTime right)
Parameters
Returns
Type |
Description |
Boolean |
True if the two operands are equal according to Equals(ZonedDateTime); false otherwise |
Inequality(ZonedDateTime, ZonedDateTime)
Implements the operator !=.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public static bool operator !=(ZonedDateTime left, ZonedDateTime right)
Parameters
Returns
Type |
Description |
Boolean |
False if the two operands are equal according to Equals(ZonedDateTime); true otherwise |
Subtraction(ZonedDateTime, Duration)
Returns a new
ZonedDateTime with the duration subtracted. Note that
due to daylight saving time changes this may not change the local time by the same amount.
Since 1.4.x
Availability net45, netstandard1.3
Declaration
public static ZonedDateTime operator -(ZonedDateTime zonedDateTime, Duration duration)
Parameters
Type |
Name |
Description |
ZonedDateTime |
zonedDateTime |
The value to subtract the duration from. |
Duration |
duration |
The duration to subtract. |
Returns
Type |
Description |
ZonedDateTime |
A new value with the time "rewound" by the given duration, in the same calendar system and time zone. |
Subtraction(ZonedDateTime, ZonedDateTime)
Subtracts one
ZonedDateTime from another, resulting in the elapsed time between
the two values.
Since 3.1.x
Availability net45, netstandard1.3
Declaration
public static Duration operator -(ZonedDateTime end, ZonedDateTime start)
Parameters
Type |
Name |
Description |
ZonedDateTime |
end |
The zoned date and time value to subtract from; if this is later than start
then the result will be positive. |
ZonedDateTime |
start |
The zoned date and time to subtract from end . |
Returns
Type |
Description |
Duration |
The elapsed duration from start to end . |
Explicit Interface Implementations
ISerializable.GetObjectData(SerializationInfo, StreamingContext)
Implementation of System.Runtime.Serialization.ISerializable.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext).
Since 2.0.x
Availability net45
Declaration
[SecurityCritical]
void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
Type |
Name |
Description |
SerializationInfo |
info |
The System.Runtime.Serialization.SerializationInfo to populate with data. |
StreamingContext |
context |
The destination for this serialization. |
IXmlSerializable.GetSchema()
Since unstable
Availability net45, netstandard1.3
Declaration
XmlSchema IXmlSerializable.GetSchema()
Returns
Type |
Description |
XmlSchema |
|
IXmlSerializable.ReadXml(XmlReader)
Since 3.1.x
Availability net45, netstandard1.3
Declaration
void IXmlSerializable.ReadXml(XmlReader reader)
Parameters
Type |
Name |
Description |
XmlReader |
reader |
|
Exceptions
Type |
Condition |
ArgumentNullException |
reader is null. |
IXmlSerializable.WriteXml(XmlWriter)
Since 3.1.x
Availability net45, netstandard1.3
Declaration
void IXmlSerializable.WriteXml(XmlWriter writer)
Parameters
Type |
Name |
Description |
XmlWriter |
writer |
|
Exceptions
Type |
Condition |
ArgumentNullException |
writer is null. |
Implements
System.IEquatable<T>
System.IFormattable
System.Xml.Serialization.IXmlSerializable
System.Runtime.Serialization.ISerializable