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

AF SDK Reference

AFEventFrame Properties

  • Last UpdatedNov 18, 2025
  • 6 minute read
AFEventFrame Properties

The AFEventFrame type exposes the following members.

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.)

See Also

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