Struct TimeFormat

Namespace

Sdl3Sharp.Timing

Assembly

Sdl3Sharp.dll

Represents a time format (24-hour time format or 12-hour time format)

public readonly struct TimeFormat : IEquatable<TimeFormat>, ISpanFormattable, IFormattable, IEqualityOperators<TimeFormat, TimeFormat, bool>

Implements

IEquatable<TimeFormat>

ISpanFormattable

IFormattable

IEqualityOperators<TimeFormat, TimeFormat, bool>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Hours12

Gets the 12-hour time format

public static TimeFormat Hours12 { get; }

Property Value

TimeFormat

The 12-hour time format

Hours24

Gets the 24-hour time format

public static TimeFormat Hours24 { get; }

Property Value

TimeFormat

The 24-hour time format

Methods

Equals(TimeFormat)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(TimeFormat other)

Parameters

other TimeFormat

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

ToString(IFormatProvider?)

Formats the value of the current instance using the specified format.

public string ToString(IFormatProvider? formatProvider)

Parameters

formatProvider IFormatProvider

The provider to use to format the value.

-or-

A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

string

The value of the current instance in the specified format.

ToString(string?)

Formats the value of the current instance using the specified format.

public string ToString(string? format)

Parameters

format string

The format to use.

-or-

A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

Returns

string

The value of the current instance in the specified format.

ToString(string?, IFormatProvider?)

Formats the value of the current instance using the specified format.

public string ToString(string? format, IFormatProvider? formatProvider)

Parameters

format string

The format to use.

-or-

A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

formatProvider IFormatProvider

The provider to use to format the value.

-or-

A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

string

The value of the current instance in the specified format.

TryFormat(Span<char>, out int, ReadOnlySpan<char>, IFormatProvider?)

Tries to format the value of the current instance into the provided span of characters.

public bool TryFormat(Span<char> destination, out int charsWritten, ReadOnlySpan<char> format = default, IFormatProvider? provider = null)

Parameters

destination Span<char>

The span in which to write this instance's value formatted as a span of characters.

charsWritten int

When this method returns, contains the number of characters that were written in destination.

format ReadOnlySpan<char>

A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.

provider IFormatProvider

An optional object that supplies culture-specific formatting information for destination.

Returns

bool

true if the formatting was successful; otherwise, false.

TryGetLocalePreference(out TimeFormat)

Tries to get the current preferred time format for the system locale

public static bool TryGetLocalePreference(out TimeFormat timeFormat)

Parameters

timeFormat TimeFormat

The current preferred time format

Returns

bool

true, if the current preferred time format could be successfully retrieved; otherwise, false (check TryGet(out string?) for more information)

Remarks

This might be a "slow" call that has to query the operating system. It's best to ask for this once and save the results. However, the preferred formats can change, usually because the user has changed a system preference outside of your program.

To get the current preferred time format as well as the current preferred date format simultaneously, use TryGetLocalePreferences(out DateFormat, out TimeFormat) instead.

Operators

operator ==(TimeFormat, TimeFormat)

Compares two values to determine equality.

public static bool operator ==(TimeFormat left, TimeFormat right)

Parameters

left TimeFormat

The value to compare with right.

right TimeFormat

The value to compare with left.

Returns

bool

true if left is equal to right; otherwise, false.

operator !=(TimeFormat, TimeFormat)

Compares two values to determine inequality.

public static bool operator !=(TimeFormat left, TimeFormat right)

Parameters

left TimeFormat

The value to compare with right.

right TimeFormat

The value to compare with left.

Returns

bool

true if left is not equal to right; otherwise, false.