AFEventFrame Methods
- Last UpdatedNov 18, 2025
- 11 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFEventFrame type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
  | Acknowledge(IListAFEventFrame) |
Acknowledge all AFEventFrame objects in the collection.
|
| Acknowledge(String, NullableAFTime) |
Acknowledges a single AFEventFrame.
|
 | ApplyChanges |
This method applies the changes to the object and makes
those changes available to other objects for the current user.
|
| CaptureValues |
Capture and cache the AFAttribute values with a AFDataReference
using the default non-cached data provider.
|
| CaptureValues(IAFDataProvider) |
Capture and cache the AFAttribute values with a AFDataReference
using the specified IAFDataProvider.
|
| ChangeReferenceType |
Change the existing AFReferenceType between a child event frame.
|
| CheckIn |
This method checks in (commits) all the changes to the object by saving
the information to persistent storage.
|
| CheckOut |
This method locks the object so that its configuration can be modified.
|
| CheckOutEventFrames |
Check out the objects with the specified unique identifiers at the specified query date.
|
| CompareTo(Object) |
Compares this instance with a specified Object.
(Overrides AFObjectCompareTo(Object).) |
| CompareTo(AFEventFrame) |
Compares this instance with a specified AFEventFrame.
|
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) |
| CreateElementTemplate |
Create an AFElementTemplate based upon the element.
(Inherited from AFBaseElement.) |
| Delete |
Deletes this event frame from the AFDatabase.
|
| DeleteEventFrames |
Delete the objects with the specified unique identifiers.
|
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Overrides AFObjectEquals(Object).) |
| Equals(AFEventFrame) |
Indicates whether the current object is equal to another object of the same type.
|
| Equals(AFObject) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.) |
| FindEventFrame(PISystem, Guid) |
Retrieves the AFEventFrame object with the specified unique identifier
at the AFTime.MaxValue query date.
|
| FindEventFrame(PISystem, Guid, Object) |
Retrieves the AFEventFrame object with the specified unique identifier at
the specified query date.
|
| FindEventFrames(PISystem, Guid, Object) |
Performs a search within the PISystem to retrieve a collection
of AFEventFrame objects with the specified list of unique identifiers.
|
| FindEventFrames(AFDatabase, AFEventFrame, String, AFSearchField, Boolean, AFSortField, AFSortOrder, Int32, Int32) |
Performs a paged text search within the AFDatabase to retrieve a collection
of AFEventFrame objects which have a field that matches the specified query string.
|
| FindEventFrames(AFDatabase, AFEventFrame, Object, Int32, Int32, AFEventFrameSearchMode, String, String, AFCategory, AFElementTemplate, Boolean) | Obsolete.
Retrieves a paged list of AFEventFrame objects limited to the specified
count beginning at the requested time in the specified direction that match the
specified filtering conditions.
|
| FindEventFrames(AFDatabase, AFEventFrame, Object, Int32, Int32, AFEventFrameSearchMode, String, String, AFCategory, AFElementTemplate, AFElementTemplate, Boolean) | Obsolete.
Retrieves a paged list of AFEventFrame objects limited to the specified
count beginning at the requested time in the specified direction that match the
specified filtering conditions including referenced element template filter.
|
| FindEventFrames(AFDatabase, AFEventFrame, AFSearchMode, Object, Object, String, String, AFCategory, AFElementTemplate, AFDurationQuery, Boolean, AFSortField, AFSortOrder, Int32, Int32) | Obsolete.
Retrieves a paged list of AFEventFrame objects that match the
specified filtering conditions.
|
| FindEventFrames(AFDatabase, AFEventFrame, AFSearchMode, Object, Object, String, String, AFCategory, AFElementTemplate, AFElementTemplate, AFDurationQuery, Boolean, AFSortField, AFSortOrder, Int32, Int32) | Obsolete.
Retrieves a paged list of AFEventFrame objects that match the
specified filtering conditions including referenced element template filter.
|
| FindEventFramesByAnalysis(AFAnalysis, AFSearchMode, Object, Object, AFSortField, AFSortOrder, Int32, Int32) | Obsolete.
Retrieves a paged list of AFEventFrame objects that were created by the
specified AFAnalysis that match the specified filtering conditions.
|
| FindEventFramesByAnalysis(AFAnalysis, Object, Int32, Int32, AFEventFrameSearchMode, String, String, AFCategory, AFElementTemplate, Boolean) | Obsolete.
Retrieves a paged list of AFEventFrame objects that were created by the
specified AFAnalysis limited to the specified count beginning at the
requested time in the specified direction.
|
| FindEventFramesByAttribute(AFEventFrame, Object, Int32, Int32, AFEventFrameSearchMode, String, String, AFDurationQuery, AFAttributeValueQuery, Boolean) | Obsolete.
Performs a search on the event frame's information and attribute value within the
AFDatabase to retrieve a paged list of AFEventFrame objects
limited to the specified count beginning at the requested time in the specified direction.
|
| FindEventFramesByAttribute(AFEventFrame, AFSearchMode, Object, Object, String, String, AFDurationQuery, AFAttributeValueQuery, Boolean, AFSortField, AFSortOrder, Int32, Int32) | Obsolete.
Performs a search on the event frame's information and attribute value within the
AFDatabase to retrieve a paged collection of AFEventFrame objects.
|
| FindEventFramesByExtendedProperty(AFDatabase, String, IEnumerableGuid, Int32) |
Retrieves a list of AFEventFrame objects that have the specified extended property
Guid values defined for the event frame.
|
| FindEventFramesByExtendedProperty(AFDatabase, String, IEnumerableString, Int32) |
Retrieves a list of AFEventFrame objects that have the specified extended property
string values defined for the event frame.
|
| FindEventFramesByPath(IEnumerableString, AFObject) |
Retrieves the AFEventFrame objects identified by the path strings as keyed results.
|
| FindEventFramesByPath(IEnumerableString, AFObject, IDictionaryString, String) |
Retrieves the AFEventFrame objects identified by the path strings as a list.
|
| FindEventFramesByReferenceType | Obsolete.
Retrieves a collection of AFEventFrame objects that are referenced by the
AFReferenceType from the specified searchRoot.
|
| GetAnnotations |
Retrieves a collection of existing AFAnnotation objects belonging to this
AFBaseElement.
(Inherited from AFBaseElement.) |
| GetAttributeByTrait |
Retrieves the child AFAttribute with the specified AFAttributeTrait.
(Inherited from AFBaseElement.) |
| GetAttributesByTrait |
Retrieves a list of child AFAttribute objects identified by the specified list of attribute traits.
(Inherited from AFBaseElement.) |
| GetAttributeValues(PISystem, IListAFAttributeValueQueryID, Object, Boolean, WindowsIdentity) |
This method gets a collection of AFValue objects for the specified attributes.
The collection will be the same length and in the same order as the objectIds collection.
|
| GetAttributeValues(PISystem, IListAFAttributeValueQueryID, ClaimsIdentity, Object, Boolean) |
This method gets a collection of AFValue objects for the specified attributes.
The collection will be the same length and in the same order as the objectIds collection.
|
| GetHashCode |
Gets the hash code for this instance of the object which is suitable for use in hashing
algorithms and data structures like a hash table.
(Overrides AFObjectGetHashCode.) |
| GetParents(AFCategory) |
Retrieves a collection of AFEventFrame objects that reference this event frame
using the specified AFCategory.
|
| GetParents(AFReferenceType) |
Retrieves a collection of AFEventFrame objects that reference this event frame
using the specified AFReferenceType.
|
| GetPath |
Returns the full path to the object, using just the names.
(Inherited from AFObject.) |
| GetPath(AFObject) |
Returns the path to the object relative from another object.
(Inherited from AFObject.) |
| GetPath(AFEncodeType, AFObject) |
Returns the path to the object relative from another object,
using the name and/or id as specified
by encodeType.
(Inherited from AFObject.) |
| GetPaths |
Get all the relative paths to this AFEventFrame.
|
| GetReferenceTypes |
Retrieves a collection of all AFReferenceType objects that represent types
of references from this event frame to its child event frames.
|
| GetReferenceTypes(AFEventFrame) |
Retrieves a collection of AFReferenceType objects that represent types
of references between this event frame and the specified related event frame.
|
| GetSecurity |
Gets the AFSecurity information of the specified security item
associated with the object.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsTypeOf |
Checks if the current AFBaseElement is derived from the
specified AFElementTemplate.
(Inherited from AFBaseElement.) |
| LoadEventFrames(IListAFEventFrame) |
Loads the specified list AFEventFrame objects.
|
| LoadEventFrames(PISystem, Guid, Object) |
Loads the AFEventFrame objects with the specified unique identifiers at
the specified query date.
|
| LoadEventFramesToDepth |
Loads the specified list AFEventFrame objects and their child
event frames to the hierarchical depth specified.
|
| Lock |
Locks this event frame so that no further changes can be made.
|
| Persist |
This method returns the persistence string for the object.
(Inherited from AFObject.) |
| Refresh |
Refreshes the client with any changes that have been made to the object since loaded.
|
| SetEndTime |
Set the time that represents the time that the period ended.
|
| SetStartTime |
Set the time that represents the time that the period started.
|
| ToString |
Returns a String that represents the current object.
(Inherited from AFObject.) |
| UndoCheckOut |
This method discards all the changes to the object and all sub-objects since the
last call to CheckOut. Any changes since the check out will be lost.
|
| Unlock |
Unlocks a locked event frame so that further changes can be made.
|
See Also
In This Topic
Related Links
- Acknowledge Method
- ApplyChanges Method
- CaptureValues Method
- ChangeReferenceType Method
- CheckIn Method
- CheckOut Method
- CheckOutEventFrames Method
- CompareTo Method
- Delete Method
- DeleteEventFrames Method
- Equals Method
- FindEventFrame Method
- FindEventFrames Method
- FindEventFramesByAnalysis Method
- FindEventFramesByAttribute Method
- FindEventFramesByExtendedProperty Method
- FindEventFramesByPath Method
- FindEventFramesByReferenceType Method
- GetAttributeValues Method
- GetHashCode Method
- GetParents Method
- GetPaths Method
- GetReferenceTypes Method
- GetSecurity Method
- LoadEventFrames Method
- LoadEventFramesToDepth Method
- Lock Method
- Refresh Method
- SetEndTime Method
- SetStartTime Method
- UndoCheckOut Method
- Unlock Method