Class DataTransferColumn

Namespace

Cuemon.Data

Assembly

Cuemon.Data.dll

Represents the column meta information of a table-row in a database. This class cannot be inherited.

public sealed class DataTransferColumn

Inheritance

object

DataTransferColumn

Examples

DataTransferColumn provides column metadata such as ordinal position, name, and data type for fields retrieved from an IDataReader. This example builds a DataTable with EmployeeId, FirstName, LastName, and HireDate columns containing two sample rows, creates a data reader, and retrieves a DataTransferColumnCollection via DataTransfer.GetColumns. It iterates each column to display ordinal, name, and DataType.Name, accesses the "FirstName" column by name to get its ordinal, and calls ToString() on a column instance. Console output shows column metadata such as [0] EmployeeId (Int32) and confirms the column name string representation.

using System;
using System.Data;
using Cuemon.Data;

namespace MyApp.Data
{
    public class DataTransferColumnExample
    {
        public void Demonstrate()
        {
            // Create a DataTable as a sample data source
            var table = new DataTable("Employees");
            table.Columns.Add("EmployeeId", typeof(int));
            table.Columns.Add("FirstName", typeof(string));
            table.Columns.Add("LastName", typeof(string));
            table.Columns.Add("HireDate", typeof(System.DateTime));

            table.Rows.Add(1, "John", "Doe", new DateTime(2023, 6, 1));
            table.Rows.Add(2, "Jane", "Smith", new DateTime(2024, 1, 15));

            // Obtain a DataTransferColumnCollection from an IDataReader via DataTransfer
            using var reader = table.CreateDataReader();
            var columns = DataTransfer.GetColumns(reader);

            Console.WriteLine($"Columns ({columns.Count}):");
            foreach (DataTransferColumn column in columns)
            {
                Console.WriteLine($"  [{column.Ordinal}] {column.Name} ({column.DataType.Name})");

            // Output:
            //   [0] EmployeeId (Int32)
            //   [1] FirstName (String)
            //   [2] LastName (String)
            //   [3] HireDate (DateTime)

            // Access columns by name
            DataTransferColumn firstNameCol = columns["FirstName"];
            Console.WriteLine($"Ordinal of 'FirstName': {firstNameCol.Ordinal}"); // 1

            // ToString() returns the column name
            Console.WriteLine($"Column ToString: {firstNameCol}"); // FirstName

}}}
}

Properties

DataType

Gets the type of data stored in the column.

public Type DataType { get; }

Property Value

Type

A Type object that represents the column data type.

Name

Gets the name of the column.

public string Name { get; }

Property Value

string

The name of the column.

Ordinal

Gets the (zero-based) position of the column.

public int Ordinal { get; }

Property Value

int

The position of the column.

Methods

ToString()

Returns a string that represents this instance.

public override string ToString()

Returns

string

A string that represents this instance.