Merge remote-tracking branch 'upstream/master'

Examples/CustomReporting/CustomReport.ps1

@@ -51,7 +51,7 @@ Set-Format -Address $sheet1.Cells["E2:G2"] -BorderBottom $BorderBottom -BorderCo
 Set-Format -Address $sheet1.Cells["I2:K2"] -BorderBottom $BorderBottom -BorderColor $BorderColor
 Set-Format -Address $sheet1.Cells["M2:O2"] -BorderBottom $BorderBottom -BorderColor $BorderColor
 
-Set-Format -Address $sheet1.Cells["A2:C8"] -FontColor GrayText
+Set-Format -Address $sheet1.Cells["A2:C8"] -FontColor Gray
 
 $HorizontalAlignment = "Center"
 Set-Format -Address $sheet1.Cells["F1"] -HorizontalAlignment $HorizontalAlignment -Bold -Value Revenue

Examples/FormatCellStyles/ApplyStyle.ps1

@@ -0,0 +1,24 @@
+$data = ConvertFrom-Csv @'
+Item,Quantity,Price,Total Cost
+Footballs,9,21.95,197.55
+Cones,36,7.99,287.64
+Shin Guards,14,10.95,153.3
+Turf Shoes,22,79.95,1758.9
+Baseballs,68,7.99,543.32
+Baseball Gloves,31,65.00,2015.00
+Baseball Bats,38,159.00,6042.00
+'@
+
+$f = "$env:TEMP\styles.xlsx"
+Remove-Item $f -ErrorAction SilentlyContinue
+
+$pkg = $data | Export-Excel -Path $f -AutoSize -PassThru
+
+$ws = $pkg.Workbook.Worksheets["Sheet1"]
+
+Set-ExcelRange -WorkSheet $ws -Range "A2:C6" -BackgroundColor PeachPuff -FontColor Purple        -FontSize 12 -Width 12
+Set-ExcelRange -WorkSheet $ws -Range "D2:D6" -BackgroundColor WhiteSmoke -FontColor Orange -Bold -FontSize 12 -Width 12
+Set-ExcelRange -WorkSheet $ws -Range "A1:D1" -BackgroundColor BlueViolet -FontColor Wheat        -FontSize 12 -Width 12
+Set-ExcelRange -WorkSheet $ws -Range "A:A"                                                                    -Width 15
+
+Close-ExcelPackage -ExcelPackage $pkg -Show

Examples/MortgageCalculator/MortgageCalculator.ps1

@@ -0,0 +1,55 @@
+<#
+  Fixed Rate Loan/Mortgage Calculator in Excel
+#>
+
+param(
+    $Amount = 400000,
+    $InterestRate = .065,
+    $Term = 30
+)
+
+function New-CellData {
+    param(
+        $Range,
+        $Value,
+        $Format
+    )
+
+    $setFormatParams = @{
+        WorkSheet    = $ws
+        Range        = $Range
+        NumberFormat = $Format
+    }
+
+    if ($Value -is [string] -and $Value.StartsWith('=')) {
+        $setFormatParams.Formula = $Value
+    }
+    else {
+        $setFormatParams.Value = $Value
+    }
+
+    Set-Format @setFormatParams
+}
+
+$f = "$PSScriptRoot\mortgage.xlsx"
+Remove-Item $f -ErrorAction SilentlyContinue
+
+$pkg = "" | Export-Excel $f -Title 'Fixed Rate Loan Payments' -PassThru -AutoSize
+$ws = $pkg.Workbook.Worksheets["Sheet1"]
+
+New-CellData A3 'Amount'
+New-CellData B3 $Amount '$#,##0'
+
+New-CellData A4 "Interest Rate"
+New-CellData B4 $InterestRate 'Percentage'
+
+New-CellData A5 "Term (Years)"
+New-CellData B5 $Term
+
+New-CellData D3 "Monthly Payment"
+New-CellData F3 "=-PMT(F4, B5*12, B3)" '$#,##0.#0'
+
+New-CellData D4 "Monthly Rate"
+New-CellData F4 "=((1+B4)^(1/12))-1" 'Percentage'
+
+Close-ExcelPackage $pkg -Show

