Merge remote-tracking branch 'refs/remotes/dfinke/master'

AddConditionalFormatting.ps1

@@ -0,0 +1,91 @@
+Function Add-ConditionalFormatting {
+<#
+.Synopsis
+    Adds contitional formatting to worksheet
+.Example
+    $excel = $avdata | Export-Excel -Path (Join-path $FilePath "\Machines.XLSX" ) -WorksheetName "Server Anti-Virus" -AutoSize -FreezeTopRow -AutoFilter -PassThru
+
+    Add-ConditionalFormatting -WorkSheet $excel.Workbook.Worksheets[1] -Address "b":b1048576" -ForeGroundColor "RED"     -RuleType ContainsText -ConditionValue "2003"
+    Add-ConditionalFormatting -WorkSheet $excel.Workbook.Worksheets[1] -Address "i2:i1048576" -ForeGroundColor "RED"     -RuleType ContainsText -ConditionValue "Disabled"
+    $excel.Workbook.Worksheets[1].Cells["D1:G1048576"].Style.Numberformat.Format = [cultureinfo]::CurrentCulture.DateTimeFormat.ShortDatePattern
+    $excel.Workbook.Worksheets[1].Row(1).style.font.bold = $true
+    $excel.Save() ; $excel.Dispose()
+
+    Here Export-Excel is called with the -passThru parameter so the Excel Package object is stored in $Excel
+    The desired worksheet is selected and the then columns B and i are conditially formatted (excluding the top row) to show
+    Fixed formats are then applied to dates in columns D..G and the top row is formatted
+    Finally the workbook is saved and the Excel closed.
+
+#>
+    Param (
+        #The worksheet where the format is to be applied
+        [OfficeOpenXml.ExcelWorksheet]$WorkSheet ,
+        #The area of the worksheet where the format is to be applied
+        [OfficeOpenXml.ExcelAddress]$Range ,
+        #One of the standard named rules - Top / Bottom / Less than / Greater than / Contains etc
+        [Parameter(Mandatory = $true, ParameterSetName = "NamedRule", Position = 3)]
+        [OfficeOpenXml.ConditionalFormatting.eExcelConditionalFormattingRuleType]$RuleType ,
+        #Text colour for matching objects
+        [Alias("ForeGroundColour")]
+        [System.Drawing.Color]$ForeGroundColor,
+        #colour for databar type charts
+        [Parameter(Mandatory = $true, ParameterSetName = "DataBar")]
+        [Alias("DataBarColour")]
+        [System.Drawing.Color]$DataBarColor,
+        #One of the three-icon set types (e.g. Traffic Lights)
+        [Parameter(Mandatory = $true, ParameterSetName = "ThreeIconSet")]
+        [OfficeOpenXml.ConditionalFormatting.eExcelconditionalFormatting3IconsSetType]$ThreeIconsSet,
+        #A four-icon set name
+        [Parameter(Mandatory = $true, ParameterSetName = "FourIconSet")]
+        [OfficeOpenXml.ConditionalFormatting.eExcelconditionalFormatting4IconsSetType]$FourIconsSet,
+        #A five-icon set name
+        [Parameter(Mandatory = $true, ParameterSetName = "FiveIconSet")]
+        [OfficeOpenXml.ConditionalFormatting.eExcelconditionalFormatting5IconsSetType]$FiveIconsSet,
+        #A value for the condition (e.g. "2000" if the test is 'lessthan 2000')
+        [string]$ConditionValue,
+        #A second value for the conditions like between x and Y
+        [string]$ConditionValue2,
+        #Background colour for matching items
+        [System.Drawing.Color]$BackgroundColor,
+        #Background pattern for matching items
+        [OfficeOpenXml.Style.ExcelFillStyle]$BackgroundPattern = [OfficeOpenXml.Style.ExcelFillStyle]::Solid,
+        #Secondary colour when a background pattern requires it
+        [System.Drawing.Color]$PatternColor,
+        #Sets the numeric format for matching items
+        $NumberFormat,
+        #Put matching items in bold face
+        [switch]$Bold,
+        #Put matching items in italic
+        [switch]$Italic,
+        #Underline matching items
+        [switch]$Underline,
+        #Strikethrough text of matching items
+        [switch]$StrikeThru
+    )
+
+    If ($ThreeIconsSet) {$rule = $WorkSheet.ConditionalFormatting.AddThreeIconSet($Range , $ThreeIconsSet)}
+    elseif ($FourIconsSet) {$rule = $WorkSheet.ConditionalFormatting.AddFourIconSet( $Range , $FourIconsSet) }
+    elseif ($FiveIconsSet) {$rule = $WorkSheet.ConditionalFormatting.AddFiveIconSet( $Range , $IconType)     }
+    elseif ($DataBarColor) {$rule = $WorkSheet.ConditionalFormatting.AddDatabar(     $Range , $DataBarColor) }
+    else {                  $rule = ($WorkSheet.ConditionalFormatting)."Add$RuleType"($Range)}
+
+    if ($ConditionValue -and $RuleType -match "Top|Botom") {$rule.Rank = $ConditionValue }
+    if ($ConditionValue -and $RuleType -match "StdDev") {$rule.StdDev = $ConditionValue }
+    if ($ConditionValue -and $RuleType -match "Than|Equal|Expression") {$rule.Formula = $ConditionValue }
+    if ($ConditionValue -and $RuleType -match "Text|With") {$rule.Text = $ConditionValue }
+    if ($ConditionValue -and
+        $ConditionValue2 -and $RuleType -match "Between") {
+        $rule.Formula = $ConditionValue
+        $rule.Formula2 = $ConditionValue2
+    }
+
+    if ($NumberFormat) {$rule.Style.NumberFormat.Format = $NumberFormat }
+    if ($Underline) {$rule.Style.Font.Underline = [OfficeOpenXml.Style.ExcelUnderLineType]::Single }
+    if ($Bold) {$rule.Style.Font.Bold = $true}
+    if ($Italic) {$rule.Style.Font.Italic = $true}
+    if ($StrikeThru) {$rule.Style.Font.Strike = $true}
+    if ($ForeGroundColor) {$rule.Style.Font.Color.color = $ForeGroundColor   }
+    if ($BackgroundColor) {$rule.Style.Fill.BackgroundColor.color = $BackgroundColor   }
+    if ($BackgroundPattern) {$rule.Style.Fill.PatternType = $BackgroundPattern }
+    if ($PatternColor) {$rule.Style.Fill.PatternColor.color = $PatternColor      }
+}

