Add Excel auto-size and freeze switches

Examples/Excel/Export/Example-AutoSizeAndFreeze.ps1

@@ -0,0 +1,4 @@
+$Path = Join-Path $PSScriptRoot 'AutoSizeFreeze.xlsx'
+New-Item -Path $Path -ItemType File -Force | Out-Null
+$Data = 1..3 | ForEach-Object { [PSCustomObject]@{ Name = "Row $_"; Value = "Some very long value $_" } }
+$Data | Export-OfficeExcel -FilePath $Path -AutoSize -FreezeTopRow -FreezeFirstColumn

Sources/PSWriteOffice/Cmdlets/Excel/ExportOfficeExcelCommand.cs

@@ -64,6 +64,15 @@ public class ExportOfficeExcelCommand : PSCmdlet
     [Parameter]
     public SwitchParameter EmphasizeLastColumn { get; set; }
 
+    [Parameter]
+    public SwitchParameter AutoSize { get; set; }
+
+    [Parameter]
+    public SwitchParameter FreezeTopRow { get; set; }
+
+    [Parameter]
+    public SwitchParameter FreezeFirstColumn { get; set; }
+
     [Parameter]
     public XLTableTheme Theme { get; set; } = XLTableTheme.None;
 
@@ -201,6 +210,21 @@ protected override void EndProcessing()
                     Transpose);
             }
 
+            if (AutoSize)
+            {
+                ExcelDocumentService.AutoSizeColumns(worksheet);
+            }
+
+            if (FreezeTopRow)
+            {
+                ExcelDocumentService.FreezeTopRow(worksheet);
+            }
+
+            if (FreezeFirstColumn)
+            {
+                ExcelDocumentService.FreezeFirstColumn(worksheet);
+            }
+
             ExcelDocumentService.SaveWorkbook(workbook, FilePath, Show);
         }
         catch (Exception ex)

Sources/PSWriteOffice/Services/Excel/ExcelDocumentService.Worksheet.cs

@@ -41,4 +41,19 @@ public static IXLWorksheet AddWorksheet(XLWorkbook workbook, string worksheetNam
         }
         return worksheet;
     }
+
+    public static void AutoSizeColumns(IXLWorksheet worksheet)
+    {
+        worksheet.Columns().AdjustToContents();
+    }
+
+    public static void FreezeTopRow(IXLWorksheet worksheet)
+    {
+        worksheet.SheetView.FreezeRows(1);
+    }
+
+    public static void FreezeFirstColumn(IXLWorksheet worksheet)
+    {
+        worksheet.SheetView.FreezeColumns(1);
+    }
 }

Tests/ExportOfficeExcel.Tests.ps1

@@ -33,6 +33,20 @@ Describe 'Export-OfficeExcel cmdlet' {
         $rows[1].Second | Should -BeNullOrEmpty
     }
 
+    It 'auto sizes columns and freezes panes when switches are used' {
+        $path = Join-Path $TestDrive 'format.xlsx'
+        New-Item -Path $path -ItemType File | Out-Null
+        $data = 1..2 | ForEach-Object { [PSCustomObject]@{ Name = "Row$_"; Value = "Some very long value $_" } }
+        $data | Export-OfficeExcel -FilePath $path -WorksheetName 'Data' -AutoSize -FreezeTopRow -FreezeFirstColumn
+        $dll = Join-Path $PSScriptRoot '..' 'Sources' 'PSWriteOffice' 'bin' 'Debug' 'net8.0' 'ClosedXML.dll'
+        Add-Type -Path $dll
+        $wb = [ClosedXML.Excel.XLWorkbook]::new($path)
+        $ws = $wb.Worksheet('Data')
+        $ws.Column(1).Width | Should -BeGreaterThan 8.43
+        $ws.SheetView.SplitRow | Should -Be 1
+        $ws.SheetView.SplitColumn | Should -Be 1
+    }
+
     It 'throws for invalid path' {
         $data = 1..3 | ForEach-Object { [PSCustomObject]@{ Value = $_ } }
         { $data | Export-OfficeExcel -FilePath (Join-Path $TestDrive 'missing.xlsx') } | Should -Throw