ProgressChangedEventArgs.UserState Property

public:
 property System::Object ^ UserState { System::Object ^ get(); };

public object UserState { get; }

public object? UserState { get; }

member this.UserState : obj

Public ReadOnly Property UserState As Object

Property Value

A unique Object indicating the user state.

Examples

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

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

See also

• BackgroundWorker
• 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