AFCsvColumns Class
- Last UpdatedNov 18, 2025
- 6 minute read
- PI System
- AF SDK 2024 R2
- Developer
A collection of AFCsvColumn objects.
Inheritance Hierarchy
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFCsvColumns : Collection<AFCsvColumn>
Public NotInheritable Class AFCsvColumns Inherits Collection(Of AFCsvColumn) Dim instance As AFCsvColumns
public ref class AFCsvColumns sealed : public Collection<AFCsvColumn^>
[<SealedAttribute>] type AFCsvColumns = class inherit Collection<AFCsvColumn> end
The AFCsvColumns type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFCsvColumns | Initializes a new instance of the AFCsvColumns class |
Properties
| Name | Description | |
|---|---|---|
 | Count | Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionAFCsvColumn.) |
| ExtraTypes |
This read-only property returns a list of object types that do not have their own separate
columns, but rather share columns with other types in the collection.
|
| Headers |
This read-only property returns a list of string headers for each of the AFCsvColumn
objects in the collection.
|
| ItemInt32 | Gets or sets the element at the specified index. (Inherited from CollectionAFCsvColumn.) |
| ItemString |
Returns the specified object from the collection by name.
|
| Types |
This read-only property returns a list of object types represented by the AFCsvColumn
objects in the collection.
|
Methods
| Name | Description | |
|---|---|---|
| Add | Adds an object to the end of the CollectionT. (Inherited from CollectionAFCsvColumn.) |
| AddRange |
Add all entries of an existing AFCsvColumn list to the collection.
|
| Clear | Removes all elements from the CollectionT. (Inherited from CollectionAFCsvColumn.) |
| Contains(String) |
This method determines whether the collection contains a specific item referenced by name.
|
| Contains(T) | Determines whether an element is in the CollectionT. (Inherited from CollectionAFCsvColumn.) |
| CopyTo | Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionAFCsvColumn.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| FindCsvColumnsByIdentity |
Find the AFCsvColumn objects in the collection with the specified AFIdentity.
|
| FindCsvColumnsByType |
Find the AFCsvColumn objects in the collection with the specified object type.
|
| GetEnumerator | Returns an enumerator that iterates through the CollectionT. (Inherited from CollectionAFCsvColumn.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetRequiredCsvColumns |
Retrieve the AFCsvColumn objects from the collection that are required.
|
| 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 CollectionT. (Inherited from CollectionAFCsvColumn.) |
| Insert | Inserts an element into the CollectionT at the specified index. (Inherited from CollectionAFCsvColumn.) |
| Remove(String) |
The Remove method removes the item from the collection by name.
|
| Remove(T) | Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionAFCsvColumn.) |
| RemoveAt | Removes the element at the specified index of the CollectionT. (Inherited from CollectionAFCsvColumn.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
This collection can be used as a user-created list of AFCsvColumn objects. It is also returned from the PISystem.GetCsvColumns Overload methods as the list of required and optional columns available for CSV import/export of a given AF object type.
A list of AF object types represented by the entries in the collection can be retrieved via the Types property and a list of column headings represented by the entries in the collection can be retrieved via the Headers property. These can be used as parameters to the PISystem.ExportCsv Overload methods.