IProgressMonitor

Represents a Progress Monitor.

Declaration Syntax

public interface IProgressMonitor

Table 1781: Members

Property

CanAbort

Indicates whether the user can cancel the current opertion.

Property

CanInterrupt

Indicates whether the user can interrupt the current operation.

Property

CompletedWorkUnits

The completed number of work units

Property

Parent

The parent progress monitor, if this is a child monitor. otherwise, null

Property

PropagateWorkDetails

Indicates whether to propagate a child's work details up to the parent.

Property

PropagateWorkStatus

Indicates whether to propagate a child's work status up to the parent.

Property

Status

The current status of this progress monitor.

Property

TotalWorkUnits

The total number of work units allocated to the work under progress monitoring

Property

WorkDetails

The current details for the work under progress monitoring

Property

WorkName

The name of the current work under progress monitoring

Property

WorkStatus

The current status for the work under progress monitoring

Method

BeginWork(string, double)

Starts work engaged with progress monitoring.

Method

CreateChildMonitor(double)

Creates a child progress monitor with the current monitor as its parent.

Method

EndWork()

Marks the current work as complete (progress at 100 percent).

Method

UpdateWork(double)

Updates the current work units.