AFProgressEventArgs Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Provides data for a progress event.
Inheritance Hierarchy
SystemObject
SystemEventArgs
OSIsoft.AFAFProgressEventArgs
SystemEventArgs
OSIsoft.AFAFProgressEventArgs
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFProgressEventArgs : EventArgs
Public NotInheritable Class AFProgressEventArgs Inherits EventArgs Dim instance As AFProgressEventArgs
public ref class AFProgressEventArgs sealed : public EventArgs
[<SealedAttribute>] type AFProgressEventArgs = class inherit EventArgs end
The AFProgressEventArgs type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFProgressEventArgs(AFProgressStatus, AFIdentity, Guid, String) |
Initializes a new instance of the AFProgressEventArgs class.
|
| AFProgressEventArgs(AFProgressStatus, AFIdentity, Guid, String, Int32, Int32, Object) |
Initializes a new instance of the AFProgressEventArgs class.
|
Properties
| Name | Description | |
|---|---|---|
 | Cancel |
Set to to cancel the entire operation.
|
| CancelNext |
Set to to cancel the next step of this operation.
|
| CanContinue |
Set to when an error has occurred that can be continued.
|
| CurrentLineNumber |
The line number from the source file associated with this progress update, if any.
|
| CurrentPosition |
The position in the line from the source file associated with this progress update, if any.
|
| ID |
The ID of the object that is being operated on.
|
| Identity |
The Identity of the object being operated on.
|
| OperationsCompleted |
Gets the number of operations completed.
|
| Status |
Gets the status of the current operation.
|
| Tag |
The object that is associated with this progress event.
|
Methods
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| FindObject |
Retrieves the AFObject associated with the event.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString |
Returns a String that represents the current object.
(Overrides ObjectToString.) |
Remarks
This event is used to provide progress status for an operation. For example, the
ImportXml and ExportXml utilize this method to indicate the status of those respective
operations. Calling the ToString method will display status information about
the current event.