Class TimeOfDay

Represents a specific time of day, independent of any date.

Inheritance

object

TimeOfDay

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Coree.NETStandard.Classes.TimeOfDay

Assembly: Coree.NETStandard.dll

Syntax

public class TimeOfDay

Constructors

TimeOfDay(int, int, int, int)

Initializes a new instance of the TimeOfDay class to a specified number of hours, minutes, seconds, and milliseconds.

Declaration

public TimeOfDay(int hour = 0, int minute = 0, int second = 0, int millisecond = 0)

Parameters

Type	Name	Description
int	hour	The hour component of the time.
int	minute	The minute component of the time.
int	second	The second component of the time.
int	millisecond	The millisecond component of the time.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when the specified time components are out of their expected range.

Properties

Hour

Gets the hour component of the time.

Declaration

public int Hour { get; }

Property Value

Type	Description
int

Millisecond

Gets the millisecond component of the time.

Declaration

public int Millisecond { get; }

Property Value

Type	Description
int

Minute

Gets the minute component of the time.

Declaration

public int Minute { get; }

Property Value

Type	Description
int

Second

Gets the second component of the time.

Declaration

public int Second { get; }

Property Value

Type	Description
int

Ticks

Gets the number of ticks that represent the time.

Declaration

public long Ticks { get; }

Property Value

Type	Description
long

Methods

Add(TimeSpan)

Adds a TimeSpan to this TimeOfDay instance.

Declaration

public TimeOfDay Add(TimeSpan duration)

Parameters

Type	Name	Description
TimeSpan	duration	The TimeSpan to add.

Returns

Type	Description
TimeOfDay	A new TimeOfDay instance representing the added time.

AddHours(double)

Adds a specified number of hours to this TimeOfDay instance.

Declaration

public TimeOfDay AddHours(double duration)

Parameters

Type	Name	Description
double	duration	The number of hours to add.

Returns

Type	Description
TimeOfDay	A new TimeOfDay instance representing the added time.

AddMinutes(double)

Adds a specified number of minutes to this TimeOfDay instance.

Declaration

public TimeOfDay AddMinutes(double duration)

Parameters

Type	Name	Description
double	duration	The number of minutes to add.

Returns

Type	Description
TimeOfDay	A new TimeOfDay instance representing the added time.

AddSeconds(double)

Adds a specified number of seconds to this TimeOfDay instance.

Declaration

public TimeOfDay AddSeconds(double duration)

Parameters

Type	Name	Description
double	duration	The number of seconds to add.

Returns

Type	Description
TimeOfDay	A new TimeOfDay instance representing the added time.

FromTime(int, int, int, int)

Creates a TimeOfDay from individual time components.

Declaration

public static TimeOfDay FromTime(int hours = 0, int minutes = 0, int seconds = 0, int milliseconds = 0)

Parameters

Type	Name	Description
int	hours	Hour component.
int	minutes	Minute component.
int	seconds	Second component.
int	milliseconds	Millisecond component.

Returns

Type	Description
TimeOfDay	A new TimeOfDay instance.

FromTimeSpan(TimeSpan)

Creates a TimeOfDay from a TimeSpan object.

Declaration

public static TimeOfDay FromTimeSpan(TimeSpan time)

Parameters

Type	Name	Description
TimeSpan	time	The TimeSpan object to convert.

Returns

Type	Description
TimeOfDay	A TimeOfDay object.

FromTimeString(string)

Converts a string representation of a time into a TimeOfDay object.

Declaration

public static TimeOfDay FromTimeString(string timeString)

Parameters

Type	Name	Description
string	timeString	A string that represents the time in "hh:mm:ss" format.

Returns

Type	Description
TimeOfDay	A TimeOfDay object.

Exceptions

Type	Condition
FormatException	Thrown when the time string is not in a valid format.

Subtract(TimeSpan)

Subtracts a TimeSpan from this TimeOfDay instance.

Declaration

public TimeOfDay Subtract(TimeSpan duration)

Parameters

Type	Name	Description
TimeSpan	duration	The TimeSpan to subtract.

Returns

Type	Description
TimeOfDay	A new TimeOfDay instance representing the subtracted time.

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object in "hh:mm:ss" format.

Overrides

object.ToString()

ToTimeSpan()

Converts this TimeOfDay instance to a TimeSpan.

Declaration

public TimeSpan ToTimeSpan()

Returns

Type	Description
TimeSpan	A TimeSpan that represents the time.

Operators

implicit operator TimeOfDay(string)

Defines an implicit conversion of a string to a TimeOfDay.

Declaration

public static implicit operator TimeOfDay(string timeString)

Parameters

Type	Name	Description
string	timeString	The string to convert to TimeOfDay.

Returns

Type	Description
TimeOfDay	A TimeOfDay equivalent to the time contained in the string.