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

AF SDK Reference

IAFNamedCollection(T) Interface

  • Last UpdatedNov 18, 2025
  • 5 minute read
IAFNamedCollection(T) Interface
An interface for named collections that support looking up by ID and Name.

Namespace:  OSIsoft.AF
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public interface IAFNamedCollection<T> : ICollection<T>, 
	IEnumerable<T>, IEnumerable, IList<T>
where T : 
Public Interface IAFNamedCollection(Of T As )
	Inherits ICollection(Of T), IEnumerable(Of T), IEnumerable, 
	IList(Of T)

Dim instance As IAFNamedCollection(Of T)
generic<typename T>
where T : 
public interface class IAFNamedCollection : ICollection<T>, 
	IEnumerable<T>, IEnumerable, IList<T>
type IAFNamedCollection<'T when 'T : > =  
    interface
        interface ICollection<'T>
        interface IEnumerable<'T>
        interface IEnumerable
        interface IList<'T>
    end

Type Parameters

T
IAFNamedObject

The IAFNamedCollectionT type exposes the following members.

Properties

  NameDescription
Public property
Count
Gets the number of elements contained in the ICollectionT.
(Inherited from ICollectionT.)
Public property
IsReadOnly
Gets a value indicating whether the ICollectionT is read-only.
(Inherited from ICollectionT.)
Public property
ItemInt32
Gets or sets the element at the specified index.
(Inherited from IListT.)
Public property
ItemGuid
Gets the item with the specified id.
Public property
ItemString
Returns the specified object from the collection by name.

Methods

  NameDescription
Public method
Add
Adds an item to the ICollectionT.
(Inherited from ICollectionT.)
Public method
Clear
Removes all items from the ICollectionT.
(Inherited from ICollectionT.)
Public method
Contains(T)
Determines whether the ICollectionT contains a specific value.
(Inherited from ICollectionT.)
Public method
Contains(Guid)
This method determines whether the collection contains a specific item referenced by id.
Public method
Contains(String)
This method determines whether the collection contains a specific item referenced by name.
Public method
CopyTo
Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
(Inherited from ICollectionT.)
Public method
GetEnumerator
Returns an enumerator that iterates through the collection.
(Inherited from IEnumerableT.)
Public method
IndexOf
Determines the index of a specific item in the IListT.
(Inherited from IListT.)
Public method
Insert
Inserts an item to the IListT at the specified index.
(Inherited from IListT.)
Public method
Remove(T)
Removes the first occurrence of a specific object from the ICollectionT.
(Inherited from ICollectionT.)
Public method
Remove(Guid)
Removes the item with the specified id from the collection.
Public method
Remove(String)
The Remove method removes the item from the collection by name.
Public method
RemoveAt
Removes the IListT item at the specified index.
(Inherited from IListT.)

Extension Methods

  NameDescription
Public Extension MethodCode example
ChunkedByT
This extension method breaks up search results into chunks to make it easier to page through and process IEnumerableT collections in chunks.
(Defined by AFSDKExtension.)

Remarks

This is used in the IAFAttribute and IAFNotificationContact interfaces to provide a list of child object.

Version Information

AFSDK


See Also

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