Export-StocksToExcel.ps1

@@ -0,0 +1,28 @@
+function Export-StocksToExcel {
+    param(
+        [string]$symbols,
+        [ValidateSet("Open", "High", "Low", "Close", "Volume")]
+        $measure = "Open"
+    )
+
+    $xl = "$env:TEMP\Stocks.xlsx"
+
+    Remove-Item $xl -ErrorAction SilentlyContinue
+
+    $r = Invoke-RestMethod "https://azfnstockdata-fn83fffd32.azurewebsites.net/api/GetQuoteChart?symbol=$($symbols)"
+
+    $chartColumn = $symbols.Split(',').count + 2
+    $ptd = New-PivotTableDefinition `
+        -SourceWorkSheet Sheet1 `
+        -PivotTableName result `
+        -PivotData @{$measure = 'sum'} `
+        -PivotRows date `
+        -PivotColumns symbol `
+        -ChartType Line `
+        -ChartTitle "Stock - $measure " `
+        -IncludePivotChart -NoTotalsInPivot -ChartColumn $chartColumn -ChartRow 3 -Activate
+
+    $r | Sort-Object Date, symbol | Export-Excel $xl -PivotTableDefinition $ptd -AutoSize -AutoFilter -Show
+}
+
+# Export-StocksToExcel -symbols 'ibm,aapl,msft' -measure High

ImportExcel.psd1

@@ -4,7 +4,7 @@
     RootModule        = 'ImportExcel.psm1'
 
     # Version number of this module.
-    ModuleVersion     = '5.4.0'
+    ModuleVersion     = '5.4.1'
 
     # ID used to uniquely identify this module
     GUID              = '60dd4136-feff-401a-ba27-a84458c57ede'

ImportExcel.psm1

@@ -1,46 +1,47 @@
 #region import everything we need
