Struct Offset
An offset from UTC in milliseconds. A positive value means that the local time is
ahead of UTC (e.g. for Europe); a negative value means that the local time is behind
UTC (e.g. for America).
Assembly: NodaTime.dll
Syntax
[Serializable]
public struct Offset : IEquatable<Offset>, IComparable<Offset>, IFormattable, IComparable, IXmlSerializable, ISerializable
Fields
MaxValue
The maximum permitted offset; one millisecond less than a standard day after UTC.
Declaration
public static readonly Offset MaxValue
Field Value
MinValue
The minimum permitted offset; one millisecond less than a standard day before UTC.
Declaration
public static readonly Offset MinValue
Field Value
Zero
An offset of zero ticks - effectively the permanent offset for UTC.
Declaration
public static readonly Offset Zero
Field Value
Properties
Milliseconds
Gets the total number of milliseconds in the offset, which may be negative.
Declaration
public int Milliseconds { get; }
Property Value
Ticks
Returns the number of ticks represented by this offset, which may be negative.
Declaration
public long Ticks { get; }
Property Value
Type |
Description |
Int64 |
The number of ticks. |
Methods
Add(Offset, Offset)
Adds one Offset to another. Friendly alternative to operator+()
.
Declaration
public static Offset Add(Offset left, Offset right)
Parameters
Type |
Name |
Description |
Offset |
left |
The left hand side of the operator. |
Offset |
right |
The right hand side of the operator. |
Returns
Type |
Description |
Offset |
A new Offset representing the sum of the given values. |
Exceptions
CompareTo(Offset)
Compares the current object with another object of the same type.
Declaration
public int CompareTo(Offset other)
Parameters
Type |
Name |
Description |
Offset |
other |
An object to compare with this object. |
Returns
Type |
Description |
Int32 |
A 32-bit signed integer that indicates the relative order of the objects being compared.
The return value has the following meanings:
Value | Meaning |
---|
< 0 | This object is less than the other parameter. | 0 | This object is equal to other . | > 0 | This object is greater than other . |
|
Equals(Offset)
Indicates whether the current object is equal to another object of the same type.
Declaration
public bool Equals(Offset other)
Parameters
Type |
Name |
Description |
Offset |
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
Object is equal to this instance.
Declaration
public override bool Equals(object obj)
Parameters
Type |
Name |
Description |
Object |
obj |
The Object to compare with this instance. |
Returns
Type |
Description |
Boolean |
true if the specified Object is equal to this instance;
otherwise, false .
|
Overrides
FromHours(Int32)
Creates an offset with the specified number of hours, which may be negative.
Declaration
public static Offset FromHours(int hours)
Parameters
Type |
Name |
Description |
Int32 |
hours |
The number of hours to represent in the new offset. |
Returns
Type |
Description |
Offset |
A new Offset representing the given value.
|
Exceptions
FromHoursAndMinutes(Int32, Int32)
Creates an offset with the specified number of hours and minutes.
Declaration
public static Offset FromHoursAndMinutes(int hours, int minutes)
Parameters
Type |
Name |
Description |
Int32 |
hours |
The number of hours to represent in the new offset. |
Int32 |
minutes |
The number of minutes to represent in the new offset. |
Returns
Type |
Description |
Offset |
A new Offset representing the given value.
|
Remarks
Exceptions
FromMilliseconds(Int32)
Returns the offset for the given milliseconds value, which may be negative.
Declaration
public static Offset FromMilliseconds(int milliseconds)
Parameters
Type |
Name |
Description |
Int32 |
milliseconds |
The int milliseconds value. |
Returns
Type |
Description |
Offset |
The Offset for the given milliseconds value |
Exceptions
FromTicks(Int64)
Creates a new offset from the given number of ticks, which may be negative.
Declaration
public static Offset FromTicks(long ticks)
Parameters
Type |
Name |
Description |
Int64 |
ticks |
The number of ticks specifying the length of the new offset. |
Returns
Type |
Description |
Offset |
An offset representing the given number of ticks, to the (truncated) millisecond. |
Exceptions
GetHashCode()
Returns a hash code for this instance.
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
Max(Offset, Offset)
Returns the greater offset of the given two, i.e. the one which will give a later local
time when added to an instant.
Declaration
public static Offset Max(Offset x, Offset y)
Parameters
Type |
Name |
Description |
Offset |
x |
The first offset |
Offset |
y |
The second offset |
Returns
Type |
Description |
Offset |
The greater offset of x and y . |
Min(Offset, Offset)
Returns the lower offset of the given two, i.e. the one which will give an earlier local
time when added to an instant.
Declaration
public static Offset Min(Offset x, Offset y)
Parameters
Type |
Name |
Description |
Offset |
x |
The first offset |
Offset |
y |
The second offset |
Returns
Type |
Description |
Offset |
The lower offset of x and y . |
Minus(Offset)
Returns the result of subtracting another Offset from this one, for a fluent alternative to operator-()
.
Declaration
public Offset Minus(Offset other)
Parameters
Type |
Name |
Description |
Offset |
other |
The offset to subtract |
Returns
Type |
Description |
Offset |
The result of subtracting the other offset from this one. |
Exceptions
Negate(Offset)
Returns the negation of the specified offset. This is the method form of the unary minus operator.
Declaration
public static Offset Negate(Offset offset)
Parameters
Type |
Name |
Description |
Offset |
offset |
The offset to negate. |
Returns
Type |
Description |
Offset |
The negation of the specified offset. |
Plus(Offset)
Returns the result of adding another Offset to this one, for a fluent alternative to operator+()
.
Declaration
public Offset Plus(Offset other)
Parameters
Type |
Name |
Description |
Offset |
other |
The offset to add |
Returns
Type |
Description |
Offset |
The result of adding the other offset to this one. |
Exceptions
Subtract(Offset, Offset)
Subtracts one Offset from another. Friendly alternative to operator-()
.
Declaration
public static Offset Subtract(Offset minuend, Offset subtrahend)
Parameters
Type |
Name |
Description |
Offset |
minuend |
The left hand side of the operator. |
Offset |
subtrahend |
The right hand side of the operator. |
Returns
Type |
Description |
Offset |
A new Offset representing the difference of the given values. |
Exceptions
ToString()
Returns a
String that represents this instance.
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
Formats the value of the current instance using the specified pattern.
Declaration
public string ToString(string patternText, IFormatProvider formatProvider)
Parameters
Type |
Name |
Description |
String |
patternText |
The String specifying the pattern to use,
or null to use the default format pattern ("g").
|
IFormatProvider |
formatProvider |
The 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 String containing the value of the current instance in the specified format.
|
ToTimeSpan()
Converts this offset to a .NET standard
TimeSpan value.
Declaration
public TimeSpan ToTimeSpan()
Returns
Operators
Addition(Offset, Offset)
Implements the operator + (addition).
Declaration
public static Offset operator +(Offset left, Offset right)
Parameters
Type |
Name |
Description |
Offset |
left |
The left hand side of the operator. |
Offset |
right |
The right hand side of the operator. |
Returns
Type |
Description |
Offset |
A new Offset representing the sum of the given values. |
Exceptions
Equality(Offset, Offset)
Implements the operator == (equality).
Declaration
public static bool operator ==(Offset left, Offset right)
Parameters
Type |
Name |
Description |
Offset |
left |
The left hand side of the operator. |
Offset |
right |
The right hand side of the operator. |
Returns
Type |
Description |
Boolean |
true if values are equal to each other, otherwise false . |
GreaterThan(Offset, Offset)
Implements the operator > (greater than).
Declaration
public static bool operator>(Offset left, Offset right)
Parameters
Type |
Name |
Description |
Offset |
left |
The left hand side of the operator. |
Offset |
right |
The right hand side of the operator. |
Returns
Type |
Description |
Boolean |
true if the left value is greater than the right value, otherwise false . |
GreaterThanOrEqual(Offset, Offset)
Implements the operator >= (greater than or equal).
Declaration
public static bool operator >=(Offset left, Offset right)
Parameters
Type |
Name |
Description |
Offset |
left |
The left hand side of the operator. |
Offset |
right |
The right hand side of the operator. |
Returns
Type |
Description |
Boolean |
true if the left value is greater than or equal to the right value, otherwise false . |
Inequality(Offset, Offset)
Implements the operator != (inequality).
Declaration
public static bool operator !=(Offset left, Offset right)
Parameters
Type |
Name |
Description |
Offset |
left |
The left hand side of the operator. |
Offset |
right |
The right hand side of the operator. |
Returns
Type |
Description |
Boolean |
true if values are not equal to each other, otherwise false . |
LessThan(Offset, Offset)
Implements the operator < (less than).
Declaration
public static bool operator <(Offset left, Offset right)
Parameters
Type |
Name |
Description |
Offset |
left |
The left hand side of the operator. |
Offset |
right |
The right hand side of the operator. |
Returns
Type |
Description |
Boolean |
true if the left value is less than the right value, otherwise false . |
LessThanOrEqual(Offset, Offset)
Implements the operator <= (less than or equal).
Declaration
public static bool operator <=(Offset left, Offset right)
Parameters
Type |
Name |
Description |
Offset |
left |
The left hand side of the operator. |
Offset |
right |
The right hand side of the operator. |
Returns
Type |
Description |
Boolean |
true if the left value is less than or equal to the right value, otherwise false . |
Subtraction(Offset, Offset)
Implements the operator - (subtraction).
Declaration
public static Offset operator -(Offset minuend, Offset subtrahend)
Parameters
Type |
Name |
Description |
Offset |
minuend |
The left hand side of the operator. |
Offset |
subtrahend |
The right hand side of the operator. |
Returns
Type |
Description |
Offset |
A new Offset representing the difference of the given values. |
Exceptions
UnaryNegation(Offset)
Implements the unary operator - (negation).
Declaration
public static Offset operator -(Offset offset)
Parameters
Type |
Name |
Description |
Offset |
offset |
The offset to negate. |
Returns
Type |
Description |
Offset |
A new Offset instance with a negated value. |
UnaryPlus(Offset)
Implements the unary operator + .
Declaration
public static Offset operator +(Offset offset)
Parameters
Type |
Name |
Description |
Offset |
offset |
The operand. |
Returns
Explicit Interface Implementations
IComparable.CompareTo(Object)
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 instant with another one; see CompareTo(Offset) for general details.
If obj is null, this method returns a value greater than 0.
|
Exceptions
ISerializable.GetObjectData(SerializationInfo, StreamingContext)
Declaration
[SecurityCritical]
void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
IXmlSerializable.GetSchema()
Declaration
XmlSchema IXmlSerializable.GetSchema()
Returns
IXmlSerializable.ReadXml(XmlReader)
Declaration
void IXmlSerializable.ReadXml(XmlReader reader)
Parameters
IXmlSerializable.WriteXml(XmlWriter)
Declaration
void IXmlSerializable.WriteXml(XmlWriter writer)
Parameters
Implements