AFSearchTokenCollection Class
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
A collection of AFSearchTokenBase objects that will be used in an AFSearch.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.SearchAFSearchTokenCollection
OSIsoft.AF.SearchAFSearchTokenCollection
Namespace: OSIsoft.AF.Search
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public sealed class AFSearchTokenCollection : IList<AFSearchTokenBase>, ICollection<AFSearchTokenBase>, IEnumerable<AFSearchTokenBase>, IEnumerable
<SerializableAttribute> Public NotInheritable Class AFSearchTokenCollection Implements IList(Of AFSearchTokenBase), ICollection(Of AFSearchTokenBase), IEnumerable(Of AFSearchTokenBase), IEnumerable Dim instance As AFSearchTokenCollection
[SerializableAttribute] public ref class AFSearchTokenCollection sealed : IList<AFSearchTokenBase^>, ICollection<AFSearchTokenBase^>, IEnumerable<AFSearchTokenBase^>, IEnumerable
[<SealedAttribute>] [<SerializableAttribute>] type AFSearchTokenCollection = class interface IList<AFSearchTokenBase> interface ICollection<AFSearchTokenBase> interface IEnumerable<AFSearchTokenBase> interface IEnumerable end
The AFSearchTokenCollection type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Count | Gets the number of elements contained in the ListT. |
| IsReadOnly | Gets a value indicating whether the IList is read-only. |
| Item | Gets or sets the element at the specified index. |
Methods
| Name | Description | |
|---|---|---|
 | Add | Adds an object to the end of the ListT. |
| Clear | Removes all elements from the ListT. |
| Contains | Determines whether an element is in the ListT. |
| CopyTo | Copies the entire ListT to a compatible one-dimensional array, starting at the specified index of the target array. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetEnumerator | Returns an enumerator that iterates through the ListT. |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| 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 ListT. |
| Insert | Inserts an element into the ListT at the specified index. |
| Remove | Removes the first occurrence of a specific object from the ListT. |
| RemoveAt | Removes the element at the specified index of the ListT. |
| ToString |
Returns a String that represents the current object.
(Overrides ObjectToString.) |
| TryFindSearchToken |
Find the AFSearchTokenBase associated with the specified AFSearchFilter.
|
| TryFindSearchTokens |
Find the AFSearchTokenBase list associated with the specified AFSearchFilter.
|
Extension Methods
| Name | Description | |
|---|---|---|
  | ChunkedByAFSearchTokenBase |
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 class represents a collection of AFSearchTokenBase objects that will be used in an AFSearch. This class cannot be instantiated.