This implementation of the Calendar excludes a set of days of the year. You
may use it to exclude bank holidays which are on the same date every year.
Inheritance Hierarchy
Quartz.Impl.CalendarBaseCalendar
Quartz.Impl.CalendarAnnualCalendar
Namespace: Quartz.Impl.Calendar
Assembly: Quartz (in Quartz.dll) Version: 3.0.0
Syntax
C#
[SerializableAttribute] public class AnnualCalendar : BaseCalendar
The AnnualCalendar type exposes the following members.
Constructors
Name | Description | |
---|---|---|
AnnualCalendar |
Constructor
| |
AnnualCalendar(ICalendar) |
Constructor
| |
AnnualCalendar(SerializationInfo, StreamingContext) |
Serialization constructor.
|
Properties
Name | Description | |
---|---|---|
CalendarBase |
Set a new base calendar or remove the existing one
(Inherited from BaseCalendar.) | |
DaysExcluded |
Gets or sets the days to be excluded by this calendar.
| |
Description |
Gets or sets the description given to the ICalendar instance by
its creator (if any).
(Inherited from BaseCalendar.) | |
TimeZone |
Gets or sets the time zone.
(Inherited from BaseCalendar.) |
Methods
Name | Description | |
---|---|---|
Clone | (Overrides BaseCalendarClone.) | |
CloneFields | (Inherited from BaseCalendar.) | |
Equals(Object) | (Overrides BaseCalendarEquals(Object).) | |
Equals(AnnualCalendar) | ||
Equals(BaseCalendar) | (Inherited from BaseCalendar.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | (Overrides BaseCalendarGetHashCode.) | |
GetNextIncludedTimeUtc |
Determine the next UTC time (in milliseconds) that is 'included' by the
Calendar after the given time. Return the original value if timeStampUtc is
included. Return 0 if all days are excluded.
(Overrides BaseCalendarGetNextIncludedTimeUtc(DateTimeOffset).)Note that this Calendar is only has full-day precision. | |
GetObjectData | (Overrides BaseCalendarGetObjectData(SerializationInfo, StreamingContext).) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IsDayExcluded |
Return true, if day is defined to be excluded.
| |
IsTimeIncluded |
Determine whether the given UTC time (in milliseconds) is 'included' by the
Calendar.
(Overrides BaseCalendarIsTimeIncluded(DateTimeOffset).)Note that this Calendar is only has full-day precision. | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
SetDayExcluded |
Redefine a certain day to be excluded (true) or included (false).
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also