AFElement Properties
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFElement type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| Analyses |
This is a collection of analyses that target this element.
| |
| Attributes |
This is a collection of attributes that are owned by this element.
(Inherited from AFBaseElement.) | |
| 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.) | |
| CategoriesString |
This read-only property returns the list of categories in a string separated by semicolons.
(Inherited from AFBaseElement.) | |
| CheckOutInfo |
This read-only property returns the checked out status information for the object.
| |
| Database |
This read-only property returns the AFDatabase where this object is defined.
(Inherited from AFBaseElement.) | |
| DefaultAttribute |
The default AFAttribute for the AFBaseElement.
(Inherited from AFBaseElement.) | |
| DefaultInputPort |
The default input AFPort for the AFBaseElement.
(Inherited from AFBaseElement.) | |
| DefaultOutputPort |
The default output AFPort for the AFBaseElement.
(Inherited from AFBaseElement.) | |
| DefaultUndirectedPort |
The default undirected AFPort for the AFBaseElement.
(Inherited from AFBaseElement.) | |
| Description |
Read/write property that provides a more detailed description of the object.
(Inherited from AFBaseElement.) | |
| Elements |
This is a collection of child elements that have been added to this element.
| |
| ExtendedProperties |
A dictionary of extended properties that can be used to store application specific information.
(Inherited from AFBaseElement.) | |
| HasAnalyses |
This read-only property returns if there are any
AFAnalysis objects that target this element.
| |
| HasChildren |
This read-only property returns if the element has child elements.
| |
| HasNotifications |
This read-only property returns if there are any
AFNotification objects that target this element.
| |
| 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.) | |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFObject.) | |
| IsAnnotated |
This property indicates whether this element has any annotations.
(Inherited from AFBaseElement.) | |
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) | |
| IsDirty |
This read-only property indicates whether the object has been modified since the
last save to the PI AF Server.
| |
| IsNew |
This read-only property indicates whether the object is new and has never been saved
to the PI AF Server.
| |
| IsRoot |
This read-only property returns if the element is a member of the
AFDatabase.Elements collection.
| |
| Name |
Read/write property that identifies the name of the object.
(Inherited from AFBaseElement.) | |
| None |
An AFElement that represents no element.
| |
| NotificationRules |
This is a collection of AFNotificationRule objects that target this element.
| |
| Parent |
This property returns the primary parent AFElement that owns the element if it
is referenced by another element.
| |
| Parents | Obsolete.
This is a collection of all AFElement objects that reference this element.
| |
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) | |
| 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.) | |
| QueryDate |
This read-only property returns the date used to retrieve the version of an object.
| |
| Security |
This read-only property returns the AFSecurity information for the object.
| |
| Template |
The AFElementTemplate that was used to define this object.
(Inherited from AFBaseElement.) | |
| Type |
This property specifies the base type of the element.
(Overrides AFBaseElementType.) | |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) | |
| Version |
This read-only property returns the current version information as an
AFVersion object.
|
See Also
In This Topic
Related Links
- Analyses Property
- CheckOutInfo Property
- Elements Property
- HasAnalyses Property
- HasChildren Property
- HasNotifications Property
- IsDirty Property
- IsNew Property
- IsRoot Property
- None Property
- NotificationRules Property
- Parent Property
- Parents Property
- QueryDate Property
- Security Property
- Type Property
- Version Property