Class ProgressMonitor

Provides a way for background workers to report their progress.

Inheritance
System.Object
NotificationObject
ProgressMonitor
Inherited Members
Namespace: Algenta.Colectica.Model.Utility
Assembly: Algenta.Colectica.Model.dll
Syntax
public class ProgressMonitor : NotificationObject

Properties

IsBounded

Gets or sets a value indicating whether the amount of work to be completed is known.

Declaration
public bool IsBounded { get; set; }
Property Value
Type Description
System.Boolean

TaskName

Gets or sets the name of the task for which progress is being monitored.

Declaration
public string TaskName { get; set; }
Property Value
Type Description
System.String

The name of the task.

Methods

ReportProgress(Int32, Object)

Reports progress toward the task.

Declaration
public void ReportProgress(int percent, object userState)
Parameters
Type Name Description
System.Int32 percent

The percent of work already complete.
System.Object userState

A user-defined object.

ReportProgress(Int64, Int64, Object)

Reports progress toward the task.

Declaration
public void ReportProgress(long complete, long total, object userState)
Parameters
Type Name Description
System.Int64 complete

The amount of work already complete.
System.Int64 total

The total work to be completed.
System.Object userState

A user-defined object.

ReportProgress(Object)

Raises the ProgressChanged event.

Declaration
public void ReportProgress(object userState)
Parameters
Type Name Description
System.Object userState

User state, which may be displayed as a message.

Events

ProgressChanged

Occurs when progress has changed.

Declaration
public event ProgressChangedEventHandler ProgressChanged
Event Type
Type Description
ProgressChangedEventHandler

Extension Methods