WeihanLi.Npoi
WeihanLi.Npoi
Intro
Npoi 扩展,适用于.netframework4.5及以上和netstandard2.0, .netframework基于NPOI, .netstandard基于 DotNetCore.NPOI
NpoiExtensions for target framework net4.5 or netstandard2.0,for net45 basedon NPOI,for .netstandard basedon DotNetCore.NPOI
Use
Install
.NetFramework
Install-Package WeihanLi.Npoi
.NetCore
dotnet add package WeihanLi.Npoi
GetStarted
LoadFromExcelFile
it consider the first row of the sheet as the header not for read,it will read data from next row.You can point out your header row through the exposed api if needed.
Read Excel to DataSet
// read excel to dataSet, read all sheets data to dataSet,by default it will read from the headerRowIndex(0) + 1
var dataSet = ExcelHelper.ToDataSet(string excelPath); // read excel to dataSet, read all sheets data to dataSet,headerRowIndex is not for read,read from headerRowIndex+1
var dataSet = ExcelHelper.ToDataSet(string excelPath, int headerRowIndex);
Read Excel to DataTable
// read excel to dataTable directly,by default read the first sheet content
var dataTable = ExcelHelper.ToDataTable(string excelPath); // read excel workbook's sheetIndex sheet to dataTable directly
var dataTableOfSheetIndex = ExcelHelper.ToDataTable(string excelPath, int sheetIndex); // read excel workbook's sheetIndex sheet to dataTable,custom headerRowIndex
var dataTableOfSheetIndex = ExcelHelper.ToDataTable(string excelPath, int sheetIndex, int headerRowIndex); // read excel to dataTable use mapping relations and settings from typeof(T),by default read the first sheet content
var dataTableT = ExcelHelper.ToDataTable<T>(string excelPath); // ... sheetIndex and headerRowIndex is also supported like above
Read Excel to List
// read excel first sheet content to a List<T>
var entityList = ExcelHelper.ToEntityList<T>(string excelPath); // read excel sheetIndex sheet content to a List<T>
// you can custom header row index via sheet attribute or fluent api HasSheet
var entityList1 = ExcelHelper.ToEntityList<T>(string excelPath, int sheetIndex);
Get a workbook
// load excel workbook from file
var workbook = LoadExcel(string excelPath); // prepare a workbook accounting to excelPath
var workbook = PrepareWorkbook(string excelPath); // prepare a workbook accounting to excelPath and custom excel settings
var workbook = PrepareWorkbook(string excelPath, ExcelSetting excelSetting); // prepare a workbook whether *.xlsx file
var workbook = PrepareWorkbook(bool isXlsx); // prepare a workbook whether *.xlsx file and custom excel setting
var workbook = PrepareWorkbook(bool isXlsx, ExcelSetting excelSetting);
Rich extensions
List<TEntity> ToEntityList<TEntity>([NotNull]this IWorkbook workbook) DataTable ToDataTable([NotNull]this IWorkbook workbook) ISheet ImportData<TEntity>([NotNull] this ISheet sheet, DataTable dataTable) int ImportData<TEntity>([NotNull] this IWorkbook workbook, IEnumerable<TEntity> list,
int sheetIndex) int ImportData<TEntity>([NotNull] this ISheet sheet, IEnumerable<TEntity> list) int ImportData<TEntity>([NotNull] this IWorkbook workbook, [NotNull] DataTable dataTable,
int sheetIndex) ToExcelFile<TEntity>([NotNull] this IEnumerable<TEntity> entityList,
[NotNull] string excelPath) int ToExcelStream<TEntity>([NotNull] this IEnumerable<TEntity> entityList,
[NotNull] Stream stream) byte[] ToExcelBytes<TEntity>([NotNull] this IEnumerable<TEntity> entityList) int ToExcelFile([NotNull] this DataTable dataTable, [NotNull] string excelPath) int ToExcelStream([NotNull] this DataTable dataTable, [NotNull] Stream stream) byte[] ToExcelBytes([NotNull] this DataTable dataTable) byte[] ToExcelBytes([NotNull] this IWorkbook workbook) int WriteToFile([NotNull] this IWorkbook workbook, string filePath) object GetCellValue([NotNull] this ICell cell, Type propertyType) T GetCellValue<T>([NotNull] this ICell cell) SetCellValue([NotNull] this ICell cell, object value)
Define Custom Mapping and settings
Attributes
Add
ColumnAttribute
on the property of the entity which you used for export or importAdd
SheetAttribute
on the entity which you used for export or import,you can set theStartRowIndex
on your need(by default it is1
)for example:
public class TestEntity
{
[Column("PKID")]
public int PKID { get; set; } [Column("账单标题")]
public string BillTitle { get; set; } [Column("账单详情")]
public string BillDetails { get; set; } [Column("创建人")]
public string CreatedBy { get; set; } [Column("创建时间")]
public DateTime CreatedTime { get; set; }
} internal class TestEntity1
{
/// <summary>
/// 用户名
/// </summary>
[Column("用户名")]
public string Username { get; set; } [Column(IsIgnored = true)]
public string PasswordHash { get; set; } [Column("可用余额")]
public decimal Amount { get; set; } = 1000M; [Column("微信id")]
public string WechatOpenId { get; set; } [Column("是否启用")]
public bool IsActive { get; set; }
}
FluentApi
You can also use FluentApi above version
1.0.3
for example:
var setting = ExcelHelper.SettingFor<TestEntity>();
// ExcelSetting
setting.HasAuthor("WeihanLi")
.HasTitle("WeihanLi.Npoi test")
.HasDescription("")
.HasSubject(""); setting.HasSheetConfiguration(0, "系统设置列表"); setting.HasFilter(0, 1)
.HasFreezePane(0, 1, 2, 1);
setting.Property(_ => _.SettingId)
.HasColumnIndex(0); setting.Property(_ => _.SettingName)
.HasColumnTitle("设置名称")
.HasColumnIndex(1); setting.Property(_ => _.DisplayName)
.HasColumnTitle("设置显示名称")
.HasColumnIndex(2); setting.Property(_ => _.SettingValue)
.HasColumnTitle("设置值")
.HasColumnIndex(3); setting.Property(_ => _.CreatedTime)
.HasColumnTitle("创建时间")
.HasColumnIndex(5)
.HasColumnFormatter("yyyy-MM-dd HH:mm:ss"); setting.Property(_ => _.CreatedBy)
.HasColumnIndex(4)
.HasColumnTitle("创建人"); setting.Property(_ => _.UpdatedBy).Ignored();
setting.Property(_ => _.UpdatedTime).Ignored();
setting.Property(_ => _.PKID).Ignored();
Samples
Contact
Contact me: weihanli@outlook.com
WeihanLi.Npoi的更多相关文章
- 使用 WeihanLi.Npoi 操作 CSV
使用 WeihanLi.Npoi 操作 CSV Intro 最近发现 csv 文件在很多情况下都在使用,而且经过大致了解,csv 格式简单,相比 excel 文件要小很多,读取也很是方便,而且也很通用 ...
- WeihanLi.Npoi 导出支持自定义列内容啦
WeihanLi.Npoi 导出支持自定义列内容啦 Intro 之前也有网友给提出过希望列合并或者自定义列内容的 issue 或请求,起初因为自己做 WeihanLi.Npoi 这个扩展的最初目的是导 ...
- WeihanLi.Npoi 近期更新
WeihanLi.Npoi 近期更新 Intro 最近对我的 NPOI 扩展做了一些改变,一方面提高性能,一方面修复bug,增加一些新的功能来让它更加好用,前几天发布了 1.5.0 版本,下面来介绍一 ...
- WeihanLi.Npoi 支持 ShadowProperty 了
WeihanLi.Npoi 支持 ShadowProperty 了 Intro 在 EF 里有个 ShadowProperty (阴影属性/影子属性)的概念,你可以通过 FluentAPI 的方式来定 ...
- WeihanLi.Npoi 1.7.0 更新
WeihanLi.Npoi 1.7.0 更新介绍 Intro 昨天晚上发布了 WeihanLi.Npoi 1.7.0 版本,增加了 ColumnInputFormatter/ColumnOutputF ...
- WeihanLi.Npoi 根据模板导出Excel
WeihanLi.Npoi 根据模板导出Excel Intro 原来的导出方式比较适用于比较简单的导出,每一条数据在一行,数据列虽然自定义程度比较高,如果要一条数据对应多行就做不到了,于是就想支持根据 ...
- WeihanLi.Npoi 1.10.0 更新日志
WeihanLi.Npoi 1.10.0 更新日志 Intro 上周有个网友希望能够导入Excel时提供一个 EndRowIndex 来自己控制结束行和根据字段过滤的,周末找时间做了一下这个 feat ...
- WeihanLi.Npoi 1.11.0/1.12.0 Release Notes
WeihanLi.Npoi 1.11.0/1.12.0 Release Notes Intro 最近 NPOI 扩展新更新了两个版本,感谢 shaka chow 的帮忙和支持,这两个 Feature ...
- WeihanLi.Npoi 1.13.0 更新日志
WeihanLi.Npoi 1.13.0 更新日志 Intro 在 Github 上收到 Issue 收到网友反馈希望支持自动分 Sheet 导出,有兴趣的可以参考 Issue https://git ...
随机推荐
- SpringMVC(二):RequestMapping修饰类、指定请求方式、请求参数或请求头、支持Ant路径
@RequestMapping用来映射请求:RequestMapping可以修饰方法外,还可以修饰类 1)SpringMVC使用@RequestMapping注解为控制指定可以处理哪些URL请求: 2 ...
- Spring(三):Spring整合Hibernate
背景: 本文主要介绍使用spring-framework-4.3.8.RELEASE与hibernate-release-5.2.9.Final项目整合搭建的过程. 开发环境简介: 1).jdk 1. ...
- WPF利用附加属性修改ShowGridLines效果
1.思路主要代码 wpf的gridline原本效果是虚线类型的.有时候需要设计成表格形式的,因此有了用附加属性来自动绘制边框线的想法. 思路:绘制Line并添加到grid的children里,但效果并 ...
- JavaScript的屏幕对象
screen 屏幕对象 反映了当前用户的屏幕设置. width 返回屏幕的宽度(像素数). height 返回屏幕的高度. availWidth 返回屏幕的可用宽度(除去了一些不自动隐藏的类似任务栏的 ...
- iconfont字体图标和各种CSS小图标
前言:这是笔者学习之后自己的理解与整理.如果有错误或者疑问的地方,请大家指正,我会持续更新! iconfont字体图标 我们的需求中,很多时候会看到一些小的图形,或者叫图标,比如天猫网站中: ...
- 瞎扯设计模式1:单例模式 饿汉模式 懒汉模式 线程安全的单例 singleton 设计模式 java
[原创声明]此文为本人原创,欢迎转载,转载请注明出处,作者链接~ http://www.cnblogs.com/m-yb/p/8833085.html 单例很常用,面试也经常被问,如:不用自定义锁怎么 ...
- Java四种线程池的学习与总结
在Java开发中,有时遇到多线程的开发时,直接使用Thread操作,对程序的性能和维护上都是一个问题,使用Java提供的线程池来操作可以很好的解决问题. 一.new Thread的弊端 执行一个异步任 ...
- [LeetCode] Longest Word in Dictionary through Deleting 删除后得到的字典中的最长单词
Given a string and a string dictionary, find the longest string in the dictionary that can be formed ...
- MySQL InnoDB 索引原理
本文由 网易云发布. 作者:范鹏程,网易考拉海购 InnoDB是 MySQL最常用的存储引擎,了解InnoDB存储引擎的索引对于日常工作有很大的益处,索引的存在便是为了加速数据库行记录的检索.以下是 ...
- spark-shell报错:Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/hadoop/fs/FSDataInputStream
环境: openSUSE42.2 hadoop2.6.0-cdh5.10.0 spark1.6.0-cdh5.10.0 按照网上的spark安装教程安装完之后,启动spark-shell,出现如下报错 ...