Class PercentageTask
A task that executes an System.Action<T> and reports progress in percent.
[CLSCompliant(false)]
public sealed class PercentageTask : TaskBase, ITask- Inheritance
-
objectMarshalByRefObjectPercentageTask
- Implements
- Inherited Members
- Extension Methods
Constructors
PercentageTask(string, Action<PercentProgressCallback>, Action?)
A task that executes an System.Action<T> and reports progress in percent.
public PercentageTask(string name, Action<PercentProgressCallback> work, Action? cancellationCallback = null)Parameters
namestringA name describing the task in human-readable form.
workAction<PercentProgressCallback>The code to be executed by the task. Is given a callback to report progress in percent. May throw System.Net.WebException, System.IO.IOException or System.OperationCanceledException.
cancellationCallbackActionAn optional callback to be called when cancellation is requested via a System.Threading.CancellationToken.
Properties
CanCancel
Indicates whether this task can be canceled once it has been started.
public override bool CanCancel { get; }Property Value
- bool
Name
A name describing the task in human-readable form.
public override string Name { get; }Property Value
- string
UnitsByte
true if UnitsProcessed and UnitsTotal are measured in bytes;
false if they are measured in generic units.
protected override bool UnitsByte { get; }Property Value
- bool
Methods
Execute()
The actual code to be executed.
protected override void Execute()Remarks
State is automatically set to Started before calling this method, to Complete after a successful exit and to an appropriate error state in case on an exception. You can set additional TaskStates during execution.