SpreadsheetUtility 1.2.0

SpreadsheetUtility

Ultra lightweight spreadsheet utility to display processed collections of data and occasionally reading it

Features

• Uses XLSX file format
• Writes public properties of a collection into a dedicated sheet
• Reads sheet data into an enumerator(List)
• Supports multiple sheets
• Auto fits columns for comfortable viewing
• Can set startup sheet
• Supports type independent sheet names
• Supports custom string formatting
• Supports color scale formatting
• Supports horizontal and vertical data layout

Tutorial

Let's create an employee class to store in a spreadsheet.

class Employee
{
    public string? Name { get; set; }
    public string? Position { get; set; }

    [Format("0$")]
    [ColorScale("red", "#00FF00" /* green */)]
    public decimal Salary { get; set; }

    public Employee() { }

    public Employee(string name, string position, decimal salary)
    {
        Name = name;
        Position = position;
        Salary = salary;
    }
}

Now we can make an array of company's employees.

var employees = new[]
{
    new Employee("John", "CEO", 10000),
    new Employee("Steve", "Manager", 6000),
    new Employee("Will", "Senior Software Engineer", 4000),
    new Employee("Kate", "Software Engineer", 2000),
    new Employee("Paul", "Quality Assurance", 1000)
};

This array can now go into the spreadsheet.

using (var spreadsheet = new Spreadsheet("Company.xlsx"))
{
    spreadsheet.Write(employees);
}

Here is how this data looks in the spreadsheet.

<img src="https://github.com/Planktomas/SpreadsheetUtility/assets/94010480/155379da-b753-4069-a057-4022192345e5.png" width="350" height="220" />

And if we need to read some of that data back, we can do it too.

using (var spreadsheet = new Spreadsheet("Company.xlsx"))
{
    foreach (var employee in spreadsheet.Read<Employee>())
    {
        Console.WriteLine($"Salary: {employee.Salary} \t Position: {employee.Position}");
    }
}

<img src="https://github.com/Planktomas/SpreadsheetUtility/assets/94010480/5354153c-b40e-436d-9619-9652f3082cc0.png" width="520" height="160" />

You can review the whole tutorial here

Additional features

By default all sheets will have a horizontal data layout but we can change it to vertical using Layout attribute.

[Layout(Flow.Vertical)]
class Employee
{
    public string? Name { get; set; }
    public string? Position { get; set; }

    [Format("0$")]
    [ColorScale("red", "#00FF00" /* green */)]
    public decimal Salary { get; set; }

    public Employee() { }

    public Employee(string name, string position, decimal salary)
    {
        Name = name;
        Position = position;
        Salary = salary;
    }
}

Here is how it looks in the spreadsheet.

<img src="https://github.com/Planktomas/SpreadsheetUtility/assets/94010480/7aff29ad-88f5-413e-8be6-bb6d73773327.png" width="700" height="160" />