Smpl.Excel 1.0.2

SimpleExcel

A simple and lightweight library for generating Excel files (.xlsx) from .NET objects with fluent API. Supports only two fonts (Arial and Calibri) and sizes from 6 to 16 points, because auto column width calculation requires font metrics. Columns and dynamic columns can be hidden from the Excel output using the hidden parameter.

Features

• 🚀 Fluent API: Easy-to-use fluent interface for building Excel reports
• 🧊 Frozen Header Row: Keeps the header row visible while scrolling
• 📊 Dynamic Columns: Support for dynamic column generation based on data collections
• 📏 Auto-sizing: Automatic column width calculation based on content
• 🔍 Filtering: Built-in auto-filter support on all columns
• 🎯 Broad Compatibility: Targets .NET Standard 2.0 (supports .NET Framework 4.6.1+, .NET Core 2.0+, .NET 5+)

Installation

dotnet add package SimpleExcel

Or via Package Manager Console:

Install-Package SimpleExcel

Quick Start

using SimpleExcel;
using SimpleExcel.Font;
using System.Drawing;

// Sample data
var people = new[]
{
    new { Name = "John", Surname = "Doe", Age = 30, Email = "john@example.com" },
    new { Name = "Jane", Surname = "Smith", Age = 25, Email = "jane@example.com" }
};

// Generate Excel file
var excelBytes = new WorksheetGenerator<dynamic>("People Report")
    .Column("First Name", p => p.Name)
    .Column("Last Name", p => p.Surname)
    .Column("Age", p => p.Age)
    .Column("Email", p => p.Email)
    .GenerateAsBytes(people);

// Save to file
File.WriteAllBytes("people.xlsx", excelBytes);

Advanced Usage Examples

Font and Styling Options

var generator = new WorksheetGenerator<MyClass>("Styled Report")
    .SetFont(Fonts.Calibri)           // Available: Fonts.Arial, Fonts.Calibri
    .SetFontSize(FontSize.pt10)       // Available: pt6, pt7, pt8, pt9, pt10, pt11, pt12, pt13, pt14, pt15, pt16
    .SetHeaderBackColor(Color.Navy)   // Any System.Drawing.Color
    .SetHeaderTextColors(Color.Yellow);

Hidden Columns

Columns and dynamic columns can be hidden from the Excel output using the hidden parameter:

var generator = new WorksheetGenerator<MyClass>("Report")
    .Column("Visible Name", x => x.Name)
    .Column("Internal ID", x => x.Id, hidden: true)  // Hidden from Excel output
    .Column("Email", x => x.Email);

Dynamic Columns

If you have subcollection properties that you want to represent as multiple columns in the Excel output, you can use the DynamicColumns method. When configuring subcolumns inside DynamicColumns, you can use the {nr} placeholder in the column header names to automatically number them.

Example Output Structure:

| Name | Surname | Code1 | 1. Skill    | Code2 | 2. Skill | Code3 | 3. Skill | Age | Project Title | Budget |
|------|---------|-------|-------------|-------|----------|-------|----------|-----|---------------|--------|
| John | Doe     | C#    | Programming | SQL   | Database | JS    | Frontend | 30  | Website       | 5000   |
| Jane | Smith   | Java  | Backend     |       |          |       |          | 25  | Mobile App    | 8000   |

Example Code:

using SimpleExcel;
using SimpleExcel.Font;
using System.Drawing;

// Sample data structure
public class Employee
{
    public string Name { get; set; }
    public string Surname { get; set; }
    public int Age { get; set; }
    public DateTime? StartDate { get; set; }
    public decimal? Salary { get; set; }
    
    // Collections for dynamic columns
    public ICollection<Skill> Skills { get; set; }
    public ICollection<Project> Projects { get; set; }
}

public class Skill
{
    public string Name { get; set; }
    public string Code { get; set; }
}

public class Project
{
    public string Title { get; set; }
    public decimal? Budget { get; set; }
}

// Generate Excel with dynamic columns
var employees = GetEmployeeData(); // Your data source

var excelBytes = new WorksheetGenerator<Employee>("Employee Report")
    .SetFont(Fonts.Arial)                   // Set font (default: Calibri)
    .SetFontSize(FontSize.pt14)             // Set font size (default: pt12)
    .SetHeaderBackColor(Color.BlueViolet)   // Set header background (default: DarkBlue)
    .SetHeaderTextColors(Color.Yellow)      // Set header text color (default: White)
    
    // Static columns
    .Column("Name", x => x.Name)
    .Column("Surname", x => x.Surname)
    
    // Dynamic columns from Skills collection
    .DynamicColumns(x => x.Skills, conf => conf
        .Column("Code{nr}", skill => skill.Code)      // {nr} gets replaced with 1, 2, 3...
        .Column("{nr}. Skill", skill => skill.Name))   // Creates: "1. Skill", "2. Skill", etc.
    
    // More static columns
    .Column("Age", x => x.Age)
    .Column("Salary", x => x.Salary)
    .Column("Start Date", x => x.StartDate)
    
    // Another set of dynamic columns from Projects collection
    .DynamicColumns(x => x.Projects, conf => conf
        .Column("Project Title", proj => proj.Title)
        .Column("Budget", proj => proj.Budget))
    
    .GenerateAsBytes(employees);

File.WriteAllBytes("employee_report.xlsx", excelBytes);

Requirements

• .NET Standard 2.0 or higher
• Compatible with:
  • .NET Framework 4.6.1+
  • .NET Core 2.0+
  • .NET 5, 6, 7, 8, 9+
  • Xamarin
  • Unity 2018.1+

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Repository

https://github.com/ecizevskis/simple-excel