AFCategories Class
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFDatabase object maintains the collection of all global
AFCategory collections defined on a database.
Inheritance Hierarchy
SystemObject
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFCategory
OSIsoft.AFAFNamedCollectionAFCategory
OSIsoft.AFAFCategories
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFCategory
OSIsoft.AFAFNamedCollectionAFCategory
OSIsoft.AFAFCategories
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFCategories : AFNamedCollection<AFCategory>
Public NotInheritable Class AFCategories Inherits AFNamedCollection(Of AFCategory) Dim instance As AFCategories
public ref class AFCategories sealed : public AFNamedCollection<AFCategory^>
[<SealedAttribute>] type AFCategories = class inherit AFNamedCollection<AFCategory> end
The AFCategories 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(String) |
The Add method creates a new object and adds it to the collection.
|
| Add(T) |
Adds an object to the end of the collection.
(Inherited from AFCollectionT.) |
| 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
There are separate collections of categories defined
for the following objects: AFBaseElement,
AFAttribute, AFReferenceType,
AFTable, and AFAnalysis.
Examples
// This example demonstrates how to create an element category and display its information. // It also shows how to set the category for an element template. // Get the Database PISystems myPISystems = new PISystems(); AFDatabase myDB = myPISystems.DefaultPISystem.Databases.DefaultDatabase; // Create the Category AFCategory myCategory = myDB.ElementCategories.Add("MyElementCategory"); myCategory.Description = "This is my Element Category"; // Display the Name and Description of the Category Console.WriteLine("Name of Category = {0}", myCategory.Name); Console.WriteLine("Description = {0}", myCategory.Description); // Create an Element Template AFElementTemplate myElemTemplate = myDB.ElementTemplates.Add("MyElementTemplate"); // Set the Category for an Element Template myElemTemplate.Categories.Add(myCategory);
' This example demonstrates how to create an element category and display its information. ' It also shows how to set the category for an element template. ' Get the Database Dim myPISystems As New PISystems Dim myDB As AFDatabase = myPISystems.DefaultPISystem.Databases.DefaultDatabase ' Create the Category Dim myCategory As AFCategory = myDB.ElementCategories.Add("MyElementCategory") myCategory.Description = "This is my Element Category" ' Display the Name and Description of the Category Console.WriteLine("Name of Category = {0}", myCategory.Name) Console.WriteLine("Description = {0}", myCategory.Description) ' Create an Element Template Dim myElemTemplate As AFElementTemplate = myDB.ElementTemplates.Add("MyElementTemplate") ' Set the Category for an Element Template myElemTemplate.Categories.Add(myCategory)
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.