ExcelReport是一款基于NPOI开发的报表引擎组件。它基于关注点分离的理念,将数据与样式、格式分离。让模板承载样式、格式等NPOI不怎么擅长且实现繁琐的信息,结合NPOI对数据的处理的优点将Excel报表的生成化繁为简。同时,对报表组成的基本元素进行了抽象,进一步简化了Excel报表的生成过程。

官方站点

NuGet:https://www.nuget.org/packages/ExcelReport

GitHub:https://github.com/hanzhaoxin/ExcelReport

cnblogs:http://www.cnblogs.com/hanzhaoxin/tag/ExcelReport /

QQ Group:116476496 

团队介绍

Jensen

来自于中国深圳,是这个项目的发起人和开发人员,2014年11月开始了ExcelReport的开发,负责ExcelReport的开发、测试和bug修复。

个人博客地址:http:// hanzhaoxin.cnblogs.com

许可证说明

ExcelReport采用的是MIT许可,这意味着它可以被用于任何商业或非商业项目,你不用担心因为使用它而必须开放你自己的源代码,且可借助ExcelReport的影响力推广你的产品。

当然作为一个开源许可证,肯定也是有一些义务。例如:在软件和软件的所有副本中都必须包含以上版权声明和本许可声明。

完整的MIT许可证请见:http://mit-license.org/

版本升级说明:

如果您项目中使用了ExcelReport,Bug修复和功能扩充的升级版本请放心升级,这类升级不能影响您现有的项目。如果架构修改版本信息发生了变化,请谨慎升级,这类升级有可能影响您现有的项目。

为什么要用ExcelReport?

回答这个问题前,我们先看看Tony Qu是怎么回答为什么要用NPOI的?

1)你不需要在服务器上安装微软的 Office,可以避免版权问题。

2)NPOI使用起来比 Office PIA 的 API 更加方便,更人性化。

3)你不用去花大力气维护 NPOI,NPOI Team 会不断更新、改善 NPOI,绝对省成本。

4)很多事情是 html 和cvs法做不到的,比如说公式计算[Cell C1]=A1+B1*A2单元格

高级样式(如文本旋转、对齐、宽度)等,其中公式计算可以适当减轻服务器端的计算压力

回到我们的问题,为什么要用ExcelReport呢?

1) 复杂的事情简单了,不可能的事情可行了。

2) 你不需要了解NPOI大量的API,你不需要用.NET语言写蹩脚的Java的语法。

3) 套用Tony兄的描述,你不用去花大力气维护ExcelReport,ExcelReport Team会不断更新、改善ExcelReport,绝对省成本。

目录

1报表元素与元素格式化器

2演示:使用ExcelReport生成报表

3格式化器示例

3.1局部格式化器

3.2单元格格式化器

3.3表格格式化器

3.4重复单元格式化器

4多Sheet报表生成

1报表元素与元素格式化器

在开始示例之前,我们用一章的篇幅介绍ExcelReport是如何将报表的内容抽象为元素的?

又是如何为元素填充数据的?为了说明第一个问题,我们从一个现有的报表开始。

如下报表有两个Sheet:Sheet1名为“工资表”Sheet2名为“工资条”,其截图如下所示。

我们先把数据部用蓝色框线标出来。

