WeeklyCalendar Class

Quartz.NET 3.0 API Documentation
This implementation of the Calendar excludes a set of days of the week. You may use it to exclude weekends for example. But you may define any day of the week. By default it excludes Saturday and Sunday.
Inheritance Hierarchy

SystemObject
  Quartz.Impl.CalendarBaseCalendar
    Quartz.Impl.CalendarWeeklyCalendar

Namespace:  Quartz.Impl.Calendar
Assembly:  Quartz (in Quartz.dll) Version: 3.0.0
Syntax

C#
[SerializableAttribute]
public class WeeklyCalendar : BaseCalendar

The WeeklyCalendar type exposes the following members.

Constructors

  NameDescription
Public methodWeeklyCalendar
Initializes a new instance of the WeeklyCalendar class.
Public methodWeeklyCalendar(ICalendar)
Initializes a new instance of the WeeklyCalendar class.
Protected methodWeeklyCalendar(SerializationInfo, StreamingContext)
Serialization constructor.
Top
Properties

  NameDescription
Public propertyCalendarBase
Set a new base calendar or remove the existing one
(Inherited from BaseCalendar.)
Public propertyDaysExcluded
Get the array with the week days. Setting will redefine the array of days excluded. The array must of size greater or equal 8. DayOfWeek enum values like Monday casted to int should be used as index (Sunday is the 0). A value of true is regarded as: exclude it.
Public propertyDescription
Gets or sets the description given to the ICalendar instance by its creator (if any).
(Inherited from BaseCalendar.)
Public propertyTimeZone
Gets or sets the time zone.
(Inherited from BaseCalendar.)
Top
Methods

  NameDescription
Public methodAreAllDaysExcluded
Check if all week ays are excluded. That is no day is included.
Public methodClone (Overrides BaseCalendarClone.)
Protected methodCloneFields (Inherited from BaseCalendar.)
Public methodEquals(Object) (Overrides BaseCalendarEquals(Object).)
Public methodEquals(BaseCalendar) (Inherited from BaseCalendar.)
Public methodEquals(WeeklyCalendar)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode (Overrides BaseCalendarGetHashCode.)
Public methodGetNextIncludedTimeUtc
Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time. Return the original value if timeStamp is included. Return DateTime.MinValue if all days are excluded.

Note that this Calendar is only has full-day precision.

(Overrides BaseCalendarGetNextIncludedTimeUtc(DateTimeOffset).)
Public methodGetObjectData (Overrides BaseCalendarGetObjectData(SerializationInfo, StreamingContext).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsDayExcluded
Return true, if wday is defined to be excluded. E. g. saturday and sunday.
Public methodIsTimeIncluded
Determine whether the given time (in milliseconds) is 'included' by the Calendar.

Note that this Calendar is only has full-day precision.

(Overrides BaseCalendarIsTimeIncluded(DateTimeOffset).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetDayExcluded
Redefine a certain day of the week to be excluded (true) or included (false). Use DayOfWeek enum to determine the weekday.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference