Class BclDateTimeZone
Representation of a time zone converted from a TimeZoneInfo from the Base Class Library.
Since 1.0.x
Availability net35-Client
Implements
Inherited Members
Namespace: NodaTime.TimeZones
Assembly: NodaTime.dll
Syntax
public sealed class BclDateTimeZone : DateTimeZone, IEquatable<DateTimeZone>Properties
DisplayName
Returns the display name associated with the time zone, as provided by the Base Class Library.
Since 1.0.x
Availability net35-Client
Declaration
public string DisplayName { get; }Property Value
| Type | Description |
|---|---|
| String |
OriginalZone
Returns the original TimeZoneInfo from which this was created.
Since 1.0.x
Availability net35-Client
Declaration
public TimeZoneInfo OriginalZone { get; }Property Value
| Type | Description |
|---|---|
| TimeZoneInfo |
Methods
EqualsImpl(DateTimeZone)
Implements equality in derived classes.
Since 1.0.x
Availability net35-Client
Declaration
protected override bool EqualsImpl(DateTimeZone zone)Parameters
| Type | Name | Description |
|---|---|---|
| DateTimeZone | zone | The zone to compare with this one. This is guaranteed (when called by Equals(DateTimeZone)) to be a non-null reference of the same type as this instance. |
Returns
| Type | Description |
|---|---|
| Boolean |
true if the specified DateTimeZone is equal to this instance;
otherwise, false.
|
Overrides
ForSystemDefault()
Returns a time zone converted from the BCL representation of the system local time zone.
If this method is called more than once, it may return the same reference multiple times if
the local time zone has not changed.
Since 1.0.x
Availability net35-Client
Declaration
public static BclDateTimeZone ForSystemDefault()Returns
| Type | Description |
|---|---|
| BclDateTimeZone | A BclDateTimeZone wrapping the "local" (system) time zone as returned by Local. |
Remarks
When the source of a DateTimeZoneCache is set to an instance of BclDateTimeZoneSource it
is highly likely that GetSystemDefault() will succeed - but in
rare cases (such as the set of system time zones changing after the source is installed, or the local zone
not being a normal "system" one) it is possible that it wouldn't be mapped. By contrast, this method will
always succeed.
FromTimeZoneInfo(TimeZoneInfo)
Creates a new BclDateTimeZone from a TimeZoneInfo from the Base Class Library.
Since 1.0.x
Availability net35-Client
Declaration
public static BclDateTimeZone FromTimeZoneInfo(TimeZoneInfo bclZone)Parameters
| Type | Name | Description |
|---|---|---|
| TimeZoneInfo | bclZone | The original time zone to take information from. |
Returns
| Type | Description |
|---|---|
| BclDateTimeZone | A Noda Time representation of the given time zone. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | bclZone is null. |
GetHashCode()
Returns a hash code for this instance.
Since 1.0.x
Availability net35-Client
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
GetZoneInterval(Instant)
Returns the zone interval for the given instant in time. See ZonedDateTime for more details.
Since 1.0.x
Availability net35-Client
Declaration
public override ZoneInterval GetZoneInterval(Instant instant)Parameters
| Type | Name | Description |
|---|---|---|
| Instant | instant |
Returns
| Type | Description |
|---|---|
| ZoneInterval |