名正才能言顺,先说说ExcelReport中报表元素的概念:

  • 元素:填充到报表模板中的数据源对象,我们称之为元素。

  • 局部元素:填充到报表模板中的数据源对象是一个单元格内容的一部分,我们称这样的数据源对象为局部元素。

  • 单元格元素:填充到报表模板中的数据源对象是一个单元格的内容,我们称这样的数据源对象为单元格元素。

  • 表格元素:填充到报表模板中的数据源是某对象的集合,该对象是一行中多个单元格的内容集合,我们称这样的数据源集合为表格元素。

  • 重复单元元素:填充到报表模板中的数据源是某对象的集合,该对象是多行中多个单元格的内容集合,我们称这样的数据源集合为重复单元元素。

    【表格元素与重复单元元素数据源以集合出现。为复元素。】

    【对应的,局部元素和单元格元素称之为单元素。】

    有了定义,我们让元素们各就各位。

    那么,ExcelReport又是如何为元素填充数据的?

    话说元素格式化器为此而生。

    报表元素

    元素格式化器

    局部元素

    PartFormatter

    单元格元素

    CellFormatter

    表格元素

    TableFormatter

    重复单元元素

    RepeaterFormatter

    【元素格式化器的作用是格式化元素将其填充到报表模板。】

    2演示:使用ExcelReport生成报表

    目标报表,生成上章分析的”工资表-工资条”报表。

    第一步:设计模板

    【模板中参数格式:$[ParameterName]】

    第二步:由模板生成模板填充规则文件

    1) 打开模板填充规则文件生成工具

    2) 将设计好的模板拖入Excel模板文件选择框

    3) 点击“生成模板规则文件(.XML)”按钮,生成规则文件。

    第三步:填充模板,生成报表【项目中要添加对ExcelReport及NPOI(2.0以上)的引用】

    生成导出报表:

    【注:演示示例“生成工资表-工资条报表”源码见解决方案:ExcelReportExamples】

    3格式化器示例

    通过上一章的示例,我们了解了ExcelReport生成报表的步骤,也用到了各种格式化器。在本章,我们将对格式化器逐一展开讲解,以更详细的了解它们。

    3.1局部格式化器

    局部格式化器用于格式化填充一个单元格内容的一部分。填充数据类型为string。

    构成函数:


    参数

    描述

    cellPoint

    参数所在单元格位置

    parameterName

    参数名

    value

    要格式化填充的值

    示例:(局部格式化器示例)

    第一步:设计模板

    第二步:由模板生成模板填充规则文件

    第三步:填充模板,生成报表

    生成导出报表:

    3.2单元格格式化器

    单元格格式化器用于格式化填充一个单元格。填充数据类型为object,详见下表:

    填充数据类型

    Excel中对应的数据类型

    可视化设置项

    String

    String

     

    DateTime

    DateTime

    Boolean

    Boolean

     

    Int16

    Int32

    Int64

    Byte

    Single

    Double

    UInt16

    UInt32

    UInt64

    Double

    Byte[]

    Image

     

    构成函数:


    参数

    描述

    cellPoint

    参数所在单元格位置

    value

    要格式化填充的值

    示例:(单元格格式化器示例)

    第一步:设计模板

    第二步:由模板生成模板填充规则文件(略,详参见第2章“演示”)

    第三步:填充模板,生成报表

    生成导出报表:

    3.3表格格式化器

    表格格式化器用于格式化填充一个表格。填充数据类型为IEnumerable<TSource>。

    构造函数:


    参数

    描述

    templateRowIndex

    模板行行标

    dataSource

    要格式化填充的数据

    columnInfos

    列信息集合

    TableColumnInfo构造函数:


    参数

    描述

    columnIndex

    列标

    dgSetValue

    Func<TSource, object>类型的委托对象(返回值Object,可参照第二节填充数据类型与Excel中数据类型对应表。)

    示例:(表格格式化器示例)

    第一步:设计模板

    第二步:由模板生成模板填充规则文件(略,详参见第2章“演示”)

    第三步:填充模板,生成报表

    生成导出报表:


    提问回复:【关于TableFormatter有以下知识点,多次被提问,这里做出统一回答。】

    问题一:TableFormatter的数据源可以是DataTable吗?

    答:你可以这样写:

    问题二:我的实体类中没有实现外链,在实体对象中有一个ID属性,我想导出的内容是ID对应的Name,这怎么办?

    答:和示例中的“性别”没什么区别吧。好吧,贴行代码:

    3.4重复单元格式化器

    重复单元格式化器用于格式化填充一个重复单元元素。填充数据类型为IEnumerable<TSource>。

    构造函数:


    参数

    描述

    startTagCell

    重复单元(开始)标识单元格

    endTagCell

    重复单元(结束)标识单元格

    dataSource

    要格式化填充的数据

    cellInfos

    重复单元包含的单元格信息集合

    RepeaterCellInfo构造函数:


    参数

    描述

    cellPoint

    单元格坐标

    dgSetValue

    Func<TSource, object>类型的委托对象(返回值Object,可参照第二节填充数据类型与Excel中数据类型对应表。)

    示例:(重复单元格式化器示例)

    第一步:设计模板

    根据需求,隐藏重复单元标识行。

    第二步:由模板生成模板填充规则文件(略,详参见第2章“演示”)

    第三步:填充模板,生成报表

    生成导出报表:

    4多Sheet报表生成

    到目前为止,我们所有导出都直接使用的是:ExportHelper类中的静态方法。其实在ExcelReport组件的设计中Export类便是终点了,ExportHelper类正如它的名字只是为了方便操作提供的助手类而已。

    【哦,它还是部分类,你可以根据需求扩展。】

    回到本章的主题,我们要谈的是多Sheet报表的生成。什么?这和前边啰嗦的那些有什么关系?好吧,其实关系也不大,我只是想说关注报表的生成,你看Export类就对了。


    参数

    描述

    templateFile

    模板文件路径

    containers

    Sheet格式化容器的数组【数组中的每个元素对应一个Sheet】

    示例:(多Sheet报表生成示例)

    第一步:设计模板

    第二步:由模板生成模板填充规则文件(略,详参见第2章“演示”)

    第三步:填充模板,生成报表

    生成导出报表:

  • 开源组件ExcelReport 1.5.2 使用手册的更多相关文章

    1. 开源组件ExcelReport 3.x.x 使用手册(为.netcore而来)

      ExcelReport转眼已经开源4年了,期间有很长时间也停止了对它的维护.18年年末有人联系到我,说“兄弟,ExcelReport不错,但什么时候支持.netcore呢?”.我寥寥的回了几句搪塞的话 ...

    2. .net 开源组件

      文章转自:http://www.cnblogs.com/asxinyu/p/dotnet_opensource_project_3.html   在前2篇文章这些.NET开源项目你知道吗?让.NET开 ...

    3. react native 的图表开源组件react-native-chart-android

      react-native-chart-android是一个图表开源组件,使用方法可以去这里 由于需要在数据上加上触摸事件,而github上没有说明看源码找了半天才找到下面的解决方法,特此记录一下: 在 ...

    4. 分享几个.NET WinForm开源组件,纪念逐渐远去的WinForm。。。

      前面3个月的时间内,这些.NET开源项目你知道吗?系列文章已经发表了3篇,共计45个平时接触比较少,曾经默默无闻的.NET开源项目,展示给大家,当然不是每个人都能用得上,但也的确是有些人用了,反响还不 ...

    5. .Net Office开源组件

      1.NPOI NPOI 是 POI 项目的 .NET 版本.POI是一个开源的Java读写Excel.WORD等微软OLE2组件文档的项目.使用 NPOI 你就可以在没有安装 Office 或者相应环 ...

    6. 【2015上半年总结】js开源组件开发系列索引

      js开源组件开发系列一索引 2015.8 by 田想兵 个人网站 从3月份进入新公司以来,时经五个月,我以平均每周1个小组件的速度,已经完成的js组件有22个之余了,已基本上全部用到实际项目中,这些小 ...

    7. [js开源组件开发]network异步请求ajax的扩展

      network异步请求ajax的扩展 在日常的应用中,你可能直接调用$.ajax是会有些问题的,比如说用户的重复点击,比如说我只希望它成功提交一次后就不能再提交,比如说我希望有个正在提交的loadin ...

    8. [js开源组件开发]数字或金额千分位格式化组件

      数字或金额千分位格式化组件 这次距离上一个组件<[js开源组件开发]table表格组件>时隔了一个月,由于最近的项目比较坑,刚挖完坑,所以来总结性提出来几个组件弥补这次的空缺,首先是金额和 ...

    9. [js开源组件开发]query组件,获取url参数和form表单json格式

      query组件,获取url参数和form表单json格式 距离上次的组件[js开源组件开发]ajax分页组件一转眼过去了近二十天,或许我一周一组件的承诺有了质疑声,但其实我一直在做,只是没人看到……, ...

    随机推荐

    1. 重温Http协议--请求报文和响应报文

      http协议是位于应用层的协议,我们在日常浏览网页比如在导航网站请求百度首页的时候,会先通过http协议把请求做一个类似于编码的工作,发送给百度的服务器,然后在百度服务器响应请求时把相应的内容再通过h ...

    2. 【原】AFNetworking源码阅读(六)

      [原]AFNetworking源码阅读(六) 本文转载请注明出处 —— polobymulberry-博客园 1. 前言 这一篇的想讲的,一个就是分析一下AFSecurityPolicy文件,看看AF ...

    3. gulp详细入门教程

      本文链接:http://www.ydcss.com/archives/18 gulp详细入门教程 简介: gulp是前端开发过程中对代码进行构建的工具,是自动化项目的构建利器:她不仅能对网站资源进行优 ...

    4. c# 字符串连接使用“+”和string.format格式化两种方式

      参考文章:http://www.liangshunet.com/ca/201303/218815742.htm 字符串之间的连接常用的两种是:“+”连接.string.format格式化连接.Stri ...

    5. background例子

    6. TCP/IP基础

      TCP/IP 是用于因特网 (Internet) 的通信协议. 计算机通信协议是对那些计算机必须遵守以便彼此通信的规则的描述. 什么是 TCP/IP? TCP/IP 是供已连接因特网的计算机进行通信的 ...

    7. iOS 后台处理

      iOS 后台处理的常见用途 1.进入后台时候删除资源:应用处于挂起状态的时候所占用的资源越少,该应用被iOS终止的风险就越低.通过从内存中清理那些易于重新创建的资源,可以增加应用驻留内存的机会,因此可 ...

    8. eclipse — 导入android项目后识别成java项目的问题及解决

      最近在eclipse导入android项目的时候遇到了奇葩问题,再此记录 遇到的问题就是:将完好的android项目导入到eclipse的时候,原本这是一个很容易的事情,但是导入成功后发现,,,靠ec ...

    9. 跟着老男孩教育学Python开发【第一篇】:初识Python

      Python简介 Python前世今生 Python的创始人为吉多·范罗苏姆(Guido van Rossum).1989年的圣诞节期间,吉多·范罗苏姆为了在阿姆斯特丹打发时间,决心开发一个新的脚本解 ...

    10. 解决Ubuntu Kylin 1610安装ANSYS17.2的NVIDIA显卡驱动问题

      Ubuntu Kylin 1610在安装完毕后,会自动安装显卡驱动,对于一般的图形图像使用来说自然不会有太大的问题,但是对于ANSYS17.2的一些模块,还是会出现问题.一个比较常见的问题就是Open ...