ReaderExcel 1.1.0

ReaderExcel Utility

ReaderExcel is a simple utility library designed to read Excel files and parse their content into structured data, making it easy to work with tabular data programmatically.

Features

• Reads .xlsx files using ClosedXML.
• Parses rows and columns into a list of key-value pairs.
• Skips header rows for clean data extraction.
• Returns HTTP status codes for easy error handling.

Installation

To install the package via NuGet, run the following command in the Package Manager Console:

Install-Package ReaderExcel

Usage

Here is an example of how to use the ReaderExcel method to read an Excel file:

using System;
using System.Collections.Generic;
using System.Net;

class Program
{
    static void Main(string[] args)
    {
        string filePath = @"path/to/your/excel/file.xlsx";

        var result = ReadingFile(filePath);

        if (result.response == HttpStatusCode.OK)
        {
            Console.WriteLine("File read successfully!");

            foreach (var row in result.table)
            {
                foreach (var pair in row)
                {
                    Console.WriteLine($"{pair.Key}: {pair.Value}");
                }
                Console.WriteLine();
            }
        }
        else
        {
            Console.WriteLine("Failed to read file.");
        }
    }

    public static (List<List<KeyValuePair<string, string>>>? table, HttpStatusCode response) ReadingFile(string filePath)
    {
        try
        {
            using (var workbook = new XLWorkbook(filePath))
            {
                var worksheet = workbook.Worksheet(1);
                var range = worksheet.RangeUsed();
                int rows = range.RowCount();
                int cols = range.ColumnCount();

                List<List<KeyValuePair<string, string>>> table = new();

                for (int row = 2; row <= rows; row++)
                {
                    var values = new List<KeyValuePair<string, string>>();
                    for (int col = 1; col <= cols; col++)
                    {
                        var column = range.Cell(1, col).Value.ToString();
                        var rowValue = range.Cell(row, col).Value.ToString();
                        KeyValuePair<string, string> valuePair = new(column, rowValue);
                        values.Add(valuePair);
                    }
                    table.Add(values);
                }
                return (table, HttpStatusCode.OK);
            }
        }
        catch (Exception e)
        {
            return (null, HttpStatusCode.BadRequest);
        }
    }
}

Returns

The ReaderExcel method returns a tuple with the following elements:

• table: A list of lists of key-value pairs, where each row represents a record, and each key-value pair represents a column name and its value.
• response: An HttpStatusCode indicating the status of the operation (e.g., OK for success, BadRequest for errors).

Requirements

• .NET 6.0 or higher.
• ClosedXML library.

Author

• @GabrielBrl

Licence

MIT