WorkingDaysOfWeekExtensions Class

Definition

Namespace

Bodu.Extensions

Assembly

Bodu.Core.dll

Package

Bodu.Core 1.0.1

Source

WorkingDaysOfWeekExtensions.cs

Provides bidirectional conversion between the WorkingDaysOfWeek enum sugar and the WeekPattern value type.

public static class WorkingDaysOfWeekExtensions

Inheritance

object

WorkingDaysOfWeekExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

ToWeekPattern(WorkingDaysOfWeek)

Returns the canonical WeekPattern for the supplied WorkingDaysOfWeek value.

public static WeekPattern ToWeekPattern(this WorkingDaysOfWeek value)

Parameters

value WorkingDaysOfWeek

The named working-week pattern to convert.

Returns

WeekPattern

The WeekPattern whose selected days match value.

Exceptions

ArgumentOutOfRangeException

Thrown when value is not a defined member of the WorkingDaysOfWeek enumeration.

ArgumentException

Thrown when value is Custom, which has no canonical pattern.

ToWeekPattern(WorkingDaysOfWeek, IWeekendDefinitionProvider?)

Returns the canonical WeekPattern for the supplied WorkingDaysOfWeek value, consulting provider when value is Custom.

public static WeekPattern ToWeekPattern(this WorkingDaysOfWeek value, IWeekendDefinitionProvider? provider)

Parameters

value WorkingDaysOfWeek

The named working-week pattern to convert.

provider IWeekendDefinitionProvider

A custom weekend provider consulted only when value is Custom.

Returns

WeekPattern

The WeekPattern whose selected days match the working-week implied by value (and provider when applicable).

Exceptions

ArgumentOutOfRangeException

Thrown when value is not a defined member of the WorkingDaysOfWeek enumeration.

ArgumentNullException

Thrown when value is Custom and provider is null.

ToWorkingDaysOfWeek(WeekPattern)

Returns the matching WorkingDaysOfWeek value for the supplied WeekPattern, or Custom when no named preset matches.

public static WorkingDaysOfWeek ToWorkingDaysOfWeek(this WeekPattern pattern)

Parameters

pattern WeekPattern

The pattern to identify.

Returns

WorkingDaysOfWeek

The WorkingDaysOfWeek whose canonical pattern equals pattern, or Custom when pattern does not match any named preset.

TryGetWorkingDaysOfWeek(WeekPattern, out WorkingDaysOfWeek)

Attempts to identify the supplied WeekPattern as a named WorkingDaysOfWeek preset.

public static bool TryGetWorkingDaysOfWeek(this WeekPattern pattern, out WorkingDaysOfWeek value)

Parameters

pattern WeekPattern

The pattern to identify.

value WorkingDaysOfWeek

When this method returns true, contains the matching WorkingDaysOfWeek; otherwise, Custom.

Returns

bool

true when pattern matches a named preset; otherwise false.

Applies to

Product	Versions
.NET	8, 10