Struct DateSpan
- Namespace
- Cuemon
- Assembly
- Cuemon.Core.dll
Represents a System.DateTime interval between two System.DateTime values.
public readonly struct DateSpan : IEquatable<DateSpan>
- Implements
-
IEquatable<DateSpan>
Constructors
DateSpan(DateTime)
Initializes a new instance of the DateSpan structure with a default System.DateTime value set to System.DateTime.Today.
public DateSpan(DateTime start)
Parameters
start
DateTimeA System.DateTime value for the DateSpan calculation.
DateSpan(DateTime, DateTime)
Initializes a new instance of the DateSpan structure with a default Cuemon.DateSpan._calendar value from the System.Globalization.CultureInfo.InvariantCulture class.
public DateSpan(DateTime start, DateTime end)
Parameters
start
DateTimeA System.DateTime value for the DateSpan calculation.
end
DateTimeA System.DateTime value for the DateSpan calculation.
DateSpan(DateTime, DateTime, Calendar)
Initializes a new instance of the DateSpan structure.
public DateSpan(DateTime start, DateTime end, Calendar calendar)
Parameters
start
DateTimeA System.DateTime value for the DateSpan calculation.
end
DateTimeA System.DateTime value for the DateSpan calculation.
calendar
CalendarThe System.Globalization.Calendar that applies to this DateSpan.
Properties
Days
Gets the number of days represented by the current DateSpan structure.
public readonly int Days { get; }
Property Value
- Int32
The number of days represented by the current DateSpan structure.
Hours
Gets the number of hours represented by the current DateSpan structure.
public readonly int Hours { get; }
Property Value
- Int32
The number of hours represented by the current DateSpan structure.
Milliseconds
Gets the number of milliseconds represented by the current DateSpan structure.
public readonly int Milliseconds { get; }
Property Value
- Int32
The number of milliseconds represented by the current DateSpan structure.
Minutes
Gets the number of minutes represented by the current DateSpan structure.
public readonly int Minutes { get; }
Property Value
- Int32
The number of minutes represented by the current DateSpan structure.
Months
Gets the number of months represented by the current DateSpan structure.
public readonly int Months { get; }
Property Value
- Int32
The number of months represented by the current DateSpan structure.
Seconds
Gets the number of seconds represented by the current DateSpan structure.
public readonly int Seconds { get; }
Property Value
- Int32
The number of seconds represented by the current DateSpan structure.
Ticks
Gets the number of ticks represented by the current DateSpan structure.
public readonly long Ticks { get; }
Property Value
- Int64
The number of ticks represented by the current DateSpan structure.
TotalDays
Gets the total number of days represented by the current DateSpan structure.
public readonly double TotalDays { get; }
Property Value
- Double
The total number of days represented by the current DateSpan structure.
TotalHours
Gets the total number of hours represented by the current DateSpan structure.
public readonly double TotalHours { get; }
Property Value
- Double
The total number of hours represented by the current DateSpan structure.
TotalMilliseconds
Gets the total number of milliseconds represented by the current DateSpan structure.
public readonly double TotalMilliseconds { get; }
Property Value
- Double
The total number of milliseconds represented by the current DateSpan structure.
TotalMinutes
Gets the total number of minutes represented by the current DateSpan structure.
public readonly double TotalMinutes { get; }
Property Value
- Double
The total number of minutes represented by the current DateSpan structure.
TotalMonths
Gets the total number of months represented by the current DateSpan structure.
public readonly double TotalMonths { get; }
Property Value
- Double
The total number of months represented by the current DateSpan structure.
TotalSeconds
Gets the total number of seconds represented by the current DateSpan structure.
public readonly double TotalSeconds { get; }
Property Value
- Double
The total number of seconds represented by the current DateSpan structure.
TotalYears
Gets the total number of years represented by the current DateSpan structure.
public readonly double TotalYears { get; }
Property Value
- Double
The total number of years represented by the current DateSpan structure.
Years
Gets the number of years represented by the current DateSpan structure.
public readonly int Years { get; }
Property Value
- Int32
The number of years represented by the current DateSpan structure.
Methods
Equals(DateSpan)
Indicates whether the current object is equal to another object of the same type.
public readonly bool Equals(DateSpan other)
Parameters
other
DateSpanAn object to compare with this object.
Returns
- 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.
public override readonly bool Equals(object obj)
Parameters
obj
ObjectThe System.Object to compare with this instance.
Returns
- Boolean
true
if the specified System.Object is equal to this instance; otherwise,false
.
GetHashCode()
Returns a hash code for this instance.
public override readonly int GetHashCode()
Returns
- Int32
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
GetWeeks()
Calculates the number of weeks represented by the current DateSpan structure.
public readonly int GetWeeks()
Returns
- Int32
Calculates the number of weeks represented by the current DateSpan structure.
Parse(String)
Constructs a new DateSpan object from a date and time interval specified in a string.
public static DateSpan Parse(string start)
Parameters
start
StringA string that specifies the starting date and time value for the DateSpan interval.
Returns
- DateSpan
A DateSpan that corresponds to
start
and System.DateTime.Today for the last part of the interval.
Parse(String, String)
Constructs a new DateSpan object from a date and time interval specified in a string.
public static DateSpan Parse(string start, string end)
Parameters
start
StringA string that specifies the starting date and time value for the DateSpan interval.
end
StringA string that specifies the ending date and time value for the DateSpan interval.
Returns
Parse(String, String, CultureInfo)
Constructs a new DateSpan object from a date and time interval specified in a string.
public static DateSpan Parse(string start, string end, CultureInfo culture)
Parameters
start
StringA string that specifies the starting date and time value for the DateSpan interval.
end
StringA string that specifies the ending date and time value for the DateSpan interval.
culture
CultureInfoA System.Globalization.CultureInfo to resolve a Cuemon.DateSpan._calendar object from.
Returns
ToString()
Converts the value of the current DateSpan object to its equivalent string representation.
public override readonly string ToString()
Returns
- String
The System.String representation of the current DateSpan value.
Remarks
The returned string has the following format: y*:MM:dd:hh:mm:ss.f*, where y* is the actual calculated years and f* is the actual calculated milliseconds.
Operators
Equality(DateSpan, DateSpan)
Indicates whether two DateSpan instances are equal.
public static bool operator ==(DateSpan dateSpan1, DateSpan dateSpan2)
Parameters
dateSpan1
DateSpanThe first date interval to compare.
dateSpan2
DateSpanThe second date interval to compare.
Returns
- Boolean
true
if the values ofdateSpan1
anddateSpan2
are equal; otherwise, false.
Inequality(DateSpan, DateSpan)
Indicates whether two DateSpan instances are not equal.
public static bool operator !=(DateSpan dateSpan1, DateSpan dateSpan2)
Parameters
dateSpan1
DateSpanThe first date interval to compare.
dateSpan2
DateSpanThe second date interval to compare.
Returns
- Boolean
true
if the values ofdateSpan1
anddateSpan2
are not equal; otherwise, false.