ProgressChangedEventArgs.UserState Property (System.ComponentModel)

UserState Property

Collapse All

Language Filter

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..::.UserState Property

Updated: November 2007

Gets a unique user state.

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

Syntax

Visual Basic (Declaration)

Public ReadOnly Property UserState As Object

Visual Basic (Usage)

Dim instance As ProgressChangedEventArgs
Dim value As Object

value = instance.UserState

public Object UserState { get; }

Visual C++

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

/** @property */
public Object get_UserState()

JScript

public function get UserState () : Object

Property Value

Type: System..::.Object

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.

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

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

Platforms

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.

Version Information