-    Add-Type -Path "$($PSScriptRoot)\EPPlus.dll"
-    . $PSScriptRoot\AddConditionalFormatting.ps1
-    . $PSScriptRoot\Charting.ps1
-    . $PSScriptRoot\ColorCompletion.ps1
-    . $PSScriptRoot\ConvertExcelToImageFile.ps1
-    . $PSScriptRoot\Compare-WorkSheet.ps1
-    . $PSScriptRoot\ConvertFromExcelData.ps1
-    . $PSScriptRoot\ConvertFromExcelToSQLInsert.ps1
-    . $PSScriptRoot\ConvertToExcelXlsx.ps1
-    . $PSScriptRoot\Copy-ExcelWorkSheet.ps1
-    . $PSScriptRoot\Export-Excel.ps1
-    . $PSScriptRoot\Export-ExcelSheet.ps1
-    . $PSScriptRoot\Get-ExcelColumnName.ps1
-    . $PSScriptRoot\Get-ExcelSheetInfo.ps1
-    . $PSScriptRoot\Get-ExcelWorkbookInfo.ps1
-    . $PSScriptRoot\Get-HtmlTable.ps1
-    . $PSScriptRoot\Get-Range.ps1
-    . $PSScriptRoot\Get-XYRange.ps1
-    . $PSScriptRoot\Import-Html.ps1
-    . $PSScriptRoot\InferData.ps1
-    . $PSScriptRoot\Invoke-Sum.ps1
-    . $PSScriptRoot\Join-WorkSheet.ps1
-    . $PSScriptRoot\Merge-Worksheet.ps1
-    . $PSScriptRoot\New-ConditionalFormattingIconSet.ps1
-    . $PSScriptRoot\New-ConditionalText.ps1
-    . $PSScriptRoot\New-ExcelChart.ps1
-    . $PSScriptRoot\New-PSItem.ps1
-    . $PSScriptRoot\Open-ExcelPackage.ps1
-    . $PSScriptRoot\Pivot.ps1
-    . $PSScriptRoot\PivotTable.ps1
-    . $PSScriptRoot\Send-SQLDataToExcel.ps1
-    . $PSScriptRoot\Set-CellStyle.ps1
-    . $PSScriptRoot\Set-Column.ps1
-    . $PSScriptRoot\Set-Row.ps1
-    . $PSScriptRoot\SetFormat.ps1
-    . $PSScriptRoot\TrackingUtils.ps1
-    . $PSScriptRoot\Update-FirstObjectProperties.ps1
+Add-Type -Path "$($PSScriptRoot)\EPPlus.dll"
+. $PSScriptRoot\AddConditionalFormatting.ps1
+. $PSScriptRoot\Charting.ps1
+. $PSScriptRoot\ColorCompletion.ps1
+. $PSScriptRoot\ConvertExcelToImageFile.ps1
+. $PSScriptRoot\Compare-WorkSheet.ps1
+. $PSScriptRoot\ConvertFromExcelData.ps1
+. $PSScriptRoot\ConvertFromExcelToSQLInsert.ps1
+. $PSScriptRoot\ConvertToExcelXlsx.ps1
+. $PSScriptRoot\Copy-ExcelWorkSheet.ps1
+. $PSScriptRoot\Export-Excel.ps1
+. $PSScriptRoot\Export-ExcelSheet.ps1
+. $PSScriptRoot\Export-StocksToExcel.ps1
+. $PSScriptRoot\Get-ExcelColumnName.ps1
+. $PSScriptRoot\Get-ExcelSheetInfo.ps1
+. $PSScriptRoot\Get-ExcelWorkbookInfo.ps1
+. $PSScriptRoot\Get-HtmlTable.ps1
+. $PSScriptRoot\Get-Range.ps1
+. $PSScriptRoot\Get-XYRange.ps1
+. $PSScriptRoot\Import-Html.ps1
+. $PSScriptRoot\InferData.ps1
+. $PSScriptRoot\Invoke-Sum.ps1
+. $PSScriptRoot\Join-WorkSheet.ps1
+. $PSScriptRoot\Merge-Worksheet.ps1
+. $PSScriptRoot\New-ConditionalFormattingIconSet.ps1
+. $PSScriptRoot\New-ConditionalText.ps1
+. $PSScriptRoot\New-ExcelChart.ps1
+. $PSScriptRoot\New-PSItem.ps1
+. $PSScriptRoot\Open-ExcelPackage.ps1
+. $PSScriptRoot\Pivot.ps1
+. $PSScriptRoot\PivotTable.ps1
+. $PSScriptRoot\Send-SQLDataToExcel.ps1
+. $PSScriptRoot\Set-CellStyle.ps1
+. $PSScriptRoot\Set-Column.ps1
+. $PSScriptRoot\Set-Row.ps1
+. $PSScriptRoot\SetFormat.ps1
+. $PSScriptRoot\TrackingUtils.ps1
+. $PSScriptRoot\Update-FirstObjectProperties.ps1
 
 
-    New-Alias -Name Use-ExcelData -Value "ConvertFrom-ExcelData" -Force
+New-Alias -Name Use-ExcelData -Value "ConvertFrom-ExcelData" -Force
 
