mscorlib(4.0.0.0) API with additions
System.Progress< T > Class Template Reference

Provides an T:System.IProgress`1 that invokes callbacks for each reported progress value. More...

Inheritance diagram for System.Progress< T >:
[legend]
Collaboration diagram for System.Progress< T >:
[legend]

Public Member Functions

 Progress ()
 Initializes the T:System.Progress`1 object. More...
 
 Progress (Action< T > handler)
 Initializes the T:System.Progress`1 object with the specified callback. More...
 
- Public Member Functions inherited from System.IProgress< T >
void Report (T value)
 Reports a progress update. More...
 

Protected Member Functions

virtual void OnReport (T value)
 Reports a progress change. More...
 

Events

EventHandler< TProgressChanged
 Raised for each reported progress value. More...
 

Detailed Description

Provides an T:System.IProgress`1 that invokes callbacks for each reported progress value.

Template Parameters
TSpecifies the type of the progress report value.

Definition at line 8 of file Progress.cs.

Constructor & Destructor Documentation

◆ Progress() [1/2]

Initializes the T:System.Progress`1 object.

Definition at line 23 of file Progress.cs.

◆ Progress() [2/2]

System.Progress< T >.Progress ( Action< T handler)

Initializes the T:System.Progress`1 object with the specified callback.

Parameters
handlerA handler to invoke for each reported progress value. This handler will be invoked in addition to any delegates registered with the E:System.Progress`1.ProgressChanged event. Depending on the T:System.Threading.SynchronizationContext instance captured by the T:System.Progress`1 at construction, it is possible that this handler instance could be invoked concurrently with itself.

Definition at line 32 of file Progress.cs.

Member Function Documentation

◆ OnReport()

virtual void System.Progress< T >.OnReport ( T  value)
protectedvirtual

Reports a progress change.

Parameters
valueThe value of the updated progress.

Definition at line 45 of file Progress.cs.

Event Documentation

◆ ProgressChanged

EventHandler<T> System.Progress< T >.ProgressChanged

Raised for each reported progress value.

Definition at line 19 of file Progress.cs.


The documentation for this class was generated from the following file: