Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFEventFrame Class

  • Last UpdatedNov 18, 2025
  • 20 minute read
AFEventFrame Class
The AFEventFrame is a class representing objects that frame an event with a StartTime and EndTime.

Inheritance Hierarchy

Namespace:  OSIsoft.AF.EventFrame
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

[SerializableAttribute]
public class AFEventFrame : AFBaseElement, 
	IAFTimePeriod, IAFTransactable, IAFChangedEvent, IAFSecurable, IComparable<AFEventFrame>, 
	IEquatable<AFEventFrame>
<SerializableAttribute>
Public Class AFEventFrame
	Inherits AFBaseElement
	Implements IAFTimePeriod, IAFTransactable, IAFChangedEvent, IAFSecurable, 
	IComparable(Of AFEventFrame), IEquatable(Of AFEventFrame)

Dim instance As AFEventFrame
[SerializableAttribute]
public ref class AFEventFrame : public AFBaseElement, 
	IAFTimePeriod, IAFTransactable, IAFChangedEvent, IAFSecurable, IComparable<AFEventFrame^>, 
	IEquatable<AFEventFrame^>
[<SerializableAttribute>]
type AFEventFrame =  
    class
        inherit AFBaseElement
        interface IAFTimePeriod
        interface IAFTransactable
        interface IAFChangedEvent
        interface IAFSecurable
        interface IComparable<AFEventFrame>
        interface IEquatable<AFEventFrame>
    end

The AFEventFrame type exposes the following members.

Constructors

  NameDescription
Public method
AFEventFrame(AFDatabase)
Initializes a new instance of the class with default values.
Public method
AFEventFrame(AFDatabase, String)
Initializes a new instance of the class with the specified name.
Public method
AFEventFrame(AFDatabase, String, AFElementTemplate)
Initializes a new instance of the class with the specified name.
Public method
AFEventFrame(AFDatabase, String, AFElementTemplate, AFAnalysis, Boolean)
Initializes a new instance of the class with the specified name.

Properties

  NameDescription
Public property
AcknowledgedBy
This property indicates by whom the AFEventFrame was acknowledged.
Public property
AcknowledgedDate
This property indicates when the AFEventFrame was acknowledged.
Public property
Analysis
The AFAnalysis which created this object.
Public property
AreValuesCaptured
This property indicates whether the AFEventFrame has captured its AFAttribute values.
Public property
Attributes
This is a collection of attributes that are owned by this element.
(Inherited from AFBaseElement.)
Public property
CanBeAcknowledged
This property indicates whether the AFEventFrame can be acknowledged.
Public property
Categories
This is a user-defined collection of categories for the object that can be used for querying and/or reporting purposes.
(Inherited from AFBaseElement.)
Public property
CategoriesString
This read-only property returns the list of categories in a string separated by semicolons.
(Inherited from AFBaseElement.)
Public property
CheckOutInfo
This read-only property returns the checked out status information for the object.
Public property
Database
This read-only property returns the AFDatabase where this object is defined.
(Inherited from AFBaseElement.)
Public property
DefaultAttribute
The default AFAttribute for the AFBaseElement.
(Inherited from AFBaseElement.)
Public property
DefaultInputPort
The default input AFPort for the AFBaseElement.
(Inherited from AFBaseElement.)
Public property
DefaultOutputPort
The default output AFPort for the AFBaseElement.
(Inherited from AFBaseElement.)
Public property
DefaultUndirectedPort
The default undirected AFPort for the AFBaseElement.
(Inherited from AFBaseElement.)
Public property
Description
Read/write property that provides a more detailed description of the object.
(Inherited from AFBaseElement.)
Public property
Duration
This is a read-only property which returns the period's StartTime and EndTime values as a time range.
Public property
EndTime
This read-only property represents the end time of the period.
Public property
EventFrames
This is a collection of child event frames that have been added to this event frame.
Public property
ExtendedProperties
A dictionary of extended properties that can be used to store application specific information.
(Inherited from AFBaseElement.)
Public property
HasChildElements
This read-only property returns if the event frame has child elements.
Public property
HasChildEventFrames
This read-only property returns if the event frame has child event frames.
Public property
ID
Read-only property that provides a unique identifier for the object to be used for quick access that is not dependent upon the index.
(Inherited from AFObject.)
Public property
Identity
This read-only property contains identity of the object.
(Inherited from AFObject.)
Public property
IsAcknowledged
This property indicates whether the AFEventFrame has been acknowledged.
Public property
IsAnnotated
This property indicates whether this element has any annotations.
(Inherited from AFBaseElement.)
Public property
IsDeleted
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.)
Public property
IsDirty
This read-only property indicates whether the object has been modified since the last save to the PI AF Server.
Public property
IsLocked
This property indicates whether the AFEventFrame has been locked.
Public property
IsNew
This read-only property indicates whether the object is new and has never been saved to the PI AF Server.
Public property
IsRoot
This property indicates if the AFEventFrame is a root object owned by the AFDatabase.
Public property
IsTemporary
This property indicates whether the AFEventFrame is temporary. A temporary AFEventFrame cannot be saved to the server.
Public property
Name
Read/write property that identifies the name of the object.
(Inherited from AFBaseElement.)
Public property
Parent
This read-only property is returns the parent AFEventFrame that owns the event frame if it is referenced by another event frame.
Public property
Parents
This is a collection of all AFEventFrame objects that reference this event frame.
Public property
PISystem
This read-only property allows access to the PISystem associated with this object.
(Inherited from AFObject.)
Public property
Ports
This is a collection of AFPort objects representing the possible connection ports for this element. Ports are used in a AFModel to define an AFConnection between AFBaseElement object.
(Inherited from AFBaseElement.)
Public property
PrimaryReferencedElement
The primary referenced AFElement associated with the event frame.
Public property
ReferencedElements
This is a collection of elements that are referenced by this event frame.
Public property
Security
This read-only property returns the AFSecurity information for the object.
Public property
Severity
This is the severity level associated with the event.
Public property
StartTime
This read-only property represents the start time of the period.
Public property
Template
The AFElementTemplate that was used to define this object.
(Inherited from AFBaseElement.)
Public property
TimeRange
This is a read-only property which returns the period's StartTime and EndTime values as a time range.
Public property
Type
This read-only property specifies the base type of the element.
(Inherited from AFBaseElement.)
Public property
UniqueID
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.)

Methods

  NameDescription
Public methodStatic member
Acknowledge(IListAFEventFrame)
Acknowledge all AFEventFrame objects in the collection.
Public method
Acknowledge(String, NullableAFTime)
Acknowledges a single AFEventFrame.
Public methodCode example
ApplyChanges
This method applies the changes to the object and makes those changes available to other objects for the current user.
Public method
CaptureValues
Capture and cache the AFAttribute values with a AFDataReference using the default non-cached data provider.
Public method
CaptureValues(IAFDataProvider)
Capture and cache the AFAttribute values with a AFDataReference using the specified IAFDataProvider.
Public method
ChangeReferenceType
Change the existing AFReferenceType between a child event frame.
Public methodCode example
CheckIn
This method checks in (commits) all the changes to the object by saving the information to persistent storage.
Public method
CheckOut
This method locks the object so that its configuration can be modified.
Public methodStatic member
CheckOutEventFrames
Check out the objects with the specified unique identifiers at the specified query date.
Public method
CompareTo(Object)
Compares this instance with a specified Object.
(Overrides AFObjectCompareTo(Object).)
Public method
CompareTo(AFEventFrame)
Compares this instance with a specified AFEventFrame.
Public method
CompareTo(AFObject)
Compares this instance with a specified AFObject.
(Inherited from AFObject.)
Public method
CreateElementTemplate
Create an AFElementTemplate based upon the element.
(Inherited from AFBaseElement.)
Public method
Delete
Deletes this event frame from the AFDatabase.
Public methodStatic memberCode example
DeleteEventFrames
Delete the objects with the specified unique identifiers.
Public method
Equals(Object)
Determines whether the specified Object is equal to the current object.
(Overrides AFObjectEquals(Object).)
Public method
Equals(AFEventFrame)
Indicates whether the current object is equal to another object of the same type.
Public method
Equals(AFObject)
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.)
Public methodStatic member
FindEventFrame(PISystem, Guid)
Retrieves the AFEventFrame object with the specified unique identifier at the AFTime.MaxValue query date.
Public methodStatic member
FindEventFrame(PISystem, Guid, Object)
Retrieves the AFEventFrame object with the specified unique identifier at the specified query date.
Public methodStatic member
FindEventFrames(PISystem, Guid, Object)
Performs a search within the PISystem to retrieve a collection of AFEventFrame objects with the specified list of unique identifiers.
Public methodStatic member
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.
Public methodStatic member
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.
Public methodStatic member
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.
Public methodStatic member
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.
Public methodStatic member
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.
Public methodStatic member
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.
Public methodStatic member
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.
Public methodStatic member
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.
Public methodStatic member
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.
Public methodStatic member
FindEventFramesByExtendedProperty(AFDatabase, String, IEnumerableGuid, Int32)
Retrieves a list of AFEventFrame objects that have the specified extended property Guid values defined for the event frame.
Public methodStatic member
FindEventFramesByExtendedProperty(AFDatabase, String, IEnumerableString, Int32)
Retrieves a list of AFEventFrame objects that have the specified extended property string values defined for the event frame.
Public methodStatic member
FindEventFramesByPath(IEnumerableString, AFObject)
Retrieves the AFEventFrame objects identified by the path strings as keyed results.
Public methodStatic member
FindEventFramesByPath(IEnumerableString, AFObject, IDictionaryString, String)
Retrieves the AFEventFrame objects identified by the path strings as a list.
Public methodStatic member
FindEventFramesByReferenceType Obsolete.
Retrieves a collection of AFEventFrame objects that are referenced by the AFReferenceType from the specified searchRoot.
Public method
GetAnnotations
Retrieves a collection of existing AFAnnotation objects belonging to this AFBaseElement.
(Inherited from AFBaseElement.)
Public method
GetAttributeByTrait
Retrieves the child AFAttribute with the specified AFAttributeTrait.
(Inherited from AFBaseElement.)
Public method
GetAttributesByTrait
Retrieves a list of child AFAttribute objects identified by the specified list of attribute traits.
(Inherited from AFBaseElement.)
Public methodStatic member
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.
Public methodStatic member
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.
Public method
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.)
Public method
GetParents(AFCategory)
Retrieves a collection of AFEventFrame objects that reference this event frame using the specified AFCategory.
Public method
GetParents(AFReferenceType)
Retrieves a collection of AFEventFrame objects that reference this event frame using the specified AFReferenceType.
Public method
GetPath
Returns the full path to the object, using just the names.
(Inherited from AFObject.)
Public method
GetPath(AFObject)
Returns the path to the object relative from another object.
(Inherited from AFObject.)
Public method
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.)
Public method
GetPaths
Get all the relative paths to this AFEventFrame.
Public method
GetReferenceTypes
Retrieves a collection of all AFReferenceType objects that represent types of references from this event frame to its child event frames.
Public method
GetReferenceTypes(AFEventFrame)
Retrieves a collection of AFReferenceType objects that represent types of references between this event frame and the specified related event frame.
Public method
GetSecurity
Gets the AFSecurity information of the specified security item associated with the object.
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
IsTypeOf
Checks if the current AFBaseElement is derived from the specified AFElementTemplate.
(Inherited from AFBaseElement.)
Public methodStatic member
LoadEventFrames(IListAFEventFrame)
Loads the specified list AFEventFrame objects.
Public methodStatic member
LoadEventFrames(PISystem, Guid, Object)
Loads the AFEventFrame objects with the specified unique identifiers at the specified query date.
Public methodStatic memberCode example
LoadEventFramesToDepth
Loads the specified list AFEventFrame objects and their child event frames to the hierarchical depth specified.
Public method
Lock
Locks this event frame so that no further changes can be made.
Public method
Persist
This method returns the persistence string for the object.
(Inherited from AFObject.)
Public method
Refresh
Refreshes the client with any changes that have been made to the object since loaded.
Public method
SetEndTime
Set the time that represents the time that the period ended.
Public method
SetStartTime
Set the time that represents the time that the period started.
Public method
ToString
Returns a String that represents the current object.
(Inherited from AFObject.)
Public method
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.
Public method
Unlock
Unlocks a locked event frame so that further changes can be made.

