Class ScheduleBox
- Namespace
- H.Controls.ScheduleBox
- Assembly
- H.Controls.ScheduleBox.dll
public class ScheduleBox : ItemsControl, IAnimatable, ISupportInitialize, IFrameworkInputElement, IInputElement, IQueryAmbient, IContainItemStorage, IAddChild, IJobListener, ITriggerListener, ISchedulerListener- Inheritance
-
ScheduleBox
- Implements
-
IJobListenerITriggerListenerISchedulerListener
- Inherited Members
- Extension Methods
Constructors
ScheduleBox()
public ScheduleBox()Fields
MessagesProperty
public static readonly DependencyProperty MessagesPropertyField Value
SchedulerMetaDataProperty
public static readonly DependencyProperty SchedulerMetaDataPropertyField Value
Properties
JobsSource
public ObservableCollection<IScheduleJob> JobsSource { get; }Property Value
Messages
public ObservableCollection<string> Messages { get; set; }Property Value
SchedulerMetaData
public SchedulerMetaData SchedulerMetaData { get; set; }Property Value
- SchedulerMetaData
Methods
AddMessage(string, string)
public void AddMessage(string message, string methodName = null)Parameters
JobAdded(IJobDetail, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.IJobDetail has been added.
public Task JobAdded(IJobDetail jobDetail, CancellationToken cancellationToken = default)Parameters
jobDetailIJobDetailcancellationTokenCancellationToken
Returns
JobDeleted(JobKey, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.IJobDetail has been deleted.
public Task JobDeleted(JobKey jobKey, CancellationToken cancellationToken = default)Parameters
jobKeyJobKeycancellationTokenCancellationToken
Returns
JobExecutionVetoed(IJobExecutionContext, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.IJobDetail was about to be executed (an associated Quartz.ITrigger has occurred), but a Quartz.ITriggerListener vetoed it's execution.
public Task JobExecutionVetoed(IJobExecutionContext context, CancellationToken cancellationToken = default)Parameters
contextIJobExecutionContextcancellationTokenCancellationToken
Returns
- See Also
JobInterrupted(JobKey, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.IJobDetail has been interrupted.
public Task JobInterrupted(JobKey jobKey, CancellationToken cancellationToken = default)Parameters
jobKeyJobKeycancellationTokenCancellationToken
Returns
JobPaused(JobKey, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.IJobDetail has been paused.
public Task JobPaused(JobKey jobKey, CancellationToken cancellationToken = default)Parameters
jobKeyJobKeycancellationTokenCancellationToken
Returns
JobResumed(JobKey, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.IJobDetail has been un-paused.
public Task JobResumed(JobKey jobKey, CancellationToken cancellationToken = default)Parameters
jobKeyJobKeycancellationTokenCancellationToken
Returns
JobScheduled(ITrigger, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.IJobDetail is scheduled.
public Task JobScheduled(ITrigger trigger, CancellationToken cancellationToken = default)Parameters
triggerITriggercancellationTokenCancellationToken
Returns
JobToBeExecuted(IJobExecutionContext, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.IJobDetail is about to be executed (an associated Quartz.ITrigger has occurred).
This method will not be invoked if the execution of the Job was vetoed by a Quartz.ITriggerListener.
public Task JobToBeExecuted(IJobExecutionContext context, CancellationToken cancellationToken = default)Parameters
contextIJobExecutionContextcancellationTokenCancellationToken
Returns
- See Also
JobUnscheduled(TriggerKey, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.IJobDetail is unscheduled.
public Task JobUnscheduled(TriggerKey triggerKey, CancellationToken cancellationToken = default)Parameters
triggerKeyTriggerKeycancellationTokenCancellationToken
Returns
- See Also
JobWasExecuted(IJobExecutionContext, JobExecutionException, CancellationToken)
Called by the Quartz.IScheduler after a Quartz.IJobDetail has been executed, and be for the associated Quartz.Spi.IOperableTrigger's Quartz.Spi.IOperableTrigger.Triggered(Quartz.ICalendar) method has been called.
public Task JobWasExecuted(IJobExecutionContext context, JobExecutionException jobException, CancellationToken cancellationToken = default)Parameters
contextIJobExecutionContextjobExceptionJobExecutionExceptioncancellationTokenCancellationToken
Returns
JobsPaused(string, CancellationToken)
Called by the Quartz.IScheduler when a group of Quartz.IJobDetails has been paused.
If all groups were paused, then the
public Task JobsPaused(string jobGroup, CancellationToken cancellationToken = default)Parameters
jobGroupstringThe job group.
cancellationTokenCancellationTokenThe cancellation instruction.
Returns
JobsResumed(string, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.IJobDetail has been un-paused.
public Task JobsResumed(string jobGroup, CancellationToken cancellationToken = default)Parameters
jobGroupstringThe job group.
cancellationTokenCancellationTokenThe cancellation instruction.
Returns
SchedulerError(string, SchedulerException, CancellationToken)
Called by the Quartz.IScheduler when a serious error has occurred within the scheduler - such as repeated failures in the Quartz.Spi.IJobStore, or the inability to instantiate a Quartz.IJob instance when its Quartz.ITrigger has fired.
public Task SchedulerError(string msg, SchedulerException cause, CancellationToken cancellationToken = default)Parameters
msgstringcauseSchedulerExceptioncancellationTokenCancellationToken
Returns
SchedulerInStandbyMode(CancellationToken)
Called by the Quartz.IScheduler to inform the listener that it has move to standby mode.
public Task SchedulerInStandbyMode(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationToken
Returns
SchedulerShutdown(CancellationToken)
Called by the Quartz.IScheduler to inform the listener that it has Shutdown.
public Task SchedulerShutdown(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationToken
Returns
SchedulerShuttingdown(CancellationToken)
Called by the Quartz.IScheduler to inform the listener that it has begun the shutdown sequence.
public Task SchedulerShuttingdown(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationToken
Returns
SchedulerStarted(CancellationToken)
Called by the Quartz.IScheduler to inform the listener that it has started.
public Task SchedulerStarted(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationToken
Returns
SchedulerStarting(CancellationToken)
Called by the Quartz.IScheduler to inform the listener that it is starting.
public Task SchedulerStarting(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationToken
Returns
SchedulingDataCleared(CancellationToken)
Called by the Quartz.IScheduler to inform the listener that all jobs, triggers and calendars were deleted.
public Task SchedulingDataCleared(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationToken
Returns
Start()
public void Start()Stop()
public void Stop()TriggerComplete(ITrigger, IJobExecutionContext, SchedulerInstruction, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.ITrigger has fired, it's associated Quartz.IJobDetail has been executed, and it's Quartz.Spi.IOperableTrigger.Triggered(Quartz.ICalendar) method has been called.
public Task TriggerComplete(ITrigger trigger, IJobExecutionContext context, SchedulerInstruction triggerInstructionCode, CancellationToken cancellationToken = default)Parameters
triggerITriggerThe Quartz.ITrigger that was fired.
contextIJobExecutionContextThe Quartz.IJobExecutionContext that was passed to the Quartz.IJob'sQuartz.IJob.Execute(Quartz.IJobExecutionContext) method.
triggerInstructionCodeSchedulerInstructionThe result of the call on the Quartz.ITrigger'sQuartz.Spi.IOperableTrigger.Triggered(Quartz.ICalendar) method.
cancellationTokenCancellationTokenThe cancellation instruction.
Returns
TriggerFinalized(ITrigger, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.ITrigger has reached the condition in which it will never fire again.
public Task TriggerFinalized(ITrigger trigger, CancellationToken cancellationToken = default)Parameters
triggerITriggercancellationTokenCancellationToken
Returns
TriggerFired(ITrigger, IJobExecutionContext, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.ITrigger has fired, and it's associated Quartz.IJobDetail is about to be executed.
It is called before the VetoJobExecution(ITrigger, IJobExecutionContext, CancellationToken) method of this interface.
public Task TriggerFired(ITrigger trigger, IJobExecutionContext context, CancellationToken cancellationToken = default)Parameters
triggerITriggerThe Quartz.ITrigger that has fired.
contextIJobExecutionContextThe Quartz.IJobExecutionContext that will be passed to the Quartz.IJob'sQuartz.IJob.Execute(Quartz.IJobExecutionContext) method.
cancellationTokenCancellationTokenThe cancellation instruction.
Returns
TriggerMisfired(ITrigger, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.ITrigger has misfired.
Consideration should be given to how much time is spent in this method, as it will affect all triggers that are misfiring. If you have lots of triggers misfiring at once, it could be an issue it this method does a lot.
public Task TriggerMisfired(ITrigger trigger, CancellationToken cancellationToken = default)Parameters
triggerITriggerThe Quartz.ITrigger that has misfired.
cancellationTokenCancellationTokenThe cancellation instruction.
Returns
TriggerPaused(TriggerKey, CancellationToken)
Called by the Quartz.IScheduler a Quartz.ITriggers has been paused.
public Task TriggerPaused(TriggerKey triggerKey, CancellationToken cancellationToken = default)Parameters
triggerKeyTriggerKeycancellationTokenCancellationToken
Returns
TriggerResumed(TriggerKey, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.ITrigger has been un-paused.
public Task TriggerResumed(TriggerKey triggerKey, CancellationToken cancellationToken = default)Parameters
triggerKeyTriggerKeycancellationTokenCancellationToken
Returns
TriggersPaused(string, CancellationToken)
Called by the Quartz.IScheduler a group of Quartz.ITriggers has been paused.
public Task TriggersPaused(string triggerGroup, CancellationToken cancellationToken = default)Parameters
triggerGroupstringThe trigger group.
cancellationTokenCancellationTokenThe cancellation instruction.
Returns
Remarks
If a all groups were paused, then the
TriggersResumed(string, CancellationToken)
Called by the Quartz.IScheduler when a group of Quartz.ITriggers has been un-paused.
public Task TriggersResumed(string triggerGroup, CancellationToken cancellationToken = default)Parameters
triggerGroupstringThe trigger group.
cancellationTokenCancellationTokenThe cancellation instruction.
Returns
Remarks
If all groups were resumed, then the
VetoJobExecution(ITrigger, IJobExecutionContext, CancellationToken)
Called by the Quartz.IScheduler when a Quartz.ITrigger has fired, and it's associated Quartz.IJobDetail is about to be executed.
It is called after the TriggerFired(ITrigger, IJobExecutionContext, CancellationToken) method of this interface. If the implementation vetoes the execution (via returning true), the job's execute method will not be called.
public Task<bool> VetoJobExecution(ITrigger trigger, IJobExecutionContext context, CancellationToken cancellationToken = default)Parameters
triggerITriggerThe Quartz.ITrigger that has fired.
contextIJobExecutionContextThe Quartz.IJobExecutionContext that will be passed to the Quartz.IJob'sQuartz.IJob.Execute(Quartz.IJobExecutionContext) method.
cancellationTokenCancellationTokenThe cancellation instruction.