ColorCompletion.ps1

@@ -0,0 +1,16 @@
+Function ColorCompletion {
+    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
+    [System.Drawing.KnownColor].GetFields() | Where-Object {$_.IsStatic -and $_.name -like "$wordToComplete*" } |
+        Sort-Object name | ForEach-Object {New-CompletionResult $_.name $_.name
+    }
+}
+
+if (Get-Command -Name register-argumentCompleter -ErrorAction SilentlyContinue) {
+    Register-ArgumentCompleter -CommandName Export-Excel               -ParameterName TitleBackgroundColor -ScriptBlock $Function:ColorCompletion
+    Register-ArgumentCompleter -CommandName Add-ConditionalFormatting  -ParameterName ForeGroundColor      -ScriptBlock $Function:ColorCompletion
+    Register-ArgumentCompleter -CommandName Add-ConditionalFormatting  -ParameterName DataBarColor         -ScriptBlock $Function:ColorCompletion
+    Register-ArgumentCompleter -CommandName Add-ConditionalFormatting  -ParameterName BackgroundColor      -ScriptBlock $Function:ColorCompletion
+    Register-ArgumentCompleter -CommandName Set-Format                 -ParameterName FontColor            -ScriptBlock $Function:ColorCompletion
+    Register-ArgumentCompleter -CommandName Set-Format                 -ParameterName BackgroundColor      -ScriptBlock $Function:ColorCompletion
+    Register-ArgumentCompleter -CommandName Set-Format                 -ParameterName PatternColor         -ScriptBlock $Function:ColorCompletion
+}

Export-Excel.ps1

@@ -321,8 +321,8 @@
 
     [CmdletBinding(DefaultParameterSetName = 'Default')]
     Param(
-        [Parameter(Mandatory=$true,ParameterSetName="Default",Position=0)] 
-        [Parameter(Mandatory=$true,ParameterSetName="Table"  ,Position=0)] 
+        [Parameter(ParameterSetName="Default",Position=0)]
+        [Parameter(ParameterSetName="Table"  ,Position=0)]
         [String]$Path,
         [Parameter(Mandatory=$true,ParameterSetName="PackageDefault")]
         [Parameter(Mandatory=$true,ParameterSetName="PackageTable")]
@@ -395,6 +395,8 @@
         [Object[]]$ConditionalFormat,
         [Object[]]$ConditionalText,
         [ScriptBlock]$CellStyleSB,
+        [Parameter(ParameterSetName = 'Now')]
+        # [Parameter(ParameterSetName = 'TableNow')]
         [Switch]$Now
     )
 
