Skip to content
Composing Excel spreadsheets based on a tree of nested components like the HTML DOM.
C# PowerShell
Branch: master
Clone or download

Latest commit

zhenyagusev Merge pull request #35 from bookfx/zh/s7
readme translation about S7BalanceSheet
Latest commit 9a71453 Jan 1, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs/img
icon
src
.gitattributes
.gitignore
COPYING
COPYING.LESSER license Oct 29, 2019
README-ru.md
README.md
pack.ps1

README.md

BookFx

nuget-img build-img tests-img quality-img

en | ru

BookFx provides an extremely effective method for creating Excel workbooks of any complexity.

Make.Book().ToBytes()

And we already have the xlsx with one empty spreadsheet!

book-empty

The more friendly version:

Make.Value("Hi, World!").ToSheet().ToBook().ToBytes()

box-a1

Composition instead of address ciphering, component approach for tackle complexity, functional style instead of VBA-like imperativeness, components prototyping with slots made of parts of beforehand prepared xlsx-files, formulas, fonts, colors, alignments, formats. About all this below.

BookFx requires .NET Standard 2.0 and depends on EPPlus which is used as a render to XLSX Office Open XML format.

Table of Contents

Installation

PM> Install-Package BookFx

Getting Started

Making

The Make class is the entry point of BookFx. It exposes methods to create books, sheets, boxes, styles and borders. The exit point is ToBytes(). The main properties of BookFx classes can be defined using overloads of Make methods:

Make.Book(Make.Sheet("First"), Make.Sheet("Second")).ToBytes()

Another way is chaining:

Make
    .Book()
    .Add(Make.Sheet().Name("First"))
    .Add(Make.Sheet().Name("Second"))
    .ToBytes()

Both examples gives the same result.

sheet-name

Boxes

Box is a building block of a spreadsheet. It can be composite and always describes a range — cell, row, column or rectangle of cells.

Here is the complete list of boxes.

Type Creating Destination
ValueBox Make.Value() Values, formulas and empty ranges.
RowBox Make.Row() From left to right box placement.
ColBox Make.Col() From top to bottom box placement.
StackBox Make.Stack() Layer by layer box placement.
ProtoBox Make.Proto() Composing from templates.

What if we put two ValueBoxes into the RowBox?

Make.Row(Make.Value("Box A1"), Make.Value("Box B1")).ToSheet().ToBook().ToBytes()

box-a1-b1

Logical. Two values have been placed in row!

Conversions

In the ValueBox have been implemented implicit convertions from all necessary value types. What does this means? This means that we don't have to repeat Make.Value every time, because the ValueBox will be created automatically.

Make.Row("Box A1", "Box B1").ToSheet().ToBook().ToBytes()

box-a1-b1

The result is the same!

Composition

Let's describe this table header.

box-header

In terms of BookFx it can be thought of as composition of elements, like this:

box-header-model

Is is easy to see the common pattern.

box-plan-fact-model

We can extract this pattern in a function:

Box PlanFact(string title) => Make.Col(title, Make.Row("Plan", "Fact"));

Essentially it is a simple component. Test it:

PlanFact("Beginning of year").ToSheet().ToBook().ToBytes()

box-plan-fact

Now let's use PlanFact as component and add the style:

Box Head() => Make
    .Row()
    .Add("Code", "Name", PlanFact("Beginning of year"), PlanFact("End of year"))
    .Style(Make.Style().Center().Middle().Bold().DefaultBorder());

Wait a second, that is another component! Let me get this straight. A component is a function. A function is a component... It looks like infinite possibilities are in our hands!

Now it is easy:

Head().AutoSpan().ToSheet().ToBook().ToBytes()

box-header

Done.

About the AutoSpan you can read in the Spanning and Merging section. The full version is in examples of use, see below.

Examples of Use

The BookFx.Usage project contains a few examples of use. Run it and get results in the src\BookFx.Usage\bin\Debug\netcoreapp2.1\Results\ folder.

S1Table.cs

This is a full version of Getting Started example. It makes a table with totals.

S2Style.cs

This demonstrates some style features of BookFx.

S3Calendar.cs

Wow! Calendar!

s-3-calendar

S5ProtoSheet.cs

This demonstrates an adding worksheets from preexisting workbooks. See also Prototyping.

