SoftCircuits.SpreadsheetBuilder 1.0.4

Spreadsheet Builder

Install-Package SoftCircuits.SpreadsheetBuilder

Overview

SpreadsheetBuilder is a lightweight class that makes it easy to create Microsoft Excel spreadsheet (XLSX) files without Excel.

The library forgoes some features in order to keep things simple. But should be sufficient for most requirements for building an Excel spreadsheet.

The following example creates a new Excel spreadsheet file, sets a value at cell A1, and then saves the file.

using SpreadsheetBuilder builder = SpreadsheetBuilder.Create(Filename);
builder.SetCell("A1", "Hello, World!");
builder.Save();

Getting Started

To get started, create an instance of the SpreadsheetBuilder class. You can do that using any of the following static methods of the SpreadsheetBuilder class.

public static SpreadsheetBuilder Create(string path, SpreadsheetDocumentType type = SpreadsheetDocumentType.Workbook);

public static SpreadsheetBuilder CreateFromTemplate(string path);

public static SpreadsheetBuilder Open(string path, bool isEditable);

The SpreadsheetBuilder class implements IDisposable, so you should use a using statement to ensure the class cleans up in a timely manner.

using SpreadsheetBuilder builder = SpreadsheetBuilder.Create(Filename);

Once you've constructed the document, you can save it to disk by calling the Save() or SaveAs() method.

Setting Cell Values

To set the value of a cell, use the SetCell() method.

builder.SetCell("A1", "Hello, World!");

This method has dozens of overloads. You can pass a string, as shown in the example above, or you can pass other data types such as integers, doubles and decimals.

builder.SetCell("B5", 123.45);

The first argument specifies the cell address. You can pass the address as a string, as shown above, or you can pass an instance of the CellReference class. When you pass a string, the syntax is more compact but the library must convert the address to a CellReference. So some performance gains might be possible by passing a CellReference directly.

builder.SetCell(new CellReference(2, 5), 123.45);

To create a calculated cell, you can pass an instance of the CellFormula class.

builder.SetCell("C17", new CellFormula("SUM(A1:C16)");

Formatting Cells

One of the more onerous tasks of building spreadsheets is creating and tracking cell formats.

Spreadsheet builder simplifies things somewhat by defining a number of predefined cell formats via the CellStyles property. Overloads of SetCell() accept a style ID parameter.

builder.SetCell("A7", 123.45, builder.CellStyles[StandardCellStyle.Currency]);

Note: If you pass a decimal type to SetCell(), the library automatically uses the currency style when no style ID is specified.

If you need something other than one of the default cell formats, you can create your own as shown in the following example.

uint bold = builder.CellStyles.Register(new CellFormat()
{
    FontId = builder.FontStyles[StandardFontStyle.Bold],
    ApplyFont = BooleanValue.FromBoolean(true),
});

uint header = builder.CellStyles.Register(new CellFormat()
{
    FontId = builder.FontStyles[StandardFontStyle.Header],
    ApplyFont = BooleanValue.FromBoolean(true)
});

uint subheader = builder.CellStyles.Register(new CellFormat()
{
    FontId = builder.FontStyles[StandardFontStyle.Subheader],
    ApplyFont = BooleanValue.FromBoolean(true)
});

uint headerRight = builder.CellStyles.Register(new CellFormat()
{
    FontId = builder.FontStyles[StandardFontStyle.Header],
    ApplyFont = BooleanValue.FromBoolean(true),
    Alignment = new() { Horizontal = HorizontalAlignmentValues.Right },
    ApplyAlignment = BooleanValue.FromBoolean(true)
});

uint subheaderRight = builder.CellStyles.Register(new CellFormat()
{
    FontId = builder.FontStyles[StandardFontStyle.Subheader],
    ApplyFont = BooleanValue.FromBoolean(true),
    Alignment = new() { Horizontal = HorizontalAlignmentValues.Right },
    ApplyAlignment = BooleanValue.FromBoolean(true)
});

builder.SetCell("D22", "Header", header);

In addition to the CellStyles property, the SpreadsheetBuilder class also has NumberFormats, FontStyles, FillStyles and BorderStyles properties that provide standard styles and the ability to add new ones similar to the CellStyles property.

Note: When you register a style, it is stored within the current instance of SpreadsheetBuilder. Care should be taken to ensure you don't create the same style more than once for the same instance of SpreadsheetBuilder.

Tables

You can create tabular data by setting the value of the appropriate cells, or you can use the TableBuilder class.

The TableBuilder class simplifies the process of creating tabular data, offers some performance gains, and can also be used to create and format a named Excel table.

The TableBuilder constructor takes an instance of the SpreadsheetBuilder class, a cell reference to the cell at the top, left corner of the table, and either of:

• The number of columns
• An IEnumerable<string> of the column headers

If you specify the number of columns, it is assumed the table has no headers.

To write data to the table, call the AddRow() method. This method accepts any number of arguments, each of which is assigned to the corresponding cell on the current table row. The type of the arguments can be string, int, double, etc. They can also be an instance of CellValue<T>, which can specify a style ID in addition to a value. In addition, they can also be an instance of CellFormula.

string[] headers = new string[]
{
  "Column1",
  "Column2",
  "Column3"
};

TableBuilder table = new(builder, "A4", headers);
table.AddRow("Abc", 123, 123.45m);
table.AddRow("Def", 456, 4000m);

The TableBuilder class has many properties for returning things like the range of the table built so far.

Once you've finished building the tabular data, you can create an Excel table and style it.

table.BuildTable("MyTableName", ExcelTableStyle.MediumBlue6);

Column Widths

Use the following method to set the width of a column.

public void SetColumnWidth(uint index, double width);

index is the 1-based index of the column to set. width is the new column width measured as the number of characters of the maximum digit width of the numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.

Use the following method to set the width of a range of columns.

public void SetColumnWidth(uint startIndex, uint endIndex, double width)

Worksheets

When creating a new spreadsheet document, the library automatically creates a worksheet called Sheet1.

The Worksheet property is set to the active worksheet, if any. Set this property to change the active worksheet.

In addition, the following methods are provided.

public Worksheet? GetFirstWorksheet()

This method returns the first worksheet, or null if there are no worksheets.

public Worksheet? GetWorksheet(string name)

This method returns the worksheet with the specified name.

public Worksheet CreateWorksheet(string name)

Creates a new worksheet and gives it the specified name.

public void RenameWorksheet(Worksheet worksheet, string name)

Renames the given worksheet with the specified name.