Fork: 0
knarita / ClosedXML
Transfer to URL with SHA Find file
Newer
Older
ClosedXML / README.md
@Francois Botha Francois Botha on 7 Aug 2018 3 KB Update release badget version
Raw Blame History

ClosedXML

Release NuGet Badge .NET Framework .NET Standard Build status Open Source Helpers

💾 Download unstable CI build

ClosedXML is a .NET library for reading, manipulating and writing Excel 2007+ (.xlsx, .xlsm) files. It aims to provide an intuitive and user-friendly interface to dealing with the underlying OpenXML API.

For more information see the wiki

Install ClosedXML via NuGet

If you want to include ClosedXML in your project, you can install it directly from NuGet

To install ClosedXML, run the following command in the Package Manager Console

PM> Install-Package ClosedXML

What can you do with this?

ClosedXML allows you to create Excel 2007+ (.xlsx, .xlsm, etc) files without the Excel application. The typical example is creating Excel reports on a web server.

If you've ever used the Microsoft Open XML Format SDK you know just how much code you have to write to get the same results as the following 4 lines of code.

var workbook = new XLWorkbook();
var worksheet = workbook.Worksheets.Add("Sample Sheet");
worksheet.Cell("A1").Value = "Hello World!";
workbook.SaveAs("HelloWorld.xlsx");

Extensions

Be sure to check out our ClosedXML extension projects

Developer guidelines

Full guidelines to follow later

  • Please submit pull requests that are based on the develop branch. sample work Your pull request will take "yourWork" branch in your repo and merge into our develop branch.
  • Where possible, pull requests should include unit tests that cover as many uses cases as possible. This is especially relevant when implementing Excel functions.
  • Install NUnit 3.0 Test Adapter if you want to run the test suite in Visual Studio.
  • We use 4 spaces for code indentation. This is the default in Visual Studio. Don't leave any trailing white space at the end of lines or files. To make this easier, ClosedXML has an editorconfig configuration file. It is recommended you install editorconfig from the Visual Studio Extension Manager.

Credits