-    if ($PSVersionTable.PSVersion.Major -ge 5) {
+if ($PSVersionTable.PSVersion.Major -ge 5) {
     . $PSScriptRoot\Plot.ps1
 
     Function New-Plot {
@@ -49,11 +50,11 @@
         [PSPlot]::new()
     }
 
-    }
-    else {
+}
+else {
     Write-Warning 'PowerShell 5 is required for plot.ps1'
     Write-Warning 'PowerShell Excel is ready, except for that functionality'
-    }
+}
 #endregion
 function Import-Excel {
     <#
@@ -258,24 +259,24 @@ function Import-Excel {
   #>
 
     [CmdLetBinding(DefaultParameterSetName)]
-    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword","")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "")]
     Param (
         [Alias('FullName')]
-        [Parameter(ValueFromPipelineByPropertyName, ValueFromPipeline, Position=0, Mandatory)]
+        [Parameter(ValueFromPipelineByPropertyName, ValueFromPipeline, Position = 0, Mandatory)]
         [ValidateScript( {(Test-Path -Path $_ -PathType Leaf) -and ($_ -match '.xls$|.xlsx$|.xlsm$')})]
         [String]$Path,
         [Alias('Sheet')]
-        [Parameter(Position=1)]
+        [Parameter(Position = 1)]
         [ValidateNotNullOrEmpty()]
         [String]$WorksheetName,
-        [Parameter(ParameterSetName='B', Mandatory)]
+        [Parameter(ParameterSetName = 'B', Mandatory)]
         [String[]]$HeaderName ,
-        [Parameter(ParameterSetName='C', Mandatory)]
+        [Parameter(ParameterSetName = 'C', Mandatory)]
         [Switch]$NoHeader     ,
-        [Alias('HeaderRow','TopRow')]
+        [Alias('HeaderRow', 'TopRow')]
         [ValidateRange(1, 9999)]
         [Int]$StartRow = 1,
-        [Alias('StopRow','BottomRow')]
+        [Alias('StopRow', 'BottomRow')]
         [Int]$EndRow ,
         [Alias('LeftColumn')]
         [Int]$StartColumn = 1,
@@ -305,13 +306,13 @@ function Import-Excel {
                     $i = 0
                     foreach ($C in $Columns) {
                         $i++
-                        $C | Select-Object @{N='Column'; E={$_}}, @{N='Value'; E={'P' + $i}}
+                        $C | Select-Object @{N = 'Column'; E = {$_}}, @{N = 'Value'; E = {'P' + $i}}
                     }
                 }
                 elseif ($HeaderName) {
                     $i = 0
                     foreach ($H in $HeaderName) {
-                        $H | Select-Object @{N='Column'; E={$Columns[$i]}}, @{N='Value'; E={$H}}
+                        $H | Select-Object @{N = 'Column'; E = {$Columns[$i]}}, @{N = 'Value'; E = {$H}}
                         $i++
                     }
                 }
@@ -321,7 +322,7 @@ function Import-Excel {
                     }
 
                     foreach ($C in $Columns) {
-                        $Worksheet.Cells[$StartRow,$C] | Where-Object {$_.Value} | Select-Object @{N='Column'; E={$C}}, Value
+                        $Worksheet.Cells[$StartRow, $C] | Where-Object {$_.Value} | Select-Object @{N = 'Column'; E = {$C}}, Value
                     }
                 }
             }
@@ -341,8 +342,10 @@ function Import-Excel {
         Catch {throw "Could not open $Path ; $_ "}
 
         if ($Password) {
-            Try   {$Excel = New-Object -TypeName OfficeOpenXml.ExcelPackage
-                   $excel.Load( $Stream,$Password)}
+            Try {
+                $Excel = New-Object -TypeName OfficeOpenXml.ExcelPackage
+                $excel.Load( $Stream, $Password)
+            }
             Catch { throw "Could not read $Path with the provided password." }
         }
         else {
@@ -366,7 +369,7 @@ function Import-Excel {
             #If we are doing dataonly it is quicker to work out which rows to ignore before processing the cells.
             if (-not $EndRow   ) {$EndRow = $Worksheet.Dimension.End.Row    }
             if (-not $EndColumn) {$EndColumn = $Worksheet.Dimension.End.Column }
-            $endAddress = [OfficeOpenXml.ExcelAddress]::TranslateFromR1C1("R[$EndRow]C[$EndColumn]",0,0)
+            $endAddress = [OfficeOpenXml.ExcelAddress]::TranslateFromR1C1("R[$EndRow]C[$EndColumn]", 0, 0)
             if ($DataOnly) {
                 #If we are using headers startrow will be the headerrow so examine data from startRow + 1,
                 if ($NoHeader) {$range = "A" + ($StartRow     ) + ":" + $endAddress }
@@ -378,10 +381,10 @@ function Import-Excel {
                 $colHash = @{}
                 $rowHash = @{}
                 foreach ($cell in $Worksheet.Cells[$range]) {
-                     if ($null -ne $cell.Value ) {$colHash[$cell.Start.Column]=1;  $rowHash[$cell.Start.row]=1 }
+                    if ($null -ne $cell.Value ) {$colHash[$cell.Start.Column] = 1; $rowHash[$cell.Start.row] = 1 }
                 }
-                $rows    = (   $StartRow..$EndRow   ).Where({$rowHash[$_]})
-                $columns = ($StartColumn..$EndColumn).Where({$colHash[$_]})
+                $rows = (   $StartRow..$EndRow   ).Where( {$rowHash[$_]})
+                $columns = ($StartColumn..$EndColumn).Where( {$colHash[$_]})
             }
             else {
                 $Columns = $StartColumn..$EndColumn  ; if ($StartColumn -gt $EndColumn) {Write-Warning -Message "Selecting columns $StartColumn to $EndColumn might give odd results."}
@@ -455,11 +458,11 @@ function ConvertFrom-ExcelSheet {
         [String]
         $OutputPath = '.\',
         [String]
-        $SheetName="*",
-        [ValidateSet('ASCII', 'BigEndianUniCode','Default','OEM','UniCode','UTF32','UTF7','UTF8')]
+        $SheetName = "*",
+        [ValidateSet('ASCII', 'BigEndianUniCode', 'Default', 'OEM', 'UniCode', 'UTF32', 'UTF7', 'UTF8')]
         [string]
         $Encoding = 'UTF8',
-        [ValidateSet('.txt', '.log','.csv')]
+        [ValidateSet('.txt', '.log', '.csv')]
         [string]
         $Extension = '.csv',
         [ValidateSet(';', ',')]
@@ -468,7 +471,7 @@ function ConvertFrom-ExcelSheet {
     )
 
     $Path = (Resolve-Path $Path).Path
-    $stream = New-Object -TypeName System.IO.FileStream -ArgumentList $Path,"Open","Read","ReadWrite"
+    $stream = New-Object -TypeName System.IO.FileStream -ArgumentList $Path, "Open", "Read", "ReadWrite"
     $xl = New-Object -TypeName OfficeOpenXml.ExcelPackage -ArgumentList $stream
     $workbook = $xl.Workbook
 
@@ -480,8 +483,7 @@ function ConvertFrom-ExcelSheet {
     $params.Remove('Extension')
     $params.NoTypeInformation = $true
 
-    Foreach ($sheet in $targetSheets)
-    {
+    Foreach ($sheet in $targetSheets) {
         Write-Verbose "Exporting sheet: $($sheet.Name)"
 
         $params.Path = "$OutputPath\$($Sheet.Name)$Extension"
@@ -495,18 +497,18 @@ function ConvertFrom-ExcelSheet {
 }
 
 function Export-MultipleExcelSheets {
-    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword","")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "")]
     param(
-        [Parameter(Mandatory=$true)]
+        [Parameter(Mandatory = $true)]
         $Path,
-        [Parameter(Mandatory=$true)]
+        [Parameter(Mandatory = $true)]
         [hashtable]$InfoMap,
         [string]$Password,
         [Switch]$Show,
         [Switch]$AutoSize
     )
 
-    $parameters = @{}+$PSBoundParameters
+    $parameters = @{} + $PSBoundParameters
     $parameters.Remove("InfoMap")
     $parameters.Remove("Show")
 
@@ -514,12 +516,12 @@ function Export-MultipleExcelSheets {
 
     foreach ($entry in $InfoMap.GetEnumerator()) {
         Write-Progress -Activity "Exporting" -Status "$($entry.Key)"
-        $parameters.WorkSheetname=$entry.Key
+        $parameters.WorkSheetname = $entry.Key
 
         & $entry.Value | Export-Excel @parameters
     }
 
-    if($Show) {Invoke-Item $Path}
+    if ($Show) {Invoke-Item $Path}
 }
 
 Function WorksheetArgumentCompleter {
@@ -529,9 +531,9 @@ Function WorksheetArgumentCompleter {
         $xlpkg = Open-ExcelPackage -Path $xlPath
         $WorksheetNames = $xlPkg.Workbook.Worksheets.Name
         Close-ExcelPackage -nosave -ExcelPackage $xlpkg
-        $WorksheetNames.where({$_ -like "*$wordToComplete*"}) | foreach-object {
+        $WorksheetNames.where( {$_ -like "*$wordToComplete*"}) | foreach-object {
             New-Object -TypeName System.Management.Automation.CompletionResult -ArgumentList "'$_'",
-                            $_ , ([System.Management.Automation.CompletionResultType]::ParameterValue) ,$_
+            $_ , ([System.Management.Automation.CompletionResultType]::ParameterValue) , $_
         }
     }
 }