Click or drag to resize

Reporter Properties

The ExternalDrivenBackgroundMonitorReporter type exposes the following members.

Properties
 NameDescription
Public propertyCancellationPending Returns true if the activity was cancelled by the user. The script has to check this value periodically. If it is set to true, the script should return.
Public propertyCancellationToken Gets the cancellation token (soft). Typical use of the soft cancellation token is to interrupt some work, without compromising the result (the result typically is incomplete, but not corrupted).
Public propertyCancellationTokenHard Gets the hard-cancellation token.
Protected propertyFractionOfWorkOfParentThe fraction of work the parent has assigned to this subtask.
Public propertyLevel Gets the nesting level of this reporter.
Protected propertyParent Gets the parent reporter, or null if this is the root reporter.
Protected propertyRoot Gets the root monitor that receives the aggregated progress.
Public propertyShouldReportNow True if we should report the progress now. The progress can be reported at any time, but if the evaluation of the progress is costing, then this flag should be viewed first.
Public propertyTaskName Gets the name to show while the task is active.
Top
See Also