AFElement Methods
- Last UpdatedNov 18, 2025
- 15 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFElement type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
  | ApplyChanges |
This method applies the changes to the object and makes
those changes available to other objects for the current user.
|
| ApplyQueryDate |
Applies the specified query date to the current object and returns an object in the new context.
|
| ChangeReferenceType |
Change the existing AFReferenceType between a child element or the AFDatabase.
|
| 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.
|
 | CheckOutElements |
Check out the objects with the specified unique identifiers at the specified query date.
|
| CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) |
| ConvertTo |
Converts the current object to the specified type of an AFElement.
|
| CreateDefaultPorts |
This method can be used to create the default connection ports based upon the
element's type.
|
| CreateElementTemplate |
Create an AFElementTemplate based upon the element.
(Inherited from AFBaseElement.) |
| Delete |
Deletes all versions of this element from the AFDatabase.
|
| DeleteElements |
Delete the objects with the specified unique identifiers.
|
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.) |
| Equals(AFObject) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.) |
| FindElement(PISystem, Guid) |
Retrieves the AFElement object with the specified unique identifier
at the AFTime.MaxValue query date.
|
| FindElement(PISystem, Guid, Guid) |
Retrieves the AFElement object with the specified unique identifier
and the specified version id.
|
| FindElement(PISystem, Guid, Object) |
Retrieves the AFElement object with the specified unique identifier
at the specified query date.
|
| FindElements(PISystem, Guid, Object) | |
| FindElements(AFDatabase, AFElement, String, AFSearchField, Boolean, AFSortField, AFSortOrder, Int32) |
Performs a non-paged text search within the AFDatabase to retrieve a collection
of AFElement objects which have a field that matches the specified query string.
|
| FindElements(AFDatabase, AFElement, String, AFCategory, AFElementTemplate, AFElementType, Boolean, AFSortField, AFSortOrder, Int32) | Obsolete.
Performs a search on the element's name within the AFDatabase
to retrieve a non-paged collection of AFElement objects that match the specified
query string and additional filters.
|
| FindElements(AFDatabase, AFElement, String, AFSearchField, Boolean, AFSortField, AFSortOrder, Int32, Int32, Int32) |
Performs a paged text search within the AFDatabase to retrieve a collection
of AFElement objects which have a field that matches the specified query string.
|
| FindElements(AFDatabase, AFElement, String, String, AFCategory, AFElementTemplate, AFElementType, Boolean, AFSortField, AFSortOrder, Int32) | Obsolete.
Performs a search on the element's name within the AFDatabase
to retrieve a non-paged collection of AFElement objects that match the specified
query string and additional filters.
|
| FindElements(AFDatabase, AFElement, String, AFCategory, AFElementTemplate, AFElementType, Boolean, AFSortField, AFSortOrder, Int32, Int32, Int32) | Obsolete.
Performs a search on the element's name within the AFDatabase
to retrieve a paged collection of AFElement objects that match the specified
query string and additional filters.
|
| FindElements(AFDatabase, AFElement, String, String, AFCategory, AFElementTemplate, AFElementType, Boolean, AFSortField, AFSortOrder, Int32, Int32, Int32) | Obsolete.
Performs a search on the element's name within the AFDatabase
to retrieve a paged collection of AFElement objects that match the specified
query string and additional filters.
|
| FindElementsByAttribute(AFElement, String, AFAttributeValueQuery, Boolean, AFSortField, AFSortOrder, Int32) | Obsolete.
Performs a search on the element's name and attribute values within the
AFDatabase to retrieve a non-paged collection of AFElement objects.
|
| FindElementsByAttribute(AFElement, String, AFAttributeValueQuery, Boolean, AFSortField, AFSortOrder, Int32, Int32, Int32) | Obsolete.
Performs a search on the element's name and attribute values within the
AFDatabase to retrieve a paged collection of AFElement objects.
|
| FindElementsByAttribute(AFElement, String, String, AFCategory, AFAttributeValueQuery, Boolean, AFSortField, AFSortOrder, Int32) | Obsolete.
Performs a search on the element's name, category, and attribute values within the
AFDatabase to retrieve a non-paged collection of AFElement objects.
|
| FindElementsByAttribute(AFElement, String, String, AFCategory, AFAttributeValueQuery, Boolean, AFSortField, AFSortOrder, Int32, Int32, Int32) | Obsolete.
Performs a search on the element's name, description, category, and attribute values within the
AFDatabase to retrieve a paged collection of AFElement objects.
|
| FindElementsByCategory(AFDatabase, AFElement, AFCategory, Boolean, AFSortField, AFSortOrder, Int32) | Obsolete.
Retrieves a non-paged collection of AFElement objects that have the specified AFCategory
defined for the element.
|
| FindElementsByCategory(AFDatabase, AFElement, AFCategory, Boolean, AFSortField, AFSortOrder, Int32, Int32, Int32) | Obsolete.
Retrieves a paged collection of AFElement objects that have the specified AFCategory
defined for the element.
|
| FindElementsByExtendedProperty(AFDatabase, String, IEnumerableGuid, Int32) |
Retrieves a list of AFElement objects that have the specified extended property
Guid values defined for the element.
|
| FindElementsByExtendedProperty(AFDatabase, String, IEnumerableString, Int32) |
Retrieves a list of AFElement objects that have the specified extended property
string values defined for the element.
|
| FindElementsByPath(IEnumerableString, AFObject) |
Retrieves the AFElement objects identified by the path strings as keyed results.
|
| FindElementsByPath(IEnumerableString, AFObject, IDictionaryString, String) |
Retrieves the AFElement objects identified by the path strings as a list.
|
| FindElementsByReferenceType(AFDatabase, AFElement, AFReferenceType, AFSortField, AFSortOrder, Int32) | Obsolete.
Retrieves a non-paged collection of AFElement objects that are referenced by the
AFReferenceType under the specified searchRoot or
AFDatabase.
|
| FindElementsByReferenceType(AFDatabase, AFElement, AFReferenceType, AFSortField, AFSortOrder, Int32, Int32, Int32) | Obsolete.
Retrieves a paged collection of AFElement objects that are referenced by the
AFReferenceType under the specified searchRoot or
AFDatabase.
|
| FindElementsByTemplate(AFDatabase, AFObject, AFElementTemplate, Boolean, AFSortField, AFSortOrder, Int32) |
Retrieves a non-paged collection of AFElement objects that are instantiated from the specified
AFElementTemplate.
|
| FindElementsByTemplate(AFDatabase, AFObject, AFElementTemplate, Boolean, AFSortField, AFSortOrder, Int32, Int32, Int32) |
Retrieves a paged collection of AFElement objects that are instantiated from the specified
AFElementTemplate.
|
| GetAnalyses | Obsolete.
Retrieves a collection of AFAnalysis objects that target this element.
|
| 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.
|
| GetElements(AFSortField, AFSortOrder, Int32) | Obsolete.
Retrieves a non-paged collection of child AFElement objects that have been added
to this element.
|
| GetElements(AFSortField, AFSortOrder, Int32, Int32, Int32) | Obsolete.
Retrieves a paged collection of child AFElement objects that have been added
to this element.
|
| GetEventFrames(Object, Int32, Int32, AFEventFrameSearchMode, String, AFCategory, AFElementTemplate) | Obsolete.
Retrieves a paged collection of AFEventFrame objects that reference this element
limited to the specified count beginning at the requested start time in the specified direction.
|
| GetEventFrames(AFSearchMode, Object, Object, String, AFCategory, AFElementTemplate, AFSortField, AFSortOrder, Int32, Int32) | Obsolete.
Retrieves a paged collection of AFEventFrame objects that reference this element
within the specified time range.
|
| 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.
(Inherited from AFObject.) |
| GetNotifications |
Retrieves a collection of AFNotification objects that target this element.
|
| GetParents(AFSortField, AFSortOrder, Int32) |
Retrieves a non-paged collection of AFElement objects that reference this element.
|
| GetParents(AFCategory, AFSortField, AFSortOrder, Int32) |
Retrieves a non-paged collection of AFElement objects that reference this element
using the specified AFCategory.
|
| GetParents(AFReferenceType, AFSortField, AFSortOrder, Int32) |
Retrieves a non-paged collection of AFElement objects that reference this element
using the specified AFReferenceType.
|
| GetParents(AFSortField, AFSortOrder, Int32, Int32, Int32) |
Retrieves a paged collection of AFElement objects that reference this element.
|
| GetParents(AFCategory, AFSortField, AFSortOrder, Int32, Int32, Int32) |
Retrieves a paged collection of AFElement objects that reference this element
using the specified AFCategory.
|
| GetParents(AFReferenceType, AFSortField, AFSortOrder, Int32, Int32, Int32) |
Retrieves a paged collection of AFElement objects that reference this element
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(String, IListAFElement) |
Get a path to the child elements.
|
| 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 full paths to this AFElement.
|
| GetPaths(String) |
Get all the relative paths to this AFElement.
|
| GetPaths(String, IListAFElement) |
Get all paths to the child elements.
|
| GetReferenceTypes |
Retrieves a collection of all AFReferenceType objects that represent types
of references from this element to its child elements.
|
| GetReferenceTypes(AFElement) |
Retrieves a collection of AFReferenceType objects that represent types
of references between this element and the specified related element.
|
| 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.) |
| LoadAttributes(IListAFElement, IListAFAttributeTemplate) |
Partially load the list of elements with the specified attributes.
|
| LoadAttributes(PISystem, IListGuid, IListAFAttributeTemplate, Object) |
Partially loads the AFElement objects for the list of unique identifiers
with the specified attributes.
|
| LoadElementReferences |
Loads the AFElement objects referenced by the specified elements.
|
| LoadElements(IListAFElement) |
Loads the specified list AFElement objects.
|
| LoadElements(PISystem, Guid, Object) |
Loads the AFElement objects with the specified unique identifiers
at the specified query date.
|
| LoadElementsToDepth |
Loads the specified list AFElement objects and their child
elements to the hierarchical depth specified.
|
| LoadParents |
Loads the primary parent of each AFElement specified in the list.
|
| 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.
|
| 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.
|
See Also
In This Topic
Related Links
- ApplyChanges Method
- ApplyQueryDate Method
- ChangeReferenceType Method
- CheckIn Method
- CheckOut Method
- CheckOutElements Method
- ConvertTo Method
- CreateDefaultPorts Method
- Delete Method
- DeleteElements Method
- FindElement Method
- FindElements Method
- FindElementsByAttribute Method
- FindElementsByCategory Method
- FindElementsByExtendedProperty Method
- FindElementsByPath Method
- FindElementsByReferenceType Method
- FindElementsByTemplate Method
- GetAnalyses Method
- GetAttributeValues Method
- GetElements Method
- GetEventFrames Method
- GetNotifications Method
- GetParents Method
- GetPath Method
- GetPaths Method
- GetReferenceTypes Method
- GetSecurity Method
- LoadAttributes Method
- LoadElementReferences Method
- LoadElements Method
- LoadElementsToDepth Method
- LoadParents Method
- Refresh Method
- UndoCheckOut Method