This topic has not yet been rated - Rate this topic

ProgressChangedEventArgs Class

.NET Framework 4.5

Other Versions

Provides data for the ProgressChanged event.

Inheritance Hierarchy

System.Object
  System.EventArgs
    System.ComponentModel.ProgressChangedEventArgs
      More...

Namespace: System.ComponentModel
Assembly: System (in System.dll)

Syntax

C++

[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public class ProgressChangedEventArgs : EventArgs

The ProgressChangedEventArgs type exposes the following members.

Constructors

	Name	Description
	ProgressChangedEventArgs	Initializes a new instance of the ProgressChangedEventArgs class.

Top

Properties

	Name	Description
	ProgressPercentage	Gets the asynchronous task progress percentage.
	UserState	Gets a unique user state.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Note
The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

Note

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

Examples

The following code example shows how to use the ProgressChangedEventArgs class. This example is part of a larger example for the BackgroundWorker class.

C++

// This event handler updates the progress bar. 
private void backgroundWorker1_ProgressChanged(object sender,
    ProgressChangedEventArgs e)
{
    this.progressBar1.Value = e.ProgressPercentage;
}

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

System.ComponentModel Namespace

BackgroundWorker

Other Resources

How to: Implement a Component That Supports the Event-based Asynchronous Pattern

How to: Run an Operation in the Background

How to: Implement a Form That Uses a Background Operation

How to: Use Components That Support the Event-based Asynchronous Pattern

Inheritance Hierarchy

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)