@@ -530,7 +532,7 @@
                 Stop-ExcelProcess
             }
 
-            if ($Now) {
+            if ($PSBoundParameters.Keys.Count -eq 0 -Or $Now) {
                 $Path = [System.IO.Path]::GetTempFileName() -replace '\.tmp', '.xlsx'
                 $Show = $true
                 $AutoSize = $true
@@ -760,7 +762,7 @@
                             }
 
                             $chart = $wsPivot.Drawings.AddChart('PivotChart', $ChartType, $pivotTable)
-                            $chart.SetPosition(0, 0, 2, 0)  #Changed position to top row, next to a chart which doesn't pivot on columns
+                            $chart.SetPosition(0, 0, 4, 0)  #Changed position to top row, next to a chart which doesn't pivot on columns
                             $chart.SetSize(600, 400)
                         }
                     }
@@ -813,7 +815,7 @@
                     $chart = $wsPivot.Drawings.AddChart('PivotChart', $ChartType, $pivotTable)
                     $chart.DataLabel.ShowCategory = $ShowCategory
                     $chart.DataLabel.ShowPercent = $ShowPercent
-                    $chart.SetPosition(0,0,2,0)  # if Pivot table is rows+data only it will be 2 columns wide if has pivot columns we don't know how wide it will be 
+                    $chart.SetPosition(0,26,2,26)  # if Pivot table is rows+data only it will be 2 columns wide if has pivot columns we don't know how wide it will be
                     if ($NoLegend) {
                         $chart.Legend.Remove()
                     }

ImportExcel.psm1

@@ -1,13 +1,14 @@
 Add-Type -Path "$($PSScriptRoot)\EPPlus.dll"
 
+. $PSScriptRoot\AddConditionalFormatting.ps1
 . $PSScriptRoot\Charting.ps1
+. $PSScriptRoot\ColorCompletion.ps1
 . $PSScriptRoot\ConvertFromExcelData.ps1
 . $PSScriptRoot\ConvertFromExcelToSQLInsert.ps1
 . $PSScriptRoot\ConvertToExcelXlsx.ps1
 . $PSScriptRoot\Copy-ExcelWorkSheet.ps1
 . $PSScriptRoot\Export-Excel.ps1
 . $PSScriptRoot\Export-ExcelSheet.ps1
-. $PSScriptRoot\Formatting.ps1
 . $PSScriptRoot\Get-ExcelColumnName.ps1
 . $PSScriptRoot\Get-ExcelSheetInfo.ps1
 . $PSScriptRoot\Get-ExcelWorkbookInfo.ps1
@@ -24,11 +25,10 @@
 . $PSScriptRoot\Open-ExcelPackage.ps1
 . $PSScriptRoot\Pivot.ps1
 . $PSScriptRoot\Set-CellStyle.ps1
+. $PSScriptRoot\SetFormat.ps1
 . $PSScriptRoot\TrackingUtils.ps1
 . $PSScriptRoot\Update-FirstObjectProperties.ps1
 
