Task |
Controls the background execution of a thread or a task.
Inheritance HierarchyNamespace: Altaxo.Gui.Common
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)
SyntaxC#
public class TaskCancelController : INotifyPropertyChanged, IDisposable
The TaskCancelController type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TaskCancelController | Initializes a new instance of the TaskCancelController class. |
| TaskCancelController(Task, IProgressMonitor, Int32) | Initializes a new instance of the TaskCancelController class for a task. |
| TaskCancelController(Thread, IProgressMonitor, Int32) | Initializes a new instance of the TaskCancelController class for a thread. |
Properties| Name | Description | |
|---|---|---|
 | CmdAbandon | Gets the command that abandons the operation. |
| CmdCancellationHard | Gets the command that requests hard cancellation. |
| CmdCancellationSoft | Gets the command that requests soft cancellation. |
| CmdInterrupt | Gets the command that interrupts the thread. |
| IsAbandonVisible | Gets a value indicating whether the abandon command should be visible. |
| IsCancellationHardVisible | Gets a value indicating whether the hard-cancellation command should be visible. |
| IsCancellationSoftVisible | Gets a value indicating whether the soft-cancellation command should be visible. |
| IsExecutionInProgress | Gets or sets a value indicating whether execution is still in progress. |
| IsInterruptVisible | Gets a value indicating whether the interrupt command should be visible. |
 | IsThread | Gets a value indicating whether the controller is handling a thread. |
| IsWindowVisible | Gets or sets a value indicating whether the progress window should be visible. |
| Monitor | Gets or sets the progress monitor used by the controller. |
| ProgressText | Gets or sets the current progress text. |
| ProgressValue | Gets or sets the current progress value. |
| StateOfCancelling | Gets or sets the current cancellation state. |
| Title | Gets or sets the dialog title. |
| WasCancelledByUser | Gets a value indicating whether the execution was cancelled by the user. |
Methods| Name | Description | |
|---|---|---|
 | CreateTimer | Creates the polling timer if it does not yet exist. |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| EhAbandon | Handles an abandon request. |
| EhInterrupt | Handles an interrupt request. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| 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 | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnPropertyChanged | Raises the PropertyChanged event. |
| StartExecution | Starts execution of the specified action on a background thread. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | PropertyChanged | Occurs when a property value changes. |
Fields| Name | Description | |
|---|---|---|
 | _delayMilliseconds | Delay before the progress window becomes visible, in milliseconds. |
| _timer | Polling timer that monitors task or thread completion. |
Remarks
There is a property IsWindowVisible, which is set to true after a given amount of time
and then set to false when the window should close.
There is another property, IsExecutionInProgress, that indicates whether a task or thread is currently executing.
A task or thread is stopped in the following order:
1. Signal the CancellationTokenSoft
2. Signal the CancellationTokenHard
3. Interrupt the thread (only works for threads)
4. Abort the thread (only works for threads)
See Also