S6ProtoBox.cs

This is an example of prototyping.

S7BalanceSheet.cs

This demonstrates the creation of a Balance Sheet report with headers and a variable number of columns and rows of data.

Concepts

Model Description

BookFx workbook model anything like the HTML DOM. This is a tree of nodes, which renders to a xlsx-file.

This approach opens multiple opportunities:

  • nodes can be implemented as reusable components;
  • placing of nodes can be driven by composition of nodes;
  • hierarchy of nodes is convenient to applying styles;
  • unit testing of components doesn't require to render workbook.

BookFx model is immutable, and methods of the library has no side effects, hence BookFx allows you to write pure functions.

Thus, BookFx:

  • helps to better structure a describing of workbook;
  • takes the pain out of the calculating sizes and addresses of ranges;
  • saves you the trouble of using imperative API came from the world of VBA macros;
  • opens up opportunities of the functional programming.

Layout System

Every sheet of book can contain one root box. It is placed in the upper left corner.

Composite boxes contain other boxes and are stretched to fit them:

  • boxes are placed in row from left to right inside of RowBox;
  • boxes are placed in column from top to bottom inside of ColBox;
  • boxes are placed in stack one above the other inside of StackBox.

A ValueBox cannot contains other boxes, but can be placed in several cells. More about it see in the Spanning and Merging section.

The size of a ProtoBox is always equal to the size of its prototype, and inner boxes of ProtoBox are placed using the mechanism of slots. Further in the Prototyping section.

Spanning and Merging

A ValueBox, like any other box type, can be placed in several cells. A ValueBox methods SpanRows, SpanCols and their combination Span are used to define the number of spanned cells. The cell spanning inside of ValueBox is works like rowspan and colspan HTML table attributes, but in BookFx cells inside a ValueBox is not always should be merged.

The Merge method is used to merge cells, but BookFx merges ranges of a ValueBox automatically if the box has a value or a formula. In some cases it may be require do not merge cells automatically. For that there is the Merge(false).

In addition to automatically merging, BookFx supports automatically spanning, which is activated by methods AutoSpanRows, AutoSpanCols and their combination AutoSpan. In this mode a box and its inners are stretched to sizes of their containers through the last stretchable ValueBox. A ValueBox is considered to be stretchable when its Span is not specified and its AutoSpan is not deactivated. We've used AutoSpan in the Getting Started section.

Values and Formulas

The ValueBox is intended for values and formulas. It can be created either by Make.Value or using implicit convertion from all necessary value types: string, int, decimal, DateTime, etc.

Formulas should begin with =. The ' is used for escaping. Only R1C1 reference style is supported.

Make.Value("=SUM(RC[1]:RC[3])")

Prototyping

BookFx supports using parts of other workbooks as prototypes:

Make
    .Proto(protoBook, "Prototype1")
    .Add("Slot1", "Value1")
    .Add("Slot2", Make.Row("Value2", "Value3"));

Here

  • protoBookbyte[] of a xlsx-file content;
  • "Prototype1" – name of the range in protoBook;
  • "Slot1" and "Slot2" – names of ranges in Prototype1, in which other boxes can be placed.

See the example S6ProtoBox.cs.

Also BookFx supports adding whole spreadsheets from other workbooks:

Make.Sheet("New Sheet Name", protoBook, "Prototype Sheet Name");

"Prototype Sheet Name" spreadsheet will be copied from protoBook xlsx-file and then it will be renamed to "New Sheet Name". See also other overloads of Make.Sheet.

See also the example S5ProtoSheet.cs.

