Page tree
Skip to end of metadata
Go to start of metadata

Table of Contents

Introduction

Icon

This is Part 2 of the three-part tutorial series Financial Report scenario. It is recommended that you complete Part 1 - Using Modifiers and Ordinal Syntax before starting this section.

This tutorial also assumes a basic understanding of how ExcelTemplate imports data how that affects formulas and formatting.

Following the Sample Code

Icon

In the downloadable ExcelWriter_Basic_Tutorials.zip, there is a completed template file located in CompleteFinancialReport/templates/Part2_Financial_Template.xlsx.

In this tutorial ExcelTemplate is being used to populate data in a template set up with styles and formats. This part of the tutorial uses formulas and persists Excel styles.

Setting Up the Template

The goal of this part of the tutorial is how to apply number formats and conditional formatting to ExcelTemplate files and what you can expect as ExcelTemplate imports data.

The final template will look like this:

The bottom of the worksheet has a section for the data that will be imported. Each section has a total row summing all of the values for the section. This formula will expand as ExcelTemplate imports data.

At the top is a grid that calculates the percent in change between each quarter, based on the asset, loss, and other totals. The formulas are set up as "=(Sheet2!B2-Sheet2!A2)/(Sheet2!A2)" for each cell in the grid.

Number Formats

This section will cover how to add number formatting and the expected behavior for ExcelTemplate as it imports data.

1. Select the 9 cells in the percentage grid at the top of the worksheet (C4:E6).

2. Right click and select "Format Cells..."

3. Select "Percentage" on the Number tab.

4. Click OK

5. Select cells C12:F12, C17:F17, and C22:D22.

6. In the top tool bar, under the 'Number' tab, click the "$" to apply the currency format.

So far the number formats have been applied to cells that only contain formulas, but number formats also work with cells that contain data markers.

1. Select cells C11:F11, C16:F16, C21:F21.
2. At the top bar, click the "$" to apply the currency format.

As ExcelTemplate populates the worksheet, the number format will be copied to all the new rows of data that are inserted where the data markers are.

Conditional Formatting

ExcelTemplate will preserve existing conditional formatting. If the conditional format includes a formula, that formula will also be updated as new rows are inserted into the file.

In this case, the conditional formatting will be applied to the 'percent table' and it format negative numbers to be bold and red.

1. On the "Home" tab in Excel, click on "Conditional Formatting"

2. Select "New Rule..."

3. In this tutorial the condition type is "Format only cells that contain..." The rule is "Cell value less than 0"

4. Click on "Format..." Set the text to be dark red. Set the typeface to be bold.

5. Click OK to save the rule.

Adding an ExcelWriter Reference in Visual Studio

Following the Sample Code

Icon

In the sample code, the reference to SoftArtisans.OfficeWriter.ExcelWriter.dll has already been added to the CompleteFinancialReport project.

Create a .NET project and add a reference to the ExcelWriter library.

  1. Open Visual Studio and create a .NET project.
    • The sample code uses a web application.
  2. Add a reference to SoftArtisans.OfficeWriter.ExcelWriter.dll
    • SoftArtisans.OfficeWriter.ExcelWriter.dll is located under Program Files > SoftArtisans > OfficeWriter > dotnet > bin

Writing the Code

1. Include the SoftArtisans.OfficeWriter.ExcelWriter namespace in the code behind

2.  In the method that will run the report, instantiate the ExcelTemplate object.

3. Open the template file with the ExcelTemplate.Open method.

4. Create a DataBindingProperties object. None of the binding properties will be changed for this tutorial, but DataBindingProperties is a required parameter in ExcelTemplate data binding methods.

Data Binding

Following the Sample

Icon

Similarly to part 1, we are using CSV that contain values for the data import. Please see Part 1 for more information on using the CSV files and the CSV parser.

1.Get the data for the Assets, Losses, and Other datasets
These calls are to a helper method GetCSVData that parses the CSV files and returns a DataTable with the values.

2. Use ExcelTemplate.BindData to bind the data for the Assets, Losses, and Other data sets.

3. Call ExcelTemplate.Process() to import all data into the file.

4. Call ExcelTemplate.Save() to save the final file.

The final output should look something like this: 

Final Code

Downloads

You can download the code for the Financial Report here.

Next Steps

Continue to Part 3: Combine Reports with CopySheet

  • No labels