Added join Worksheet

Moved "MoveTo…" functionality into Add-Worksheet and gave it copy worksheet functionality Added create new file functionality to Open-ExcelPackage - requires a -create switch so previous "Open for read if it exists" behaviour is kept. Fixed Conditional formatting so background pattern is "None" not "Solid" by default. Tidied comments and help in Merge and Compare Added Join Worksheet Added Extra parameters, sanity check and help to New-PivotTableDefinition
2026-01-03 17:13:17 +00:00 · 2018-06-17 03:15:47 +01:00
parent 520bb079e5
commit d74cce91b6
7 changed files with 1273 additions and 774 deletions
--- a/Open-ExcelPackage.ps1
+++ b/Open-ExcelPackage.ps1
@@ -1,50 +1,67 @@
-Function Open-ExcelPackage  {
-<#
-.Synopsis 
-    Returns an Excel Package Object with for the specified XLSX ile 
-.Example
-    $excel  = Open-ExcelPackage -path $xlPath 
-    $sheet1 = $excel.Workbook.Worksheets["sheet1"] 
-    set-Format -Address $sheet1.Cells["E1:S1048576"], $sheet1.Cells["V1:V1048576"]  -NFormat ([cultureinfo]::CurrentCulture.DateTimeFormat.ShortDatePattern) 
-    close-ExcelPackage $excel -Show
-
-   This will open the file at $xlPath, select sheet1 apply formatting to two blocks of the sheet and close the package 
-#>
-    [OutputType([OfficeOpenXml.ExcelPackage])]
-    Param ([Parameter(Mandatory=$true)]$Path,
-           [switch]$KillExcel)
-
-        if($KillExcel)         {
-            Get-Process -Name "excel" -ErrorAction Ignore | Stop-Process
-            while (Get-Process -Name "excel" -ErrorAction Ignore) {}
-        }
-
-        $Path          = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
-        if (Test-Path $path) {New-Object -TypeName OfficeOpenXml.ExcelPackage -ArgumentList $Path }
-        Else                 {Write-Warning "Could not find $path" } 
- }
-
-Function Close-ExcelPackage {
-<#
-.Synopsis 
-    Closes an Excel Package, saving, saving under a new name or abandoning changes and opening the file as required 
-#>
-    Param (
-    #File to close
-    [parameter(Mandatory=$true, ValueFromPipeline=$true)]
-    [OfficeOpenXml.ExcelPackage]$ExcelPackage,
-    #Open the file
-    [switch]$Show, 
-    #Abandon the file without saving
-    [Switch]$NoSave,
-    #Save file with a new name (ignored if -NoSaveSpecified)
-    $SaveAs
-    )
-    if ( $NoSave)      {$ExcelPackage.Dispose()}
-    else {
-          if ($SaveAs) {$ExcelPackage.SaveAs( $SaveAs ) } 
-          Else         {$ExcelPackage.Save(); $SaveAs = $ExcelPackage.File.FullName }
-          $ExcelPackage.Dispose() 
-          if ($show)   {Start-Process -FilePath $SaveAs } 
-    }
-}
+Function Open-ExcelPackage  {
+<#
+.Synopsis 
+    Returns an Excel Package Object with for the specified XLSX ile 
+.Example
+    $excel  = Open-ExcelPackage -path $xlPath 
+    $sheet1 = $excel.Workbook.Worksheets["sheet1"] 
+    Set-Format -Address $sheet1.Cells["E1:S1048576"], $sheet1.Cells["V1:V1048576"]  -NFormat ([cultureinfo]::CurrentCulture.DateTimeFormat.ShortDatePattern) 
+    Close-ExcelPackage $excel -Show
+
+   This will open the file at $xlPath, select sheet1 apply formatting to two blocks of the sheet and save the package, and launch it in Excel.  
+#>
+    [OutputType([OfficeOpenXml.ExcelPackage])]
+    Param (
+        #The Path to the file to open
+        [Parameter(Mandatory=$true)]$Path,
+        #If specified, any running instances of Excel will be terminated before opening the file.  
+        [switch]$KillExcel,
+        #By  default open only opens an existing file; -Create instructs it to create a new file if required. 
+        [switch]$Create
+    )
+
+    if($KillExcel)         {
+        Get-Process -Name "excel" -ErrorAction Ignore | Stop-Process
+        while (Get-Process -Name "excel" -ErrorAction Ignore) {}
+    }
+
+    $Path = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
+    #If -Create was not specified only open the file if it exists already (send a warning if it doesn't exist). 
+    if ($Create) {
+        #Create the directory if required. 
+        $targetPath = Split-Path -Parent -Path $Path
+        if (!(Test-Path -Path $targetPath)) {
+                Write-Debug "Base path $($targetPath) does not exist, creating"
+                $null = New-item -ItemType Directory -Path $targetPath -ErrorAction Ignore
+        }
+        New-Object -TypeName OfficeOpenXml.ExcelPackage -ArgumentList $Path 
+    }
+    elseif (Test-Path -Path $path) {New-Object -TypeName OfficeOpenXml.ExcelPackage -ArgumentList $Path }
+    else   {Write-Warning "Could not find $path" } 
+ }
+
+Function Close-ExcelPackage {
+<#
+.Synopsis 
+    Closes an Excel Package, saving, saving under a new name or abandoning changes and opening the file in Excel as required. 
+#>
+    Param (
+    #File to close.
+    [parameter(Mandatory=$true, ValueFromPipeline=$true)]
+    [OfficeOpenXml.ExcelPackage]$ExcelPackage,
+    #Open the file.
+    [switch]$Show, 
+    #Abandon the file without saving.
+    [Switch]$NoSave,
+    #Save file with a new name (ignored if -NoSave Specified).
+    $SaveAs
+    )
+    if ( $NoSave)      {$ExcelPackage.Dispose()}
+    else {
+          if ($SaveAs) {$ExcelPackage.SaveAs( $SaveAs ) } 
+          Else         {$ExcelPackage.Save(); $SaveAs = $ExcelPackage.File.FullName }
+          $ExcelPackage.Dispose() 
+          if ($show)   {Start-Process -FilePath $SaveAs } 
+    }
+}
+