New to Telerik UI for WinForms? Start a free 30-day trial

WeekDaysHelper

Class

Converts between DayOfWeek values and the bit flags used by weekly recurrence rules.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.Scheduler.dll

Syntax:

public static class WeekDaysHelper

Inheritance: objectWeekDaysHelper

Methods

AreWeekDaysIncluded(WeekDays, WeekDays)

Determines whether the original mask contains all flags in the specified mask.

public static bool AreWeekDaysIncluded(WeekDays original, WeekDays other)

Parameters:originalWeekDays

The weekday mask being checked.

otherWeekDays

The flags that must be present.

Returns:

bool

true when every flag in other is set in original; otherwise, false.

ExcludeWeekDays(WeekDays, WeekDays)

Toggles the specified weekday flags in the existing mask. Flags that are absent from original are added rather than ignored.

public static WeekDays ExcludeWeekDays(WeekDays original, WeekDays other)

Parameters:originalWeekDays

The existing weekday mask.

otherWeekDays

The flags to toggle.

Returns:

WeekDays

The mask after the specified flags are toggled.

FromDayOfWeek(DayOfWeek)

Converts a DayOfWeek value to its corresponding WeekDays flag.

public static WeekDays FromDayOfWeek(DayOfWeek dayOfWeek)

Parameters:dayOfWeekDayOfWeek

The day to convert.

Returns:

WeekDays

The corresponding single-day flag, or None if the value is not a defined day.

IncludeWeekDays(WeekDays, WeekDays)

Combines the existing weekday flags with the specified flags.

public static WeekDays IncludeWeekDays(WeekDays original, WeekDays other)

Parameters:originalWeekDays

The existing weekday mask.

otherWeekDays

The flags to add to the mask.

Returns:

WeekDays

The union of both weekday masks.

IsDayOfWeekIncluded(WeekDays, DayOfWeek)

Determines whether the mask includes the flag corresponding to the specified day.

public static bool IsDayOfWeekIncluded(WeekDays weekdays, DayOfWeek dayOfWeek)

Parameters:weekdaysWeekDays

The weekday mask to check.

dayOfWeekDayOfWeek

The day whose corresponding flag is checked.

Returns:

bool

true when the corresponding flag is included; otherwise, false.

ToDayOfWeek(WeekDays)

Converts a single weekday flag to the corresponding DayOfWeek.

public static DayOfWeek ToDayOfWeek(WeekDays weekdays)

Parameters:weekdaysWeekDays

Exactly one individual weekday flag; combined masks and named groups are not accepted.

Returns:

DayOfWeek

The corresponding day of the week.

Exceptions: ArgumentException

The value is not one individual weekday flag.