Click to Rate and Give Feedback
MSDN
MSDN Library
.NET Development
.NET Framework 3.5
 ProgressPercentage Property
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
ProgressChangedEventArgs..::.ProgressPercentage Property

Updated: November 2007

Gets the asynchronous task progress percentage.

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

Visual Basic (Declaration)
Public ReadOnly Property ProgressPercentage As Integer
Visual Basic (Usage)
Dim instance As ProgressChangedEventArgs
Dim value As Integer

value = instance.ProgressPercentage
C#
public int ProgressPercentage { get; }
Visual C++
public:
property int ProgressPercentage {
    int get ();
}
J#
/** @property */
public int get_ProgressPercentage()
JScript
public function get ProgressPercentage () : int

Property Value

Type: System..::.Int32

A percentage value indicating the asynchronous task progress.

The ProgressPercentage property determines what percentage of an asynchronous task has been completed.

The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the PictureBox..::.LoadProgressChanged event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing MessageBox..::.Show with Console..::.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of type PictureBox named PictureBox1. Then ensure that the event handler is associated with the PictureBox..::.LoadProgressChanged event.

Visual Basic
Private Sub PictureBox1_LoadProgressChanged(sender as Object, e as ProgressChangedEventArgs) _ 
     Handles PictureBox1.LoadProgressChanged

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "ProgressPercentage", e.ProgressPercentage)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "UserState", e.UserState)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"LoadProgressChanged Event")

End Sub

C#
private void PictureBox1_LoadProgressChanged(Object sender, ProgressChangedEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "ProgressPercentage", e.ProgressPercentage );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "UserState", e.UserState );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "LoadProgressChanged Event" );
}

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, 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
© 2008 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker