AFElementTemplates Class
- Last UpdatedNov 18, 2025
- 8 minute read
- PI System
- AF SDK 2024 R2
- Developer
The collection of AFElementTemplate objects.

Inheritance Hierarchy
SystemObject
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFElementTemplate
OSIsoft.AFAFNamedCollectionAFElementTemplate
OSIsoft.AF.AssetAFElementTemplates
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFElementTemplate
OSIsoft.AFAFNamedCollectionAFElementTemplate
OSIsoft.AF.AssetAFElementTemplates
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFElementTemplates : AFNamedCollection<AFElementTemplate>
Public NotInheritable Class AFElementTemplates Inherits AFNamedCollection(Of AFElementTemplate) Dim instance As AFElementTemplates
public ref class AFElementTemplates sealed : public AFNamedCollection<AFElementTemplate^>
[<SealedAttribute>] type AFElementTemplates = class inherit AFNamedCollection<AFElementTemplate> end
The AFElementTemplates type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| Count |
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.) | |
| Database |
This read-only property returns the AFDatabase where this object is defined.
| |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFCollection.) | |
| IsDeleted |
This read-only property indicates whether the owner of the collection has been deleted.
(Inherited from AFCollection.) | |
| ItemGuid | Returns the item in the collection associated with the passed in ID. (Inherited from AFCollectionT.) | |
| ItemInt32 | Returns the item located at the passed in index. (Inherited from AFCollectionT.) | |
| ItemString |
Returns the specified object from the collection by name.
(Inherited from AFNamedCollectionT.) | |
| ItemIdentity |
This read-only property specifies the identity of the objects within the collection.
(Inherited from AFCollection.) | |
| PISystem |
This read-only property allows access to the PISystem
associated with this collection.
(Inherited from AFCollection.) |
Methods
| Name | Description | |
|---|---|---|
| Add(T) |
Adds an object to the end of the collection.
(Inherited from AFCollectionT.) | |
| Add(String) |
The Add method creates a new object and adds it to the collection.
| |
| Clear |
Removes all items from the collection.
(Inherited from AFCollectionT.) | |
| Contains(Guid) |
This method determines whether the collection contains a specific item referenced by id.
(Inherited from AFCollectionT.) | |
| Contains(T) |
This method determines whether the collection contains a specific item.
(Inherited from AFCollectionT.) | |
| Contains(String) |
This method determines whether the collection contains a specific item referenced by name.
(Inherited from AFNamedCollectionT.) | |
| CopyTo |
Copies the entire collection to a compatible one-dimensional Array,
starting at the specified index of the target array.
(Inherited from AFCollectionT.) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
| GetEnumerator |
Returns an enumerator that iterates through the collection.
(Inherited from AFCollectionT.) | |
| 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 AFCollection.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| IndexOf |
Searches for the specified object and returns the zero-based index of the first
occurrence within the entire collection.
(Inherited from AFCollectionT.) | |
| Refresh |
Refresh the collection to make sure it's list of items is up-to-date.
| |
| Remove(Guid) |
Removes the item with the specified id from the collection.
(Inherited from AFCollectionT.) | |
| Remove(T) |
Removes the first occurrence of a specific object from the collection.
(Inherited from AFCollectionT.) | |
| Remove(String) |
The Remove method removes the item from the collection by name.
(Inherited from AFNamedCollectionT.) | |
| RemoveAt |
Removes the item at the specified index of the collection.
(Inherited from AFCollectionT.) | |
| Sort |
Sorts the items in the entire collection using the default comparer.
(Inherited from AFCollectionT.) | |
| Sort(IComparerT) |
Sorts the items in the entire collection using the specified comparer.
(Inherited from AFCollectionT.) | |
| Sort(Int32, Int32, IComparerT) |
Sorts the items in a range of items in the collection using the specified comparer.
(Inherited from AFCollectionT.) | |
| ToString |
Returns a String that represents the current object.
(Inherited from AFCollection.) |
Remarks
The global AFElementTemplates collection represents all the defined AFElementTemplate
objects on an AFDatabase. Use the
Add(String) method to add a template to this
collection.
Examples
// This example demonstrates how to create an element template, // create an element from it, and display its information. // Get the Database PISystems myPISystems = new PISystems(); AFDatabase myDB = myPISystems.DefaultPISystem.Databases.DefaultDatabase; // Create an Element Template AFElementTemplate myElemTemplate = myDB.ElementTemplates.Add("MyElementTemplate"); myElemTemplate.Description = "Template used to create my elements"; // Create an Element from the Element Template myDB.Elements.Add("MyElement", myElemTemplate); myDB.CheckIn(); // Display the name and description of the Element Template Console.WriteLine("Name of Element Template = {0}", myElemTemplate.Name); Console.WriteLine("Description = {0}", myElemTemplate.Description); Console.WriteLine("UniqueID of Element Template = {0}", myElemTemplate.UniqueID); // Display the name of all Elements created from this Element Template const int pageSize = 100; int startIndex = 0; int totalCount; do { AFNamedCollectionList<AFBaseElement> list = myElemTemplate.FindInstantiatedElements(true, AFSortField.Name, AFSortOrder.Ascending, startIndex, pageSize, out totalCount); if (list == null) break; foreach (AFBaseElement CurElement in list) { Console.WriteLine("Name of Element created from this template = {0}", CurElement.Name); } startIndex += pageSize; // Advance to next page. } while (startIndex < totalCount);
' This example demonstrates how to create an element template, ' create an element from it, and display its information. ' Get the Database Dim myPISystems As New PISystems Dim myDB As AFDatabase = myPISystems.DefaultPISystem.Databases.DefaultDatabase ' Create an Element Template Dim myElemTemplate As AFElementTemplate = myDB.ElementTemplates.Add("MyElementTemplate") myElemTemplate.Description = "Template used to create my elements" ' Create an Element from the Element Template myDB.Elements.Add("MyElement", myElemTemplate) myDB.CheckIn() ' Display the name and description of the Element Template Console.WriteLine("Name of Element Template = {0}", myElemTemplate.Name) Console.WriteLine("Description = {0}", myElemTemplate.Description) Console.WriteLine("UniqueID = {0}", myElemTemplate.UniqueID) ' Display the name of all Elements created from this Element Template Dim pageSize As Integer = 100 Dim startIndex As Integer = 0 Dim totalCount As Integer Dim list As AFNamedCollectionList(Of AFBaseElement) Do list = myElemTemplate.FindInstantiatedElements(True, AFSortField.Name, AFSortOrder.Descending, startIndex, pageSize, totalCount) If (list Is Nothing) Then Exit Do End If Dim CurElement As AFBaseElement For Each CurElement In list Console.WriteLine("Name of Element created from this template = {0}", CurElement.Name) Next CurElement startIndex = (startIndex + pageSize) ' Advance to next page Loop While (startIndex < totalCount)
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.