Events

  NameDescription
Public eventCode example
Changed
Event is raised when the object or one of its sub-objects is changed.

Operators

  NameDescription
Public operatorStatic member
Equality
The equality operator (==) compares its operands to determine if they are equal.
Public operatorStatic member
GreaterThan
The greater than relation operator (>) compares its operands to determine which one is greater than the other.
Public operatorStatic member
GreaterThanOrEqual
The greater than or equal relation operator (>=) compares its operands to determine which one is greater than or equal to the other.
Public operatorStatic member
Inequality
The inequality operator (!=) compares its operands to determine if they are not equal.
Public operatorStatic member
LessThan
The less than relation operator (<) compares its operands to determine which one is less than the other.
Public operatorStatic member
LessThanOrEqual
The less than or equal relation operator (<=) compares its operands to determine which one is less than or equal to the other.

Remarks

Use the PISystem.Supports method to check if the PISystem supports the EventFrame feature. The AFEventFrameSearch class can be used for finding event frames.

Examples

// This example demonstrates how to create an EventFrame and display its information.

// Get the Database
PISystems myPISystems = new PISystems();
AFDatabase myDB = myPISystems.DefaultPISystem.Databases.DefaultDatabase;

// Create an EventFrame
AFEventFrame myEventFrame = new AFEventFrame(myDB, "MyEventFrame*");
myEventFrame.SetStartTime("T-1w");
myEventFrame.SetEndTime(AFTime.Now);
myEventFrame.Description = "This is my EventFrame";
myEventFrame.CheckIn();

// Search for EventFrames
AFNamedCollectionList<AFEventFrame> list = AFEventFrame.FindEventFrames(myDB, null, AFTime.Now, 0, 200,
    AFEventFrameSearchMode.BackwardFromStartTime, null, null, null, null, false);

// Display EventFrame Information
foreach (AFEventFrame CurEventFrame in list)
{
    Console.WriteLine("Name of EventFrame = {0}", CurEventFrame.Name);
    Console.WriteLine("StartTime = {0}, EndTime = {1}",
        CurEventFrame.StartTime, CurEventFrame.EndTime);
    Console.WriteLine("Description = {0}", CurEventFrame.Description);
}
' This example demonstrates how to create an EventFrame and display its information.

' Get the Database
Dim myPISystems As New PISystems
Dim myDB As AFDatabase = myPISystems.DefaultPISystem.Databases.DefaultDatabase

' Create an EventFrame
Dim myEventFrame As AFEventFrame = New AFEventFrame(myDB, "MyEventFrame*")
myEventFrame.SetStartTime("T-1w")
myEventFrame.SetEndTime(AFTime.Now)
myEventFrame.Description = "This is my EventFrame"
myEventFrame.CheckIn()

' Search for EventFrames
Dim list As AFNamedCollectionList(Of AFEventFrame) = AFEventFrame.FindEventFrames(myDB, Nothing, AFTime.Now, 0, 200,
                    AFEventFrameSearchMode.BackwardFromStartTime, Nothing, Nothing, Nothing, Nothing, False)

' Display EventFrame Information
For Each CurEventFrame As AFEventFrame In list
    Console.WriteLine("Name of EventFrame = {0}", CurEventFrame.Name)
    Console.WriteLine("StartTime = {0}, EndTime = {1}", CurEventFrame.StartTime, CurEventFrame.EndTime)
    Console.WriteLine("Description = {0}", CurEventFrame.Description)
Next

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

Version Information

AFSDK


See Also

TitleResults for “How to create a CRG?”Also Available in