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 = "https://www.cnblogs.com/weihanli/archive/2021/03/07/Value1",
        DisplayName = "dd\"d,1"
    },
    new TestEntity()
    {
        PKID=2,
        SettingId = Guid.NewGuid(),
        SettingName = "Setting2",
        SettingValue = "https://www.cnblogs.com/weihanli/archive/2021/03/07/Value2",
        Enabled = true,
        CreatedBy = "li\"_"
    },
};
entities.ToExcelFile("test.xlsx");

匯出結果如下：

export result

可以看得出來，我們匯出的結果中第一行的樣式和別的樣式會不同

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 單元格的樣式，匯出結果如下圖所示：

DbTool export result

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

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/267264.html

標籤：.NET技术

上一篇：NET5 ORM 六大新功能 - SqlSugar 5.0.2.7

下一篇：WPF之資源

WeihanLi.Npoi 1.16.0 Release Notes

WeihanLi.Npoi 1.16.0 Release Notes

Intro

Sheet Setting

Sample1

Another Sample

More

References