API Reference

  • Make - the model elements factory
    • Make.Book - make a Book
    • Make.Sheet - make a Sheet
    • Make.Row - make a RowBox
    • Make.Col - make a ColBox
    • Make.Stack - make a StackBox
    • Make.Value - make a ValueBox
    • Make.Proto - make a ProtoBox
    • Make.Style - make a BoxStyle
    • Make.Border - make a BoxBorder
  • Book - an Excel workbook
    • Book.Add - add sheet(s)
    • Book.ToBytes - render to xlsx
  • Sheet - an Excel spreadsheet
    • Sheet.Name - define a sheet name
    • Sheet.TabColor - define a tab color
    • Sheet.SetPageView - define page view
    • Sheet.Portrait - define portrait page orientation
    • Sheet.Landscape - define landscape page orientation
    • Sheet.Margin - define page margins
    • Sheet.Fit - fit the height and the width of printout to pages
    • Sheet.FitToHeight - fit the height of printout to pages
    • Sheet.FitToWidth - fit the width of printout to pages
    • Sheet.Scale - define a scale
    • Sheet.ToBook - make a Book with one sheet
  • Box - a box of any type
    • Box.Name - define a name of the range
    • Box.AutoSpan - activate AutoSpan mode for rows and columns
    • Box.AutoSpanRows - activate AutoSpan mode for rows
    • Box.AutoSpanCols - activate AutoSpan mode for columns
    • Box.Style - define a style
    • Box.SizeRows - define heights of rows
    • Box.SizeCols - define widths of columns
    • Box.SetPrintArea - define print area by the box
    • Box.HideRows - hide rows
    • Box.HideCols - hide columns
    • Box.Freeze - freeze the box range
    • Box.FreezeRows - freeze rows of the box
    • Box.FreezeCols - freeze columns of the box
    • Box.AutoFilter - add auto filter to the lower row of the box
    • Box.ToSheet - make a Sheet with the root box
  • RowBox - a row of boxes
    • RowBox.Add - add box(es) in row
  • ColBox - a column of boxes
    • ColBox.Add - add box(es) in column
  • StackBox - a stack of boxes
    • StackBox.Add - add box(es) in stack
  • ValueBox - a box with a value, with a formula or an empty box
    • ValueBox.Span - span rows and columns
    • ValueBox.SpanRows - span rows
    • ValueBox.SpanCols - span columns
    • ValueBox.Merge - merge cells
  • ProtoBox - a prototype
    • ProtoBox.Add - add a box into a slot
  • BoxStyle - a style
    • BoxStyle.Borders - define borders
    • BoxStyle.DefaultBorder - define regular borders
    • BoxStyle.Font - define a font, its size and color
    • BoxStyle.Back - define a background color
    • BoxStyle.Color - define a font color and/or a background color
    • BoxStyle.Bold - in bold
    • BoxStyle.Italic - in italic
    • BoxStyle.Underline - underline
    • BoxStyle.Strike - strike
    • BoxStyle.Wrap - define a text wrap
    • BoxStyle.Shrink - define a text shrinking to fit
    • BoxStyle.Align - define an alignment
    • BoxStyle.Left - align to the left
    • BoxStyle.Center - align at the center horizontally
    • BoxStyle.CenterContinuous - align horizontally at the center of adjacent cells
    • BoxStyle.Right - align to the right
    • BoxStyle.Top - align to the top
    • BoxStyle.Middle - align at the middle vertically
    • BoxStyle.Bottom - align to the bottom
    • BoxStyle.Rotate - rotate the text
    • BoxStyle.Indent - define an indent
    • BoxStyle.Format - define a custom format
    • BoxStyle.DefaultFormat - define the General format
    • BoxStyle.Text - define define the @ format (Text)
    • BoxStyle.Integer - define the #,##0 format (Integer)
    • BoxStyle.Money - define the #,##0.00 format (Number with a thousands separator)
    • BoxStyle.Percent - define the 0% format (Percentage, integer)
    • BoxStyle.DateShort - define the dd.mm.yyyy format (Short date)
  • BoxBorder - a border
    • BoxBorder.Restrict - restrict a part of a box to which the border applied
    • BoxBorder.Style - define a border style
    • BoxBorder.Color - define a border color
  • EnumerableExt - IEnumerable extensions for BookFx types
    • IEnumerable<Box>.ToBook - make a Book from sheets
    • IEnumerable<Box>.ToRow - make a RowBox from other boxes
    • IEnumerable<Box>.ToCol - make a ColBox from other boxes
    • IEnumerable<Box>.ToStack - make a StackBox from other boxes
    • IEnumerable<BoxStyle>.Mix - mix styles into a new style

License

The project is licensed under the LGPL-3.0-or-later.

The copyright notice

BookFx. Composing Excel spreadsheets based on a tree of nested components like the HTML DOM.
Copyright (c) 2019 Zhenya Gusev

The license notice

This library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this library. If not, see <https://www.gnu.org/licenses/>.
You can’t perform that action at this time.