WeihanLi.Npoi 1.16.0 Release Notes

WeihanLi.Npoi 1.16.0 Release Notes

Intro

最近有網友諮詢如何設置單元格樣式，在以前的版本中是不支持的，以前主要考慮的是數據，對於導出的樣式並無支持，這個 issue 也讓我以爲目前還不是足夠的靈活，因而進行了一些探索，增長了更多擴展的可能性，一塊兒來看一下吧

Sheet Setting

由於導入導出是針對某一個 Sheet 而言的，因此支持爲不一樣的 Sheet 設置不一樣的配置，若是全部 Sheet 的配置都是同樣的，則只配置默認的 Sheet 配置就能夠了，新版本中增長了三個委託，進一步的加強的導出的靈活性

/// <summary>
/// Cell Action on export
/// </summary>
public Action<ICell>? CellAction { get; set; }

/// <summary>
/// Row Action on export
/// </summary>
public Action<IRow>? RowAction { get; set; }

/// <summary>
/// Sheet Action on export
/// </summary>
public Action<ISheet>? SheetAction { get; set; }

能夠不一樣的 Level 擴展本身想要的功能，這些擴展會在寫入數據以後執行，能夠藉此來設置特殊單元格的樣式，若是你想也能夠從新設置導出的數據，來看下面的示例：

Sample1

首先來看一個設置 Header 字體樣式的一個示例，完整代碼參考：https://github.com/WeihanLi/WeihanLi.Npoi/blob/310d7637e82210f7558b2a60a637b43485c0e562/samples/DotNetCoreSample/Program.cs#L157

var setting = FluentSettings.For<TestEntity>();
    // ExcelSetting
    setting.HasAuthor("WeihanLi")
        .HasTitle("WeihanLi.Npoi test")
        .HasDescription("WeihanLi.Npoi test")
        .HasSubject("WeihanLi.Npoi test");

    setting.HasSheetSetting(config =>
    {
        config.StartRowIndex = 1;
        config.SheetName = "SystemSettingsList";
        config.AutoColumnWidthEnabled = true;

        config.RowAction = row =>
        {
            if (row.RowNum == 0)
            {
                var style = row.Sheet.Workbook.CreateCellStyle();
                style.Alignment = HorizontalAlignment.Center;
                var font = row.Sheet.Workbook.CreateFont();
                font.FontName = "JetBrains Mono";
                font.IsBold = true;
                font.FontHeight = 200;
                style.SetFont(font);
                row.Cells.ForEach(c => c.CellStyle = style);
            }
        };
    });

    setting.Property(_ => _.SettingId)
        .HasColumnIndex(0);

    setting.Property(_ => _.SettingName)
        .HasColumnTitle("SettingName")
        .HasColumnIndex(1);

    setting.Property(_ => _.DisplayName)
        .HasOutputFormatter((entity, displayName) => $"AAA_{entity?.SettingName}_{displayName}")
        .HasInputFormatter((entity, originVal) => originVal?.Split(new[] { '_' })[2])
        .HasColumnTitle("DisplayName")
        .HasColumnIndex(2);

    setting.Property(_ => _.SettingValue)
        .HasColumnTitle("SettingValue")
        .HasColumnIndex(3);

    setting.Property(_ => _.CreatedTime)
        .HasColumnTitle("CreatedTime")
        .HasColumnIndex(4)
        .HasColumnWidth(10)
        .HasColumnFormatter("yyyy-MM-dd HH:mm:ss");

    setting.Property(_ => _.CreatedBy)
        .HasColumnInputFormatter(x => x += "_test")
        .HasColumnIndex(4)
        .HasColumnTitle("CreatedBy");

    setting.Property(x => x.Enabled)
        .HasColumnInputFormatter(val => "Enabled".EqualsIgnoreCase(val))
        .HasColumnOutputFormatter(v => v ? "Enabled" : "Disabled");

    setting.Property("HiddenProp")
        .HasOutputFormatter((entity, val) => $"HiddenProp_{entity?.PKID}");

    setting.Property(_ => _.PKID).Ignored();
    setting.Property(_ => _.UpdatedBy).Ignored();
    setting.Property(_ => _.UpdatedTime).Ignored();
}

導出代碼：

var entities = new List<TestEntity>()
{
    new TestEntity()
    {
        PKID = 1,
        SettingId = Guid.NewGuid(),
        SettingName = "Setting1",
        SettingValue = "Value1",
        DisplayName = "dd\"d,1"
    },
    new TestEntity()
    {
        PKID=2,
        SettingId = Guid.NewGuid(),
        SettingName = "Setting2",
        SettingValue = "Value2",
        Enabled = true,
        CreatedBy = "li\"_"
    },
};
entities.ToExcelFile("test.xlsx");

導出結果以下：

能夠看得出來，咱們導出的結果中第一行的樣式和別的樣式會不一樣

Another Sample

