Lay.KH.ExcelExporter 1.3.0

📊 Excel Exporter 📊

📧 Email: lylay.it.kh855@gmail.com
📞 Phone: +855 10 657 986
🔗 LinkedIn: Ly Lay

Quick Access

• Overview
• Feature
• Installation
• Configuration
• Example

Overview ▲

The Excel Exporter provides extension methods for exporting collections of objects (arrays, lists, and enumerables) to Excel files.
It supports output as byte arrays, memory streams, or direct file saves, with customization via attributes and export options.

Feature ▲

Installation ▲

Using .NET CLI

dotnet add package Lay.KH.ExcelExporter

Using Package Manager Console

Install-Package Lay.KH.ExcelExporter

Configuration ▲

To use the Excel Exporter:

1. Default Worksheet Name: "Sheet1" if none specified.
2. Attributes:
   • [ExcelIgnore] → exclude property from export.
   • [ExcelColumn("CustomName")] → rename column header.
3. Export Options:
   • Bold headers
   • Freeze header rows
   • Auto-adjust column widths

Example ▲

// Employee model with attributes
public class Employee
{
    [ExcelColumn("Employee ID")]
    public int Id { get; set; }

    public string Name { get; set; }

    [ExcelIgnore] // Exclude from export
    public string InternalCode { get; set; }

    [ExcelColumn("Joining Date")]
    public DateTime HireDate { get; set; }
}

var employees = new List<Employee>
{
    new Employee { Id = 1, Name = "Alice", InternalCode = "X123", HireDate = DateTime.Now },
    new Employee { Id = 2, Name = "Bob", InternalCode = "Y456", HireDate = DateTime.Now }
};

// 1. Export to byte array
byte[] excelBytes = employees.ToExcelBytes("Employees");

// 2. Export to MemoryStream
using var stream = employees.ToExcelStream("Employees");
using var file = File.Create("employees_stream.xlsx");
stream.CopyTo(file);

// 3. Save directly to file with options
var options = new ExcelExportOptions
{
    BoldHeaders = true,
    FreezeHeaderRow = true,
    AutoFitColumns = true
};
employees.SaveAsExcel("employees_with_options.xlsx", options);

// 4. Multi-sheet export
var sheets = new Dictionary<string, IEnumerable<object>>
{
    { "Employees", employees },
    { "Departments", new List<object> { new { Id = 1, Name = "HR" }, new { Id = 2, Name = "IT" } } }
};
sheets.SaveAsExcelMultiSheet("company.xlsx");

// 5. Multi-sheet export to byte array
var multiSheetBytes = sheets.ToExcelMultiSheetBytes();
File.WriteAllBytes("company_bytes.xlsx", multiSheetBytes);

// 6. Product model with attributes
public class Product
{
    [ExcelColumn("Product Code")]
    public string Code { get; set; }

    [ExcelColumn("Product Name")]
    public string Name { get; set; }

    [ExcelIgnore] // Hide sensitive info
    public decimal CostPrice { get; set; }

    [ExcelColumn("Sale Price")]
    public decimal SalePrice { get; set; }

    [ExcelColumn("Available Stock")]
    public int Stock { get; set; }
}

var products = new List<Product>
{
    new Product { Code = "P001", Name = "Laptop", CostPrice = 500, SalePrice = 700, Stock = 20 },
    new Product { Code = "P002", Name = "Mouse", CostPrice = 10, SalePrice = 15, Stock = 100 }
};

// Export product list with custom headers applied
products.SaveAsExcel("products.xlsx", "Products");

// 7. Using IEnumerable<T> directly
IEnumerable<Employee> employeeEnumerable = employees;
employeeEnumerable.SaveAsExcel("employees_enumerable.xlsx", "Employees");
byte[] enumerableBytes = employeeEnumerable.ToExcelBytes("Employees");