Merge pull request #68 from PandaTechAM/development

exporter of xlsx support table and header freeze

Author: HaikAsatryan

src/FileExporter/Exporters/XlsxExporter.cs

@@ -11,6 +11,7 @@
 using FileExporter.Rules;
 using SpreadCheetah;
 using SpreadCheetah.Styling;
+using SpreadCheetah.Tables;
 using SpreadCheetah.Worksheets;
 
 namespace FileExporter.Exporters;
@@ -76,8 +77,13 @@ private static async Task<byte[]> CreateXlsxFileAsync<T>(IEnumerable<T> dataSlic
          var options = new WorksheetOptions();
          ApplyColumnWidths(options, columns);
 
+         options.FrozenRows = 1;
+
          await spreadsheet.StartWorksheetAsync(sheetName, options, token: cancellationToken);
 
+         var table = new Table(TableStyle.Medium2);
+         spreadsheet.StartTable(table);
+
          var headerStyleId = AddHeaderStyle(spreadsheet);
          await AddHeaderRowAsync(spreadsheet, columns, headerStyleId, cancellationToken);
 
@@ -102,6 +108,7 @@ private static async Task<byte[]> CreateXlsxFileAsync<T>(IEnumerable<T> dataSlic
       return ms.ToArray();
    }
 
+
    private static List<ExportColumn> BuildColumns<T>(ExportRule<T> rule)
       where T : class
    {
@@ -309,26 +316,26 @@ private static Cell CreateCell(object value)
    {
       return value switch
       {
-         string s   => new Cell(s),
-         bool b     => new Cell(b),
-         int i      => new Cell(i),
-         long l     => new Cell(l),
-         short sh   => new Cell(sh),
-         byte b8    => new Cell(b8),
-         uint ui    => new Cell((double)ui),
-         ulong ul   => new Cell((double)ul),
-         float f    => new Cell((double)f),
-         double d   => new Cell(d),
-         decimal m  => new Cell((double)m),
+         string s => new Cell(s),
+         bool b => new Cell(b),
+         int i => new Cell(i),
+         long l => new Cell(l),
+         short sh => new Cell(sh),
+         byte b8 => new Cell(b8),
+         uint ui => new Cell((double)ui),
+         ulong ul => new Cell((double)ul),
+         float f => new Cell((double)f),
+         double d => new Cell(d),
+         decimal m => new Cell((double)m),
 
          DateTime dt => CreateDateCell(dt),
-         DateOnly d  => CreateDateCell(d.ToDateTime(TimeOnly.MinValue)),
-         TimeOnly t  => CreateDateCell(DateTime.Today.Add(t.ToTimeSpan())),
+         DateOnly d => CreateDateCell(d.ToDateTime(TimeOnly.MinValue)),
+         TimeOnly t => CreateDateCell(DateTime.Today.Add(t.ToTimeSpan())),
 
          _ => new Cell(value.ToString() ?? string.Empty)
       };
    }
-   
+
    private static Cell CreateDateCell(DateTime dt)
    {
       try
@@ -355,9 +362,7 @@ private static async Task<byte[]> CreateMultiSheetXlsxFileAsync<T>(IList<T> list
 
       await using (var spreadsheet = await Spreadsheet.CreateNewAsync(ms, cancellationToken: cancellationToken))
       {
-         // Sanitize once for sheet names
          var sanitizedBaseName = rule.FileName.ToValidName(ExportLimits.MaxSheetNameLength);
-
          var headerStyleId = AddHeaderStyle(spreadsheet);
 
          var totalRows = list.Count;
@@ -366,13 +371,18 @@ private static async Task<byte[]> CreateMultiSheetXlsxFileAsync<T>(IList<T> list
          for (var offset = 0; offset < totalRows; offset += rowsPerSheet, sheetIndex++)
          {
             var take = Math.Min(rowsPerSheet, totalRows - offset);
-
             var sheetName = BuildSheetName(sanitizedBaseName, sheetIndex);
 
             var options = new WorksheetOptions();
             ApplyColumnWidths(options, columns);
 
+            options.FrozenRows = 1;
+
             await spreadsheet.StartWorksheetAsync(sheetName, options, token: cancellationToken);
+
+            var table = new Table(TableStyle.Medium2);
+            spreadsheet.StartTable(table);
+
             await AddHeaderRowAsync(spreadsheet, columns, headerStyleId, cancellationToken);
 
             for (var i = 0; i < take; i++)

src/FileExporter/FileExporter.csproj

@@ -12,7 +12,7 @@
         <PackageIcon>Logo.jpg</PackageIcon>
         <PackageReadmeFile>Readme.md</PackageReadmeFile>
 
-        <Version>5.0.1</Version>
+        <Version>5.0.2</Version>
 
         <Title>PandaTech File Exporter</Title>
 
@@ -31,7 +31,7 @@
         <RepositoryUrl>https://github.com/PandaTechAM/be-lib-file-exporter</RepositoryUrl>
 
         <PackageReleaseNotes>
-           In case of wrong dates xlsx export will not throw an exception anymore but will export that row with string value instead.
+           In case of xlsx export, the data is in tables now and first row is freezed.
         </PackageReleaseNotes>
     </PropertyGroup>
 

test/FileExporter.Demo/ExportRules/DummyExportRule.cs

@@ -11,35 +11,41 @@ public DummyExportRule()
       RuleFor(x => x.RelatedId)
          .WriteToColumn("Related Id")
          .HasOrder(1);
-      
+
       RuleFor(x => x.Id)
          .HasOrder(2);
 
       RuleFor(x => x.Name)
          .WriteToColumn("Custom Name - No Description")
-         .HasOrder(7)
+         .HasOrder(3)
          .WithDefaultValue("TEST");
 
       RuleFor(x => x.CreationDate)
          .WriteToColumn("Created At")
-         .HasWidth(1)
+         .HasWidth(4)
          .HasFormat(ColumnFormatType.DateTime);
 
       RuleFor(x => x.Dto)
          .WriteToColumn("Dto")
+         .HasOrder(5)
          .WithDefaultValue("Default value");
 
+
       RuleFor(x => x.IntEnum)
+         .HasOrder(6)
          .WithEnumFormat(EnumFormatMode.Int);
 
       RuleFor(x => x.StringEnum)
+         .HasOrder(7)
          .WithEnumFormat(EnumFormatMode.Name);
 
       RuleFor(x => x.SomeRate)
+         .HasOrder(8)
          .HasFormat(ColumnFormatType.Percentage)
          .HasPrecision(1);
-      
+
       RuleFor(x => x.SomeDollars)
+         .HasOrder(11)
          .HasFormat(ColumnFormatType.Currency)
          .HasPrecision(2);
    }