Struct LocalDateTime
A date and time in a particular calendar system. A LocalDateTime value does not represent an
instant on the global time line, because it has no associated time zone: "November 12th 2009 7pm, ISO calendar"
occurred at different instants for different people around the world.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Implements
IEquatable<LocalDateTime>
IComparable<LocalDateTime>
IComparable
IFormattable
IXmlSerializable
ISerializable
Inherited Members
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetType()
Namespace: NodaTime
Assembly: NodaTime.dll
Syntax
[Serializable]
public struct LocalDateTime : IEquatable<LocalDateTime>, IComparable<LocalDateTime>, IComparable, IFormattable, IXmlSerializable, ISerializableRemarks
This type defaults to using the ISO calendar system unless a different calendar system is specified.
Values can freely be compared for equality: a value in a different calendar system is not equal to a value in a different calendar system. However, ordering comparisons (either via the CompareTo(LocalDateTime) method or via operators) fail with System.ArgumentException; attempting to compare values in different calendars almost always indicates a bug in the calling code.
Constructors
LocalDateTime(Int32, Int32, Int32, Int32, Int32)
Initializes a new instance of the LocalDateTime struct using the ISO calendar system.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime(int year, int month, int day, int hour, int minute)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | year | The year. This is the "absolute year", so a value of 0 means 1 BC, for example. |
| Int32 | month | The month of year. |
| Int32 | day | The day of month. |
| Int32 | hour | The hour. |
| Int32 | minute | The minute. |
Sample snippet
using NodaTime;
using NodaTime.Text;
using System;
LocalDateTime dt = new LocalDateTime(2010, 6, 16, 16, 20);
Console.WriteLine(LocalDateTimePattern.GeneralIso.Format(dt));
Console.WriteLine(dt.Calendar);
Output:
2010-06-16T16:20:00
ISO
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | The parameters do not form a valid date/time. |
LocalDateTime(Int32, Int32, Int32, Int32, Int32, CalendarSystem)
Initializes a new instance of the LocalDateTime struct.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime(int year, int month, int day, int hour, int minute, CalendarSystem calendar)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | year | The year. This is the "absolute year", so, for the ISO calendar, a value of 0 means 1 BC, for example. |
| Int32 | month | The month of year. |
| Int32 | day | The day of month. |
| Int32 | hour | The hour. |
| Int32 | minute | The minute. |
| CalendarSystem | calendar | The calendar. |
Sample snippet
using NodaTime;
using System;
CalendarSystem calendar = CalendarSystem.Iso;
LocalDateTime dt = new LocalDateTime(2010, 6, 16, 16, 20, calendar);
Console.WriteLine(dt.Minute);
Output:
20
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | The parameters do not form a valid date/time. |
| ArgumentNullException | calendar is null. |
LocalDateTime(Int32, Int32, Int32, Int32, Int32, Int32)
Initializes a new instance of the LocalDateTime struct using the ISO calendar system.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime(int year, int month, int day, int hour, int minute, int second)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | year | The year. This is the "absolute year", so a value of 0 means 1 BC, for example. |
| Int32 | month | The month of year. |
| Int32 | day | The day of month. |
| Int32 | hour | The hour. |
| Int32 | minute | The minute. |
| Int32 | second | The second. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | The parameters do not form a valid date/time. |
LocalDateTime(Int32, Int32, Int32, Int32, Int32, Int32, CalendarSystem)
Initializes a new instance of the LocalDateTime struct.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime(int year, int month, int day, int hour, int minute, int second, CalendarSystem calendar)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | year | The year. This is the "absolute year", so, for the ISO calendar, a value of 0 means 1 BC, for example. |
| Int32 | month | The month of year. |
| Int32 | day | The day of month. |
| Int32 | hour | The hour. |
| Int32 | minute | The minute. |
| Int32 | second | The second. |
| CalendarSystem | calendar | The calendar. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | The parameters do not form a valid date/time. |
| ArgumentNullException | calendar is null. |
LocalDateTime(Int32, Int32, Int32, Int32, Int32, Int32, Int32)
Initializes a new instance of the LocalDateTime struct using the ISO calendar system.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime(int year, int month, int day, int hour, int minute, int second, int millisecond)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | year | The year. This is the "absolute year", so a value of 0 means 1 BC, for example. |
| Int32 | month | The month of year. |
| Int32 | day | The day of month. |
| Int32 | hour | The hour. |
| Int32 | minute | The minute. |
| Int32 | second | The second. |
| Int32 | millisecond | The millisecond. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | The parameters do not form a valid date/time. |
LocalDateTime(Int32, Int32, Int32, Int32, Int32, Int32, Int32, CalendarSystem)
Initializes a new instance of the LocalDateTime struct.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime(int year, int month, int day, int hour, int minute, int second, int millisecond, CalendarSystem calendar)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | year | The year. This is the "absolute year", so, for the ISO calendar, a value of 0 means 1 BC, for example. |
| Int32 | month | The month of year. |
| Int32 | day | The day of month. |
| Int32 | hour | The hour. |
| Int32 | minute | The minute. |
| Int32 | second | The second. |
| Int32 | millisecond | The millisecond. |
| CalendarSystem | calendar | The calendar. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | The parameters do not form a valid date/time. |
| ArgumentNullException | calendar is null. |
Properties
Calendar
Gets the calendar system associated with this local date and time.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public CalendarSystem Calendar { get; }Property Value
| Type | Description |
|---|---|
| CalendarSystem | The calendar system associated with this local date and time. (The value returned is never null.) |
ClockHourOfHalfDay
Gets the hour of the half-day of this local date and time, in the range 1 to 12 inclusive.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public int ClockHourOfHalfDay { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The hour of the half-day of this local date and time, in the range 1 to 12 inclusive. |
Date
Gets the date portion of this local date and time as a LocalDate in the same calendar system as this value.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDate Date { get; }Property Value
| Type | Description |
|---|---|
| LocalDate | The date portion of this local date and time as a LocalDate in the same calendar system as this value. |
Day
Gets the day of this local date and time within the month.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public int Day { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The day of this local date and time within the month. |
DayOfWeek
Gets the week day of this local date and time expressed as an IsoDayOfWeek value.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public IsoDayOfWeek DayOfWeek { get; }Property Value
| Type | Description |
|---|---|
| IsoDayOfWeek | The week day of this local date and time expressed as an IsoDayOfWeek. |
DayOfYear
Gets the day of this local date and time within the year.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public int DayOfYear { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The day of this local date and time within the year. |
Era
Gets the era of this local date and time.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public Era Era { get; }Property Value
| Type | Description |
|---|---|
| Era | The era of this local date and time. (The value returned is never null.) |
Hour
Gets the hour of day of this local date and time, in the range 0 to 23 inclusive.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public int Hour { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The hour of day of this local date and time, in the range 0 to 23 inclusive. |
Millisecond
Gets the millisecond of this local date and time within the second, in the range 0 to 999 inclusive.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public int Millisecond { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The millisecond of this local date and time within the second, in the range 0 to 999 inclusive. |
Minute
Gets the minute of this local date and time, in the range 0 to 59 inclusive.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public int Minute { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The minute of this local date and time, in the range 0 to 59 inclusive. |
Month
Gets the month of this local date and time within the year.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public int Month { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The month of this local date and time within the year. |
NanosecondOfDay
Gets the nanosecond of this local date and time within the day, in the range 0 to 86,399,999,999,999 inclusive.
Since 2.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public long NanosecondOfDay { get; }Property Value
| Type | Description |
|---|---|
| Int64 | The nanosecond of this local date and time within the day, in the range 0 to 86,399,999,999,999 inclusive. |
NanosecondOfSecond
Gets the nanosecond of this local time within the second, in the range 0 to 999,999,999 inclusive.
Since 2.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public int NanosecondOfSecond { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The nanosecond of this local time within the second, in the range 0 to 999,999,999 inclusive. |
Second
Gets the second of this local date and time within the minute, in the range 0 to 59 inclusive.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public int Second { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The second of this local date and time within the minute, in the range 0 to 59 inclusive. |
TickOfDay
Gets the tick of this local date and time within the day, in the range 0 to 863,999,999,999 inclusive.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public long TickOfDay { get; }Property Value
| Type | Description |
|---|---|
| Int64 | The tick of this local date and time within the day, in the range 0 to 863,999,999,999 inclusive. |
TickOfSecond
Gets the tick of this local time within the second, in the range 0 to 9,999,999 inclusive.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public int TickOfSecond { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The tick of this local time within the second, in the range 0 to 9,999,999 inclusive. |
TimeOfDay
Gets the time portion of this local date and time as a LocalTime.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalTime TimeOfDay { get; }Property Value
| Type | Description |
|---|---|
| LocalTime | The time portion of this local date and time as a LocalTime. |
Year
Gets the year of this local date and time.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public int Year { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The year of this local date and time. |
Remarks
This returns the "absolute year", so, for the ISO calendar,
a value of 0 means 1 BC, for example.
YearOfEra
Gets the year of this local date and time within its era.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public int YearOfEra { get; }Property Value
| Type | Description |
|---|---|
| Int32 | The year of this local date and time within its era. |
Methods
Add(LocalDateTime, Period)
Add the specified period to the date and time.
Fields are added in descending order of significance (years first, then months, and so on).
Friendly alternative to
operator+().
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static LocalDateTime Add(LocalDateTime localDateTime, Period period)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | localDateTime | Initial local date and time |
| Period | period | Period to add |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The resulting local date and time |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | period is null. |
CompareTo(LocalDateTime)
Indicates whether this date/time is earlier, later or the same as another one.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public int CompareTo(LocalDateTime other)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | other | The other local date/time to compare with this value. |
Returns
| Type | Description |
|---|---|
| Int32 | A value less than zero if this date/time is earlier than other;
zero if this date/time is the same as other; a value greater than zero if this date/time is
later than other. |
Remarks
Only date/time values within the same calendar systems can be compared with this method. Attempting to compare
values within different calendars will fail with an System.ArgumentException. Ideally, comparisons
is almost always preferable to continuing.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The calendar system of other is not the
same as the calendar system of this value. |
Deconstruct(out LocalDate, out LocalTime)
Deconstruct this LocalDateTime into its components.
Since 2.3.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public void Deconstruct(out LocalDate date, out LocalTime time)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDate | date | The date portion of the value. |
| LocalTime | time | The time portion of the value. |
Equals(LocalDateTime)
Indicates whether the current object is equal to another object of the same type.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public bool Equals(LocalDateTime other)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | 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)
Determines whether the specified System.Object is equal to this instance.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| Object | obj | The System.Object to compare with this instance. |
Returns
| Type | Description |
|---|---|
| Boolean |
true if the specified System.Object is equal to this instance;
otherwise, false.
|
Overrides
System.ValueType.Equals(System.Object)
FromDateTime(DateTime)
Converts a System.DateTime of any kind to a LocalDateTime in the ISO calendar. This does not perform
any time zone conversions, so a DateTime with a System.DateTime.Kind of System.DateTimeKind.Utc
will still have the same day/hour/minute etc - it won't be converted into the local system time.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static LocalDateTime FromDateTime(DateTime dateTime)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | dateTime | Value to convert into a Noda Time local date and time |
Returns
| Type | Description |
|---|---|
| LocalDateTime | A new LocalDateTime with the same values as the specified DateTime. |
FromDateTime(DateTime, CalendarSystem)
Converts a System.DateTime of any kind to a LocalDateTime in the specified calendar. This does not perform
any time zone conversions, so a DateTime with a System.DateTime.Kind of System.DateTimeKind.Utc
will still have the same day/hour/minute etc - it won't be converted into the local system time.
Since 2.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static LocalDateTime FromDateTime(DateTime dateTime, CalendarSystem calendar)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | dateTime | Value to convert into a Noda Time local date and time |
| CalendarSystem | calendar | The calendar system to convert into |
Returns
| Type | Description |
|---|---|
| LocalDateTime | A new LocalDateTime with the same values as the specified DateTime. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | calendar is null. |
GetHashCode()
Returns a hash code for this instance.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| Int32 | A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. |
Overrides
System.ValueType.GetHashCode()
InUtc()
Returns the mapping of this local date/time within Utc.
Since 1.1.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public ZonedDateTime InUtc()Returns
| Type | Description |
|---|---|
| ZonedDateTime | The result of mapping this local date/time in UTC. |
Remarks
As UTC is a fixed time zone, there is no chance that this local date/time is ambiguous or skipped.
InZone(DateTimeZone, ZoneLocalMappingResolver)
Resolves this local date and time into a ZonedDateTime in the given time zone, following
the given ZoneLocalMappingResolver to handle ambiguity and skipped times.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public ZonedDateTime InZone(DateTimeZone zone, ZoneLocalMappingResolver resolver)Parameters
| Type | Name | Description |
|---|---|---|
| DateTimeZone | zone | The time zone to map this local date and time into |
| ZoneLocalMappingResolver | resolver | The resolver to apply to the mapping. |
Returns
| Type | Description |
|---|---|
| ZonedDateTime | The result of resolving the mapping. |
Remarks
See InZoneStrictly(DateTimeZone) and InZoneLeniently(DateTimeZone) for alternative ways to map a local time
to a specific instant.
This is a convenience method for calling ResolveLocal(LocalDateTime, ZoneLocalMappingResolver).
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | zone or resolver is null |
InZoneLeniently(DateTimeZone)
Returns the mapping of this local date/time within the given DateTimeZone,
with "lenient" rules applied such that ambiguous values map to the earlier of the alternatives, and
"skipped" values are shifted forward by the duration of the "gap".
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public ZonedDateTime InZoneLeniently(DateTimeZone zone)Parameters
| Type | Name | Description |
|---|---|---|
| DateTimeZone | zone | The time zone in which to map this local date/time. |
Returns
| Type | Description |
|---|---|
| ZonedDateTime | The result of mapping this local date/time in the given time zone. |
Remarks
See InZoneStrictly(DateTimeZone) and InZone(DateTimeZone, ZoneLocalMappingResolver) for alternative ways to map a local time to a
specific instant.
This is solely a convenience method for calling AtLeniently(LocalDateTime).
Note: The behavior of this method was changed in version 2.0 to fit the most commonly seen real-world usage pattern. Previous versions returned the later instance of ambiguous values, and returned the start of the zone interval after the gap for skipped value. The previous functionality can still be used if desired, by using InZone(DateTimeZone, ZoneLocalMappingResolver) and passing a resolver that combines the ReturnLater and ReturnStartOfIntervalAfter resolvers.
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | zone is null. |
InZoneStrictly(DateTimeZone)
Returns the mapping of this local date/time within the given DateTimeZone,
with "strict" rules applied such that an exception is thrown if either the mapping is
ambiguous or the time is skipped.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public ZonedDateTime InZoneStrictly(DateTimeZone zone)Parameters
| Type | Name | Description |
|---|---|---|
| DateTimeZone | zone | The time zone in which to map this local date/time. |
Returns
| Type | Description |
|---|---|
| ZonedDateTime | The result of mapping this local date/time in the given time zone. |
Remarks
See InZoneLeniently(DateTimeZone) and InZone(DateTimeZone, ZoneLocalMappingResolver) for alternative ways to map a local time to a
specific instant.
This is solely a convenience method for calling AtStrictly(LocalDateTime).
Exceptions
| Type | Condition |
|---|---|
| SkippedTimeException | This local date/time is skipped in the given time zone. |
| AmbiguousTimeException | This local date/time is ambiguous in the given time zone. |
| ArgumentNullException | zone is null. |
Max(LocalDateTime, LocalDateTime)
Returns the later date/time of the given two.
Since 2.3.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static LocalDateTime Max(LocalDateTime x, LocalDateTime y)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | x | The first date/time to compare. |
| LocalDateTime | y | The second date/time to compare. |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The later date/time of x or y. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The two date/times have different calendar systems. |
Min(LocalDateTime, LocalDateTime)
Returns the earlier date/time of the given two.
Since 2.3.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static LocalDateTime Min(LocalDateTime x, LocalDateTime y)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | x | The first date/time to compare. |
| LocalDateTime | y | The second date/time to compare. |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The earlier date/time of x or y. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The two date/times have different calendar systems. |
Minus(LocalDateTime)
Subtracts the specified date/time from this date/time, returning the result as a Period.
Fluent alternative to
operator-().
Since 2.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public Period Minus(LocalDateTime localDateTime)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | localDateTime | The date/time to subtract from this |
Returns
| Type | Description |
|---|---|
| Period | The difference between the specified date/time and this one (The value returned is never null.) |
Remarks
The specified date/time must be in the same calendar system as this.
Minus(Period)
Subtracts a period from a local date/time.
Fields are subtracted in descending order of significance (years first, then months, and so on).
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime Minus(Period period)Parameters
| Type | Name | Description |
|---|---|---|
| Period | period | Period to subtract |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The resulting local date and time |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | period is null. |
Next(IsoDayOfWeek)
Returns the next LocalDateTime falling on the specified IsoDayOfWeek,
at the same time of day as this value.
This is a strict "next" - if this value on already falls on the target
day of the week, the returned value will be a week later.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime Next(IsoDayOfWeek targetDayOfWeek)Parameters
| Type | Name | Description |
|---|---|---|
| IsoDayOfWeek | targetDayOfWeek | The ISO day of the week to return the next date of. |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The next LocalDateTime falling on the specified day of the week. |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | The underlying calendar doesn't use ISO days of the week. |
| ArgumentOutOfRangeException | targetDayOfWeek is not a valid day of the
week (Monday to Sunday). |
Plus(Period)
Adds a period to this local date/time.
Fields are added in descending order of significance (years first, then months, and so on).
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime Plus(Period period)Parameters
| Type | Name | Description |
|---|---|---|
| Period | period | Period to add |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The resulting local date and time |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | period is null. |
PlusDays(Int32)
Returns a new LocalDateTime representing the current value with the given number of days added.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime PlusDays(int days)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | days | The number of days to add |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The current value plus the given number of days. |
Remarks
This method does not try to maintain the month or year of the current value, so adding 3 days to a value on January 30th will result in a value on February 2nd.
PlusHours(Int64)
Returns a new LocalDateTime representing the current value with the given number of hours added.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime PlusHours(long hours)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | hours | The number of hours to add |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The current value plus the given number of hours. |
PlusMilliseconds(Int64)
Returns a new LocalDateTime representing the current value with the given number of milliseconds added.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime PlusMilliseconds(long milliseconds)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | milliseconds | The number of milliseconds to add |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The current value plus the given number of milliseconds. |
PlusMinutes(Int64)
Returns a new LocalDateTime representing the current value with the given number of minutes added.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime PlusMinutes(long minutes)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | minutes | The number of minutes to add |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The current value plus the given number of minutes. |
PlusMonths(Int32)
Returns a new LocalDateTime representing the current value with the given number of months added.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime PlusMonths(int months)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | months | The number of months to add |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The current value plus the given number of months. |
Remarks
This method does not try to maintain the year of the current value, so adding four months to a value in October will result in a value in the following February.
If the resulting date is invalid, the day of month is reduced to find a valid value. For example, adding one month to January 30th 2011 will return February 28th 2011; subtracting one month from March 30th 2011 will return February 28th 2011.
PlusNanoseconds(Int64)
Returns a new LocalDateTime representing the current value with the given number of nanoseconds added.
Since 2.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime PlusNanoseconds(long nanoseconds)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | nanoseconds | The number of nanoseconds to add |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The current value plus the given number of nanoseconds. |
PlusSeconds(Int64)
Returns a new LocalDateTime representing the current value with the given number of seconds added.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime PlusSeconds(long seconds)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | seconds | The number of seconds to add |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The current value plus the given number of seconds. |
PlusTicks(Int64)
Returns a new LocalDateTime representing the current value with the given number of ticks added.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime PlusTicks(long ticks)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | ticks | The number of ticks to add |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The current value plus the given number of ticks. |
PlusWeeks(Int32)
Returns a new LocalDateTime representing the current value with the given number of weeks added.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime PlusWeeks(int weeks)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | weeks | The number of weeks to add |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The current value plus the given number of weeks. |
PlusYears(Int32)
Returns a new LocalDateTime representing the current value with the given number of years added.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime PlusYears(int years)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | years | The number of years to add |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The current value plus the given number of years. |
Remarks
If the resulting date is invalid, lower fields (typically the day of month) are reduced to find a valid value.
For example, adding one year to February 29th 2012 will return February 28th 2013; subtracting one year from
February 29th 2012 will return February 28th 2011.
Previous(IsoDayOfWeek)
Returns the previous LocalDateTime falling on the specified IsoDayOfWeek,
at the same time of day as this value.
This is a strict "previous" - if this value on already falls on the target
day of the week, the returned value will be a week earlier.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime Previous(IsoDayOfWeek targetDayOfWeek)Parameters
| Type | Name | Description |
|---|---|---|
| IsoDayOfWeek | targetDayOfWeek | The ISO day of the week to return the previous date of. |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The previous LocalDateTime falling on the specified day of the week. |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | The underlying calendar doesn't use ISO days of the week. |
| ArgumentOutOfRangeException | targetDayOfWeek is not a valid day of the
week (Monday to Sunday). |
Subtract(LocalDateTime, LocalDateTime)
Subtracts one date/time from another, returning the result as a Period.
Since 2.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static Period Subtract(LocalDateTime lhs, LocalDateTime rhs)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | lhs | The date/time to subtract from |
| LocalDateTime | rhs | The date/time to subtract |
Returns
| Type | Description |
|---|---|
| Period | The result of subtracting one date/time from another. (The value returned is never null.) |
Remarks
This is simply a convenience method for calling Between(LocalDateTime, LocalDateTime).
The calendar systems of the two date/times must be the same.
Subtract(LocalDateTime, Period)
Subtracts the specified period from the date and time. Friendly alternative to
operator-().
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static LocalDateTime Subtract(LocalDateTime localDateTime, Period period)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | localDateTime | Initial local date and time |
| Period | period | Period to subtract |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The resulting local date and time |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | period is null. |
ToDateTimeUnspecified()
Constructs a System.DateTime from this value which has a System.DateTime.Kind
of System.DateTimeKind.Unspecified.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public DateTime ToDateTimeUnspecified()Returns
| Type | Description |
|---|---|
| DateTime | A System.DateTime value for the same date and time as this value. |
Remarks
System.DateTimeKind.Unspecified is slightly odd - it can be treated as UTC if you use System.DateTime.ToLocalTime or as system local time if you use System.DateTime.ToUniversalTime, but it's the only kind which allows you to construct a System.DateTimeOffset with an arbitrary offset, which makes it as close to the Noda Time non-system-specific "local" concept as exists in .NET.
If the date and time is not on a tick boundary (the unit of granularity of DateTime) the value will be truncated towards the start of time.
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | The date/time is outside the range of DateTime. |
ToString()
Returns a System.String that represents this instance.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
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()
ToString(String, IFormatProvider)
Formats the value of the current instance using the specified pattern.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
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. |
Sample snippet
using NodaTime;
using System;
using System.Globalization;
LocalDateTime dt = new LocalDateTime(2010, 6, 16, 16, 20);
Console.WriteLine(dt.ToString("yyyy-MM-dd'T'HH:mm:ss", CultureInfo.InvariantCulture));
Output:
2010-06-16T16:20:00
With(Func<LocalDate, LocalDate>)
Returns this date/time, with the given date adjuster applied to it, maintaing the existing time of day.
Since 2.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime With(Func<LocalDate, LocalDate> adjuster)Parameters
| Type | Name | Description |
|---|---|---|
| Func<LocalDate, LocalDate> | adjuster | The adjuster to apply. |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The adjusted date/time. |
Remarks
If the adjuster attempts to construct an
invalid date (such as by trying to set a day-of-month of 30 in February), any exception thrown by
that construction attempt will be propagated through this method.
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | adjuster is null. |
With(Func<LocalTime, LocalTime>)
Returns this date/time, with the given time adjuster applied to it, maintaining the existing date.
Since 2.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime With(Func<LocalTime, LocalTime> adjuster)Parameters
| Type | Name | Description |
|---|---|---|
| Func<LocalTime, LocalTime> | adjuster | The adjuster to apply. |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The adjusted date/time. |
Remarks
If the adjuster attempts to construct an invalid time, any exception thrown by
that construction attempt will be propagated through this method.
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | adjuster is null. |
WithCalendar(CalendarSystem)
Creates a new LocalDateTime representing the same physical date and time, but in a different calendar.
The returned LocalDateTime 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 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public LocalDateTime WithCalendar(CalendarSystem calendar)Parameters
| Type | Name | Description |
|---|---|---|
| CalendarSystem | calendar | The calendar system to convert this local date to. |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The converted LocalDateTime. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | calendar is null. |
WithOffset(Offset)
Returns an OffsetDateTime for this local date/time with the given offset.
Since 1.1.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public OffsetDateTime WithOffset(Offset offset)Parameters
| Type | Name | Description |
|---|---|---|
| Offset | offset | The offset to apply. |
Returns
| Type | Description |
|---|---|
| OffsetDateTime | The result of this local date/time offset by the given amount. |
Remarks
This method is purely a convenient alternative to calling the OffsetDateTime constructor directly.
Operators
Addition(LocalDateTime, Period)
Adds a period to a local date/time.
Fields are added in descending order of significance (years first, then months, and so on).
This is a convenience operator over the Plus(Period) method.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static LocalDateTime operator +(LocalDateTime localDateTime, Period period)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | localDateTime | Initial local date and time |
| Period | period | Period to add |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The resulting local date and time |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | period is null. |
Equality(LocalDateTime, LocalDateTime)
Implements the operator == (equality).
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static bool operator ==(LocalDateTime left, LocalDateTime right)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | left | The left hand side of the operator. |
| LocalDateTime | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Boolean | true if values are equal to each other, otherwise false. |
GreaterThan(LocalDateTime, LocalDateTime)
Compares two LocalDateTime values to see if the left one is strictly later than the right
one.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static bool operator>(LocalDateTime lhs, LocalDateTime rhs)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | lhs | First operand of the comparison |
| LocalDateTime | rhs | Second operand of the comparison |
Returns
| Type | Description |
|---|---|
| Boolean | true if the lhs is strictly later than rhs, false otherwise. |
Remarks
Only values with the same calendar system can be compared. See the top-level type
documentation for more information about comparisons.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The calendar system of rhs is not the same
as the calendar of lhs. |
GreaterThanOrEqual(LocalDateTime, LocalDateTime)
Compares two LocalDateTime values to see if the left one is later than or equal to the right
one.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static bool operator >=(LocalDateTime lhs, LocalDateTime rhs)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | lhs | First operand of the comparison |
| LocalDateTime | rhs | Second operand of the comparison |
Returns
| Type | Description |
|---|---|
| Boolean | true if the lhs is later than or equal to rhs, false otherwise. |
Remarks
Only values with the same calendar system can be compared. See the top-level type
documentation for more information about comparisons.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The calendar system of rhs is not the same
as the calendar of lhs. |
Inequality(LocalDateTime, LocalDateTime)
Implements the operator != (inequality).
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static bool operator !=(LocalDateTime left, LocalDateTime right)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | left | The left hand side of the operator. |
| LocalDateTime | right | The right hand side of the operator. |
Returns
| Type | Description |
|---|---|
| Boolean | true if values are not equal to each other, otherwise false. |
LessThan(LocalDateTime, LocalDateTime)
Compares two LocalDateTime values to see if the left one is strictly earlier than the right
one.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static bool operator <(LocalDateTime lhs, LocalDateTime rhs)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | lhs | First operand of the comparison |
| LocalDateTime | rhs | Second operand of the comparison |
Returns
| Type | Description |
|---|---|
| Boolean | true if the lhs is strictly earlier than rhs, false otherwise. |
Remarks
Only values with the same calendar system can be compared. See the top-level type
documentation for more information about comparisons.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The calendar system of rhs is not the same
as the calendar of lhs. |
LessThanOrEqual(LocalDateTime, LocalDateTime)
Compares two LocalDateTime values to see if the left one is earlier than or equal to the right
one.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static bool operator <=(LocalDateTime lhs, LocalDateTime rhs)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | lhs | First operand of the comparison |
| LocalDateTime | rhs | Second operand of the comparison |
Returns
| Type | Description |
|---|---|
| Boolean | true if the lhs is earlier than or equal to rhs, false otherwise. |
Remarks
Only values with the same calendar system can be compared. See the top-level type
documentation for more information about comparisons.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The calendar system of rhs is not the same
as the calendar of lhs. |
Subtraction(LocalDateTime, LocalDateTime)
Subtracts one date/time from another, returning the result as a Period.
Since 2.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static Period operator -(LocalDateTime lhs, LocalDateTime rhs)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | lhs | The date/time to subtract from |
| LocalDateTime | rhs | The date/time to subtract |
Returns
| Type | Description |
|---|---|
| Period | The result of subtracting one date/time from another. (The value returned is never null.) |
Remarks
This is simply a convenience operator for calling Between(LocalDateTime, LocalDateTime).
The calendar systems of the two date/times must be the same.
Subtraction(LocalDateTime, Period)
Subtracts a period from a local date/time.
Fields are subtracted in descending order of significance (years first, then months, and so on).
This is a convenience operator over the Minus(Period) method.
Since 1.0.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
public static LocalDateTime operator -(LocalDateTime localDateTime, Period period)Parameters
| Type | Name | Description |
|---|---|---|
| LocalDateTime | localDateTime | Initial local date and time |
| Period | period | Period to subtract |
Returns
| Type | Description |
|---|---|
| LocalDateTime | The resulting local date and time |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | period is null. |
Explicit Interface Implementations
IComparable.CompareTo(Object)
Implementation of System.IComparable.CompareTo(System.Object) to compare two LocalDateTimes.
Since 1.1.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
int IComparable.CompareTo(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| Object | obj | The object to compare this value with. |
Returns
| Type | Description |
|---|---|
| Int32 | The result of comparing this LocalDateTime with another one; see CompareTo(LocalDateTime) for general details.
If obj is null, this method returns a value greater than 0.
|
Remarks
This uses explicit interface implementation to avoid it being called accidentally. The generic implementation should usually be preferred.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | obj is non-null but does not refer to an instance of LocalDateTime,
or refers to a adate/time in a different calendar system. |
ISerializable.GetObjectData(SerializationInfo, StreamingContext)
Implementation of System.Runtime.Serialization.ISerializable.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext).
Since 1.2.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. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | info is null. |
IXmlSerializable.GetSchema()
Since 1.2.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
XmlSchema IXmlSerializable.GetSchema()Returns
| Type | Description |
|---|---|
| XmlSchema |
IXmlSerializable.ReadXml(XmlReader)
Since 1.2.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
void IXmlSerializable.ReadXml(XmlReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| XmlReader | reader |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | reader is null. |
IXmlSerializable.WriteXml(XmlWriter)
Since 1.2.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
void IXmlSerializable.WriteXml(XmlWriter writer)Parameters
| Type | Name | Description |
|---|---|---|
| XmlWriter | writer |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | writer is null. |
Implements
System.IEquatable<T>
System.IComparable<T>
System.IComparable
System.IFormattable
System.Xml.Serialization.IXmlSerializable
System.Runtime.Serialization.ISerializable