AFChangeAction Enumeration
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Specifies how the AFObject is changed.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public enum AFChangeAction
Public Enumeration AFChangeAction Dim instance As AFChangeAction
public enum class AFChangeAction
type AFChangeAction
Members
| Member name | Value | Description | |
|---|---|---|---|
| CheckOut | 0 | Specifies that a change in the check out status of the object has occurred. | |
| DirtyCleared | 1 | Specifies that the dirty status of the object has been cleared. | |
| Change | 2 | Specifies that a property of the object was changed. | |
| Convert | 3 | Specifies that the object was converted. The object that receives this event is no longer valid. | |
| Delete | 4 | Specifies that the object was deleted. | |
| SubObjectChange | 5 | Specifies that a change was made to one of the sub-objects that the object owns. For an AFDatabase it specifies that a change was made to one of the objects in the database. For a PISystem it specifies that a change was made to one of the system-level objects. | |
| SubObjectValueChange | 6 | Specifies that a change was made to the value of one of the AFAttribute sub-objects that the object owns. | |
| SubObjectAdd | 7 | Specifies that a sub-object was added to the object. For an AFDatabase it specifies that a new object was added to the database. For a PISystem it specifies that a new object was added at the system-level. | |
| SubObjectRemove | 8 | Specifies that a sub-object was removed from the object. For an AFDatabase it specifies that an object was removed from the database. For a PISystem it specifies that an object was removed at the system-level. | |
| SubObjectRefresh | 9 | Specifies that the entire collection of sub-objects has changed and needs to be refreshed. This can be caused by operations that manipulate the entire collection. For an AFDatabase it specifies that a refresh occurred to one of the objects in the database. For a PISystem it specifies that a refresh occurred to one of the system-level objects. | |
| VersionChange | 10 | Specifies that the object's version has changed. The object that receives this event is no longer valid for its specified query date. | |
| Refresh | 11 | Specifies that the entire object has been refreshed and all information and sub-objects of this object may need to be updated. The object that receives this event will not receive other sub-object events. |
Remarks
The AFChangedEventArgs class uses this enumeration to define
the action that caused the event to be raised.