-
-
 if ($PSVersionTable.PSVersion.Major -ge 5) {
     . $PSScriptRoot\Plot.ps1
 

InstallModule.ps1

@@ -22,13 +22,17 @@ Begin {
             '*.dll',
             '*.psd1',
             '*.psm1',
+            'AddConditionalFormatting.ps1',
             'Charting.ps1',
+            'ColorCompletion.ps1',
             'ConvertFromExcelData.ps1',
             'ConvertFromExcelToSQLInsert.ps1',
             'ConvertToExcelXlsx.ps1',
             'Copy-ExcelWorkSheet.ps1',
+            'Export-Charts.ps1',
             'Export-Excel.ps1',
             'Export-ExcelSheet.ps1',
+            'formatting.ps1',
             'Get-ExcelColumnName.ps1',
             'Get-ExcelSheetInfo.ps1',
             'Get-ExcelWorkbookInfo.ps1',
@@ -38,13 +42,15 @@ Begin {
             'Import-Html.ps1',
             'InferData.ps1',
             'Invoke-Sum.ps1',
-            'New-ConditionalText.ps1',
             'New-ConditionalFormattingIconSet.ps1',
+            'New-ConditionalText.ps1',
             'New-ExcelChart.ps1',
             'New-PSItem.ps1',
+            'Open-ExcelPackage.ps1',
             'Pivot.ps1',
             'Plot.ps1',
             'Set-CellStyle.ps1',
+            'SetFormat.ps1',
             'TrackingUtils.ps1',
             'Update-FirstObjectProperties.ps1'
         )

README.md

@@ -27,6 +27,30 @@ iex (new-object System.Net.WebClient).DownloadString('https://raw.github.com/dfi
 ```
 
 # What's new
+#### 10/30/2017
+Huge thanks to [James O'Neill](https://twitter.com/jamesoneill). PowerShell aficionado. He always brings a flare when working with PowerShell. This is no exception.
+
+(Check out the examples `help Export-Excel -Examples`)
+
+* New parameter `Package` allows an ExcelPackage object returned by `-passThru` to be passed in
+* New parameter `ExcludeProperty` to remove unwanted properties without needing to go through `select-object`
+* New parameter `Append` code to read the existing headers and move the insertion point below the current data
+* New parameter `ClearSheet`  which removes the worksheet and any past data
+
+* Remove any existing Pivot table before trying to [re]create it
+* Check for inserting a pivot table so if `-InsertPivotChart` is specified it implies `-InsertPivotTable`
+
+(Check out the examples `help Export-Excel -Examples`)
+
+* New function `Export-Charts` (requires Excel to be installed) - Export Excel charts out as JPG files
+* New function `Add-ConditionalFormatting` Adds contitional formatting to worksheet
+* New function `Set-Format` Applies Number, font, alignment and colour formatting to a range of Excel Cells
+* `ColorCompletion` an argument completer for `Colors` for params across functions
+
+I also worked out the parameters so you can do this, which is the same as passing `-Now`. It creates an Excel file name for you, does an auto fit and sets up filters.
+
+`ps | select Company, Handles | Export-Excel`
+
 #### 10/13/2017
 Added `New-PivotTableDefinition`. You can create and wire up a PivotTable to a WorkSheet. You can also create as many PivotTable Worksheets to point a one Worksheet. Or, you create many Worksheets and many corresponding PivotTable Worksheets.
 

SetFormat.ps1

@@ -0,0 +1,129 @@
+Function Set-Format {
+<#
+.SYNOPSIS
+    Applies Number, font, alignment and colour formatting to a range of Excel Cells
+.EXAMPLE
+    $sheet.Column(3) | Set-Format -HorizontalAlignment Right -NumberFormat "#,###"
+    Selects column 3 from a sheet object (within a workbook object, which is a child of the ExcelPackage object) and passes it to Set-Format which formats as an integer with comma seperated groups
+.EXAMPLE
+    Set-Format -Address $sheet.Cells["E1:H1048576"]  -HorizontalAlignment Right -NumberFormat "#,###"
+    Instead of piping the address in this version specifies a block of cells and applies similar formatting
+
+#>
+    Param   (
+        #One or more row(s), Column(s) and/or block(s) of cells to format
+        [Parameter(ValueFromPipeline = $true)]
+        [object[]]$Address ,
+        #Number format to apply to cells e.g. "dd/MM/yyyy HH:mm", "£#,##0.00;[Red]-£#,##0.00", "0.00%" , "##/##" , "0.0E+0" etc
+        [Alias("NFormat")]
+        $NumberFormat,
+        #Style of border to draw around the range
+        [OfficeOpenXml.Style.ExcelBorderStyle]$BorderAround,
+        #Colour for the text - if none specified it will be left as it it is
+        [System.Drawing.Color]$FontColor,
+        #Clear Bold, Italic, StrikeThrough and Underline and set colour to black
+        [switch]$ResetFont,
+        #Make text bold
+        [switch]$Bold,
+        #Make text italic
+        [switch]$Italic,
+        #Underline the text using the underline style in -underline type
+        [switch]$Underline,
+        #Should Underline use single or double, normal or accounting mode : default is single normal
+        [OfficeOpenXml.Style.ExcelUnderLineType]$UnderLineType = [OfficeOpenXml.Style.ExcelUnderLineType]::Single,
+        #StrikeThrough text
+        [switch]$StrikeThru,
+        #Subscript or superscript
+        [OfficeOpenXml.Style.ExcelVerticalAlignmentFont]$FontShift,
+        #Font to use - Excel defaults to Calibri
+        [String]$FontName,
+        #Point size for the text
+        [float]$FontSize,
+        #Change background colour
+        [System.Drawing.Color]$BackgroundColor,
+        #Background pattern - solid by default
+        [OfficeOpenXml.Style.ExcelFillStyle]$BackgroundPattern = [OfficeOpenXml.Style.ExcelFillStyle]::Solid ,
+        #Secondary colour for background pattern
+        [Alias("PatternColour")]
+        [System.Drawing.Color]$PatternColor,
+        #Turn on text wrapping
+        [switch]$WrapText,
+        #Position cell contents to left, right or centre ...
+        [OfficeOpenXml.Style.ExcelHorizontalAlignment]$HorizontalAlignment,
+        #Position cell contents to top bottom or centre
+        [OfficeOpenXml.Style.ExcelVerticalAlignment]$VerticalAlignment,
+        #Degrees to rotate text. Up to +90 for anti-clockwise ("upwards"), or to -90 for clockwise.
+        [ValidateRange(-90, 90)]
+        [int]$TextRotation ,
+        #Autofit cells to width  (columns or ranges only)
+        [switch]$AutoFit,
+        #Set cells to a fixed width (columns or ranges only), ignored if Autofit is specified
+        [float]$Width,
+        #Set cells to a fixed hieght  (rows or ranges only)
+        [float]$Height,
+        #Hide a row or column  (not a range)
+        [switch]$Hidden
+    )
+    process {
+        Foreach ($range in $Address) {
+            if ($ResetFont) {
+                $Range.Style.Font.Color.SetColor("Black")
+                $Range.Style.Font.Bold = $false
+                $Range.Style.Font.Italic = $false
+                $Range.Style.Font.UnderLine = $false
+                $Range.Style.Font.Strike = $falsee
+            }
+            if ($Underline) {
+                $Range.Style.Font.UnderLine = $true
+                $Range.Style.Font.UnderLineType = $UnderLineType
+            }
+            if ($Bold) {$Range.Style.Font.Bold = $true                }
+            if ($Italic) {$Range.Style.Font.Italic = $true                }
+            if ($StrikeThru) {$Range.Style.Font.Strike = $true                }
+            if ($FontShift) {$Range.Style.Font.VerticalAlign = $FontShift           }
+            if ($FontColor) {$Range.Style.Font.Color.SetColor( $FontColor    )      }
+            if ($BorderRound) {$Range.Style.Border.BorderAround( $BorderAround )      }
+            if ($NumberFormat) {$Range.Style.Numberformat.Format = $NumberFormat        }
+            if ($TextRotation) {$Range.Style.TextRotation = $TextRotation        }
+            if ($WrapText) {$Range.Style.WrapText = $true                }
+            if ($HorizontalAlignment) {$Range.Style.HorizontalAlignment = $HorizontalAlignment }
+            if ($VerticalAlignment) {$Range.Style.VerticalAlignment = $VerticalAlignment   }
+
+            if ($BackgroundColor) {
+                $Range.Style.Fill.PatternType = $BackgroundPattern
+                $Range.Style.Fill.BackgroundColor.SetColor($BackgroundColor)
+                if ($PatternColor) {
+                    $range.Style.Fill.PatternColor.SetColor( $PatternColor)
+                }
+            }
+
+            if ($Height) {
+                if ($Range -is [OfficeOpenXml.ExcelRow]   ) {$Range.Height = $Height }
+                elseif ($Range -is [OfficeOpenXml.ExcelRange] ) {
+                    ($range.Start.Row)..($range.Start.Row + $range.Rows) |
+                        ForEach-Object {$ws.Row($_).Height = $Height }
+                }
+                else {Write-Warning -Message ("Can set the height of a row or a range but not a {0} object" -f ($Range.GetType().name)) }
+            }
+            if ($AutoFit) {
+                if ($Range -is [OfficeOpenXml.ExcelColumn]) {$Range.AutoFit() }
+                elseif ($Range -is [OfficeOpenXml.ExcelRange] ) {$Range.AutoFitColumns() }
+                else {Write-Warning -Message ("Can autofit a column or a range but not a {0} object" -f ($Range.GetType().name)) }
+
+            }
+            elseif ($Width) {
+                if ($Range -is [OfficeOpenXml.ExcelColumn]) {$Range.Width = $Width}
+                elseif ($Range -is [OfficeOpenXml.ExcelRange] ) {
+                    ($range.Start.Column)..($range.Start.Column + $range.Columns) |
+                        ForEach-Object {$ws.Column($_).Width = $Width}
+                }
+                else {Write-Warning -Message ("Can set the width of a column or a range but not a {0} object" -f ($Range.GetType().name)) }
+            }
+            if ($Hidden) {
+                if ($Range -is [OfficeOpenXml.ExcelRow] -or
+                    $Range -is [OfficeOpenXml.ExcelColumn]  ) {$Range.Hidden = $True}
+                else {Write-Warning -Message ("Can hide a row or a column but not a {0} object" -f ($Range.GetType().name)) }
+            }
+        }
+    }
+}