zExcelGenerator 0.1.0

📘 zExcelGenerator

A lightweight fluent API for generating Excel reports using ClosedXML.
Designed for clean, expressive, multi-sheet Excel report generation with support for simple and advanced column mappings.

📑 Table of Contents

• Features
• Installation
• Quick Start
• Usage Examples
  • Simple Columns
  • Multiple Worksheets
  • Multiple Columns
  • Two Columns Per Field
  • Async & CancellationToken
• Returning Excel from ASP.NET Core
• License

✨ Features

• 🚀 Fluent API for building Excel reports
• 📄 Multi-worksheet support
• 🔢 Simple and advanced column mappings
• 🧩 Multiple-column and paired-column expansions
• ⚙️ Works with ILogger<T>
• ⏳ Supports CancellationToken
• 🌐 Compatible with netstandard2.1

📦 Installation

dotnet add package zExcelGenerator

🚀 Quick Start

var logger = new NullLogger<ExcelGenerator>();
var generator = new ExcelGenerator(logger);

byte[] excelBytes = generator.GenerateExcel(workbook =>
{
    workbook.AddWorksheet("People", people, ws => ws
        .Column("Name", p => p.Name, 1)
        .Column("Age",  p => p.Age,  2)
        .Column("Birth Date", p => p.BirthDate, 3, "dd/MM/yyyy")
    );
});

📚 Usage Examples

Simple Columns

workbook.AddWorksheet("Products", products, ws => ws
    .Column("Id",   p => p.Id,   1)
    .Column("Name", p => p.Name, 2)
    .Column("Price", p => p.Price, 3, "#,##0.00")
);

Output

Multiple Worksheets

workbook
    .AddWorksheet("People", people, ws => ws
        .Column("Name", p => p.Name, 1)
        .Column("Age",  p => p.Age,  2))
    .AddWorksheet("Orders", orders, ws => ws
        .Column("Order #", o => o.OrderNumber, 1)
        .Column("Total",   o => o.TotalAmount, 2, "#,##0.00"));

Multiple Columns

workbook.AddWorksheet("Survey", surveyResults, ws => ws
    .Column("Name", r => r.Name, 1)
    .MultipleColumns(
        description:  "Score",
        selector:     r => r.Scores.Cast<object>(),
        totalColumns: 3,
        order: 2,
        headerSuffix: new[] { "Q1", "Q2", "Q3" },
        format: "0")
);

Output Example

Two Columns Per Field

workbook.AddWorksheet("Monthly", monthlyData, ws => ws
    .TwoColumnsPerField(
        firstDescription:  "Planned",
        secondDescription: "Actual",
        firstSelector:     d => d.Planned.Cast<object>(),
        secondSelector:    d => d.Actual.Cast<object>(),
        totalColumns:      12,
        order: 1,
        firstHeaderSuffix:  new[] { "Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec" },
        secondHeaderSuffix: new[] { "Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec" },
        firstFormat:  "#,##0.00",
        secondFormat: "#,##0.00")
);

Async & CancellationToken

var cts = new CancellationTokenSource(TimeSpan.FromSeconds(2));

byte[] excelBytes = await generator.GenerateExcelAsync(workbook =>
{
    workbook.AddWorksheet("People", people, ws => ws
        .Column("Name", p => p.Name, 1)
        .Column("Age",  p => p.Age,  2)
    );
}, cts.Token);

Returning Excel from ASP.NET Core

return File(
    excelBytes,
    "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
    "report.xlsx"
);

License

This project is licensed under the MIT License.
See the LICENSE file for details.