CommonNetFuncs.Excel.OpenXml 4.1.5

CommonNetFuncs.Excel.OpenXml

This project contains helper methods for reading and writing Excel files using the OpenXML SDK in .NET applications.

Contents

• CommonNetFuncs.Excel.OpenXml
  • Contents
  • Common
    • Common Usage Examples
      • InitializeExcelFile / CreateNewSheet
  • Export
    • Export Usage Examples
      • GenericExcelExport
  • Installation
  • License

Common

Low-level helpers for building and manipulating SpreadsheetDocument objects with the OpenXML SDK. Covers creating workbooks and sheets, reading and writing cell values, managing number formats, inserting images, applying cell styles, and finalizing documents.

Common Usage Examples

<details> <summary><h3>Usage Examples</h3></summary>

InitializeExcelFile / CreateNewSheet

using DocumentFormat.OpenXml.Packaging;
using CommonNetFuncs.Excel.OpenXml;

using MemoryStream ms = new();
using SpreadsheetDocument document = SpreadsheetDocument.Create(ms, SpreadsheetDocumentType.Workbook, true);

uint sheetId = document.InitializeExcelFile("Sheet1"); // creates the workbook and first sheet
uint sheet2Id = document.CreateNewSheet("Sheet2");     // appends a second sheet

Worksheet? ws = document.GetWorksheetById(sheetId);

WriteAndClose / WriteAndCloseAsync

WriteAndClose saves the workbook, disposes the document, and resets the stream position to 0 so the stream is ready to be read or returned immediately.

Use the single-Stream overload when the document was created in-memory:

using DocumentFormat.OpenXml.Packaging;
using CommonNetFuncs.Excel.OpenXml;

using MemoryStream ms = new();
SpreadsheetDocument document = SpreadsheetDocument.Create(ms, SpreadsheetDocumentType.Workbook);
document.InitializeExcelFile("Sheet1");
// ... write data ...

document.WriteAndClose(ms); // saves, disposes, resets ms.Position to 0
// ms is now ready to read / return as a file download

Use the filePath overload (or its async counterpart) when the document was created against a file path and you want to return the result as a MemoryStream:

using DocumentFormat.OpenXml.Packaging;
using CommonNetFuncs.Excel.OpenXml;

string path = Path.GetTempFileName();
MemoryStream ms = new();
SpreadsheetDocument document = SpreadsheetDocument.Create(path, SpreadsheetDocumentType.Workbook);
document.InitializeExcelFile("Sheet1");
// ... write data ...

// sync
document.WriteAndClose(ms, path);

// async
await document.WriteAndCloseAsync(ms, path);

// ms.Position == 0 and contains the full .xlsx content
return File(ms, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "output.xlsx");

</details>

Export

Provides a GenericExcelExport extension method that converts any IEnumerable<T> into a .xlsx MemoryStream using the OpenXML SDK directly. Supports optional table formatting, custom sheet and table names, and column exclusion.

Export Usage Examples

<details> <summary><h3>Usage Examples</h3></summary>

GenericExcelExport

using CommonNetFuncs.Excel.OpenXml;

List<MyRecord> data = GetData();

// Basic export
MemoryStream? stream = data.GenericExcelExport();

// Export as a formatted Excel table, skipping a column
MemoryStream? stream = data.GenericExcelExport(
    createTable: true,
    sheetName: "Report",
    tableName: "ReportTable",
    skipColumnNames: ["InternalId"]
);

// Return as a file download from an ASP.NET Core endpoint
return File(stream, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "report.xlsx");

</details>

Installation

Install via NuGet:

dotnet add package CommonNetFuncs.Excel.OpenXml

License

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