Click to Rate and Give Feedback
MSDN
MSDN Library
.NET Development
.NET Framework 3.5
 ProgressChangedEventHandler Delegat...
Collapse All/Expand All Collapse All
This page is specific to
Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:
.NET Framework Class Library
ProgressChangedEventHandler Delegate

Represents the method that will handle the ProgressChanged event of the BackgroundWorker class. This class cannot be inherited.

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)
Visual Basic (Declaration)
<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState := True)> _
Public Delegate Sub ProgressChangedEventHandler ( _
    sender As Object, _
    e As ProgressChangedEventArgs _
)
Visual Basic (Usage)
Dim instance As New ProgressChangedEventHandler(AddressOf HandlerMethod)
C#
[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public delegate void ProgressChangedEventHandler(
    Object sender,
    ProgressChangedEventArgs e
)
Visual C++
[HostProtectionAttribute(SecurityAction::LinkDemand, SharedState = true)]
public delegate void ProgressChangedEventHandler(
    Object^ sender, 
    ProgressChangedEventArgs^ e
)
JScript
JScript does not support delegates.

Parameters

sender
Type: System..::.Object
The source of the event.
e
Type: System.ComponentModel..::.ProgressChangedEventArgs
A ProgressChangedEventArgs that contains the event data.
NoteNote:

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.

When you create a ProgressChangedEventHandler delegate, you identify a method to handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see Events and Delegates.

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

Visual Basic
' This event handler updates the progress bar.
Private Sub backgroundWorker1_ProgressChanged( _
ByVal sender As Object, ByVal e As ProgressChangedEventArgs) _
Handles backgroundWorker1.ProgressChanged

    Me.progressBar1.Value = e.ProgressPercentage

End Sub
C#
// This event handler updates the progress bar.
private void backgroundWorker1_ProgressChanged(object sender,
    ProgressChangedEventArgs e)
{
    this.progressBar1.Value = e.ProgressPercentage;
}
Visual C++
// This event handler updates the progress bar.
void backgroundWorker1_ProgressChanged( Object^ /*sender*/, ProgressChangedEventArgs^ e )
{
   this->progressBar1->Value = e->ProgressPercentage;
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2009 Microsoft Corporation. All rights reserved. Terms of Use | Trademarks | Privacy Statement
Page view tracker