除了直接導出到 excel 文件以外，還能夠支持導出到某一個 sheet 中，我在個人另一個 DbTool 的項目中也在使用，將原來的一大坨代碼作了很大的簡化，詳細修改能夠參考這個 commit: https://github.com/WeihanLi/DbTool/commit/7c7b980714af11e5fec3f8b3babac0904f94cff3#diff-d0ef24afd15ae6aa4ead43fbe31a895c1c051ab9c6e50f4ff4c7544a9592f958R8

最後實際使用的導出代碼：

var workbook = ExcelHelper.PrepareWorkbook(FileExtension.EndsWith(".xls") ? ExcelFormat.Xls : ExcelFormat.Xlsx);
foreach (var tableEntity in tableInfo)
{
    //Create Sheet
    var sheet = workbook.CreateSheet(tableEntity.TableName);

    //create title
    var titleRow = sheet.CreateRow(0);
    var titleCell = titleRow.CreateCell(0);
    titleCell.SetCellValue(tableEntity.TableDescription);

    // export list data to excel
    sheet.ImportData(tableEntity.Columns);
}
return workbook.ToExcelBytes();

相比以前的代碼，大大簡化了，原來的代碼能夠參考https://github.com/WeihanLi/DbTool/commit/7c7b980714af11e5fec3f8b3babac0904f94cff3#diff-d0ef24afd15ae6aa4ead43fbe31a895c1c051ab9c6e50f4ff4c7544a9592f958L17-L121， 100 多行代碼，太長了不方便截圖

大部分的代碼都變成了配置，部分配置代碼能夠參考下面的代碼，具體配置能夠參考：https://github.com/WeihanLi/DbTool/blob/wpf-dev/src/DbTool/ExcelDbDocExporter.cs

var settings = FluentSettings.For<ColumnEntity>();
settings.HasExcelSetting(x =>
    {
        x.Author = "DbTool";
    })
    .HasSheetSetting(x =>
    {
        x.StartRowIndex = 2;
        x.AutoColumnWidthEnabled = true;
        x.RowAction = row =>
        {
            // apply header row style
            if (row.RowNum == 1)
            {
                var headerStyle = row.Sheet.Workbook.CreateCellStyle();
                headerStyle.Alignment = HorizontalAlignment.Center;
                var headerFont = row.Sheet.Workbook.CreateFont();
                headerFont.FontHeight = 180;
                headerFont.IsBold = true;
                headerFont.FontName = "微軟雅黑";
                headerStyle.SetFont(headerFont);
                row.Cells.ForEach(c => c.CellStyle = headerStyle);
            }
        };
        x.SheetAction = sheet =>
        {
            // set merged region
            sheet.AddMergedRegion(new NPOI.SS.Util.CellRangeAddress(0, 0, 0, 6));
            // apply title style
            var titleStyle = sheet.Workbook.CreateCellStyle();
            titleStyle.Alignment = HorizontalAlignment.Left;
            var font = sheet.Workbook.CreateFont();
            font.FontHeight = 200;
            font.FontName = "微軟雅黑";
            font.IsBold = true;
            titleStyle.SetFont(font);
            titleStyle.FillBackgroundColor = IndexedColors.Black.Index;
            titleStyle.FillForegroundColor = IndexedColors.SeaGreen.Index;
            titleStyle.FillPattern = FillPattern.SolidForeground;
            sheet.GetRow(0).GetCell(0).CellStyle = titleStyle;
        };
    });
// ...

上面的代碼經過 RowAction 配置了 Header 行的單元格的樣式，經過 SheetAction 配置了 Title 行的單元格合併和 Title 單元格的樣式，導出結果以下圖所示：

More

WeihanLi.Npoi 經過 Fluent API 的方式提供了很是靈活的導入導出配置，若是你也有導入導出 Excel 的需求，能夠了解一下，若是不能知足的地方或者使用過程當中有遇到任何問題歡迎給我提 issue https://github.com/WeihanLi/WeihanLi.Npoi/issues/new/choose

其餘介紹文章：

• 基本示例
• InputOutputFormatter 使用
• ShadowProperty 使用
• 根據模板導出

更多的使用文檔能夠參考項目示例項目，單元測試以及文檔

• 示例項目：https://github.com/WeihanLi/WeihanLi.Npoi/blob/dev/samples/DotNetCoreSample/Program.cs
• 單元測試：https://github.com/WeihanLi/WeihanLi.Npoi/blob/dev/test/WeihanLi.Npoi.Test/ExcelTest.cs
• 文檔：https://weihanli.github.io/WeihanLi.Npoi/index.html

References

• https://github.com/WeihanLi/WeihanLi.Npoi/issues/104
• https://github.com/WeihanLi/DbTool/blob/wpf-dev/src/DbTool/ExcelDbDocExporter.cs
• https://weihanli.github.io/WeihanLi.Npoi/index.html
• https://www.nuget.org/packages/WeihanLi.Npoi/1.16.0