agi.foundation.compatibility

(agi.foundation.core-2024r2.jar)

Class ProgressChangedEventArgs

java.lang.Object

agi.foundation.compatibility.EventArgs

agi.foundation.compatibility.ProgressChangedEventArgs

public class ProgressChangedEventArgs
extends EventArgs

Provides data for the ProgressChanged event.

Field Summary

Fields inherited from class agi.foundation.compatibility.EventArgs

Empty

Constructor Summary

Constructors

Constructor and Description
ProgressChangedEventArgs(int progressPercentage, Object userState) Initializes a new instance of the ProgressChangedEventArgs class.

Method Summary

Modifier and Type	Method and Description
int	getProgressPercentage() Gets the asynchronous task progress percentage.
Object	getUserState() Gets a unique user state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProgressChangedEventArgs

public ProgressChangedEventArgs(int progressPercentage,
                                Object userState)

Initializes a new instance of the ProgressChangedEventArgs class.

Parameters:

progressPercentage - The percentage of an asynchronous task that has been completed.

userState - A unique user state.

Method Detail

getProgressPercentage

public int getProgressPercentage()

Gets the asynchronous task progress percentage.

Returns:

A percentage value indicating the asynchronous task progress.

getUserState

public Object getUserState()

Gets a unique user state.

Returns:

A unique Object indicating the user state.