ProgressChangedEventArgs.UserState Property

 

Gets a unique user state.

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

public object UserState { get; }

Property Value

Type: System.Object

A unique Object indicating the user state.

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.

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" );
}

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: