AFCsvColumn Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Class used to represent individual columns when using CSV import and export.
Inheritance Hierarchy
SystemObject
OSIsoft.AFAFCsvColumn
OSIsoft.AFAFCsvColumn
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFCsvColumn : IEquatable<AFCsvColumn>
Public NotInheritable Class AFCsvColumn Implements IEquatable(Of AFCsvColumn) Dim instance As AFCsvColumn
public ref class AFCsvColumn sealed : IEquatable<AFCsvColumn^>
[<SealedAttribute>] type AFCsvColumn = class interface IEquatable<AFCsvColumn> end
The AFCsvColumn type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| AFCsvColumn |
Initializes a new instance of a CSV column object while specifying whether it is required, the optional name prefix, the name,
the description, the parent object type using the column, and the type of the data that will be exported or imported for the
column.
|
Properties
| Name | Description | |
|---|---|---|
| DataType |
Get or set the type of the data that will be exported or imported for the column.
| |
| Description |
Get or set the description of the column.
| |
| IsRequired |
This read-only property returns a boolean flag indicating whether the column is required for CSV import or export.
| |
| Name |
This read-only property returns a string that is the name of the column, including any optional prefix specified
when the column object was initialized.
| |
| ObjType |
Get or set the type of the AF object that uses the column.
| |
| ShortName |
This read-only property returns a string that is the short name of the column, excluding any optional prefix specified
when the column object was initialized.
|
Methods
| Name | Description | |
|---|---|---|
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).) | |
| Equals(AFCsvColumn) |
Indicates whether the current object is equal to another object of the same type.
| |
| 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.
(Overrides ObjectGetHashCode.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| ToString |
Returns a String that represents the current object.
(Overrides ObjectToString.) |
Remarks
This class provides functionality for each column represented by CSV import
and export, such as the name of the column, whether it
is required, etc.