Progress<T> Class

.NET Framework 4.6 and 4.5

Provides an IProgress<T> that invokes callbacks for each reported progress value.

Namespace:  System
Assemblies:   System.Runtime.Extensions (in System.Runtime.Extensions.dll)
  mscorlib (in mscorlib.dll)

public class Progress<T> : IProgress<T>

Type Parameters


Specifies the type of the progress report value.

The Progress<T> type exposes the following members.

Public methodProgress<T>()Initializes the Progress<T> object.
Public methodProgress<T>(Action<T>)Initializes the Progress<T> object with the specified callback.

Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnReportReports a progress change.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public eventProgressChangedRaised for each reported progress value.

Explicit interface implemetationPrivate methodIProgress<T>.ReportReports a progress change.

Any handler provided to the constructor or event handlers registered with the ProgressChanged event are invoked through a SynchronizationContext instance captured when the instance is constructed. If there is no current SynchronizationContext at the time of construction, the callbacks will be invoked on the ThreadPool.

For more information and a code example, see the article Async in 4.5: Enabling Progress and Cancellation in Async APIs in the .NET Framework blog.

.NET Framework

Supported in: 4.6, 4.5

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft