Compare commits

..

35 Commits

Author SHA1 Message Date
dfinke
df49e04c6c tweak readme 2018-10-03 08:38:58 -04:00
dfinke
f60ca87358 bumped version 2018-10-03 08:34:45 -04:00
dfinke
cef95f9ebe Added to the readme 2018-10-03 08:34:31 -04:00
Doug Finke
288071035f Merge pull request #450 from jhoneill/master
Readme only
2018-10-03 08:25:31 -04:00
jhoneill
414d1ac72b Git Markup stuck in Readme 2018-10-03 12:05:01 +01:00
jhoneill
1c7241774f Three extra lines in readme.md 2018-10-03 10:55:54 +01:00
jhoneill
7c773ff915 Three extra lines in Readme.MD 2018-10-03 10:54:15 +01:00
jhoneill
46de6c5934 Two extra lines in Readme.MD 2018-10-03 10:47:04 +01:00
Doug Finke
955c737bb7 Merge pull request #449 from jhoneill/master
Fix for bug handling null and zero; date format applied in send-sql
2018-10-02 16:58:22 -04:00
jhoneill
74e5fee161 Fixed bugs relating to handling of null. zero and empty string as data. 2018-10-02 21:15:16 +01:00
Doug Finke
c3331e8f09 Merge pull request #446 from lazywinadmin/master
Expand a few aliases
2018-10-01 20:18:42 -04:00
François-Xavier Cat
1951a61699 Expand a few aliases 2018-10-01 17:01:15 -07:00
jhoneill
5b29ccd9c2 Send-SQLDataToExcel applies formatting to date fields. 2018-09-30 22:49:35 +01:00
Doug Finke
d8bd5a8cb6 Merge pull request #444 from jhoneill/master
Minor improvements
2018-09-28 17:42:45 -04:00
Doug Finke
820722b481 Merge branch 'master' into master 2018-09-28 17:40:58 -04:00
Doug Finke
08c82977f5 Merge pull request #442 from dfinke/RenameToLegendPosition
Renamed LegendPostion to LegendPosition
2018-09-28 17:33:40 -04:00
jhoneill
a2dd42fc80 Blitz on spelling mistakes in help. Still not 100% proof-read. 2018-09-28 12:07:22 +01:00
jhoneill
c1d778ef85 Readme update 2018-09-27 15:05:07 +01:00
jhoneill
7abb5dde89 Updates to help text (more proof reading still needed) 2018-09-27 14:55:21 +01:00
jhoneill
0f15f3e3e5 fixed incorrect range in chart test 2018-09-27 12:26:43 +01:00
jhoneill
3194bb0ee4 Merge branch 'master' of https://github.com/jhoneill/ImportExcel 2018-09-27 12:24:31 +01:00
jhoneill
b1f716f0d5 Better handling of autonamerange including piping columns to Set-Column to do multiple ranges. 2018-09-27 12:24:23 +01:00
jhoneill
a8f7a13248 Better handling of autonamerange including piping columns to Set-Column to do multiple ranges. 2018-09-27 12:00:01 +01:00
dfinke
d200a2929b Added Azure-DevOps build tag 2018-09-26 18:47:58 -04:00
dfinke
99e69bd6c0 Renamed LegendPostion to LegendPosition 2018-09-26 16:32:10 -04:00
dfinke
4f0c0d7c28 bumped, fix for aliases 2018-09-20 13:58:13 -04:00
Doug Finke
968d5a57b6 Merge pull request #438 from dfinke/TestFunctionAliases
Added ps1 to for testing aliases
2018-09-20 12:33:06 -04:00
dfinke
bdefb45095 Remove space from Alias attribute 2018-09-20 12:12:53 -04:00
dfinke
4297d2ef82 Confirms the errors 2018-09-20 12:09:19 -04:00
dfinke
a49bdb3abc Added ps1 to for testing aliases 2018-09-20 12:01:34 -04:00
dfinke
a983ecd765 Move to using Robocopy and the /mir flag 2018-09-20 11:44:53 -04:00
dfinke
5a7d84e624 Added comment for usage 2018-09-20 10:22:36 -04:00
dfinke
e0f5d9f789 Removed these files - look unused 2018-09-20 10:22:27 -04:00
dfinke
7d3bcb810c bumped build # 2018-09-20 09:25:14 -04:00
dfinke
8975aa2e95 Added PivotTable.ps1 2018-09-20 09:24:50 -04:00
41 changed files with 899 additions and 777 deletions

View File

@@ -1,7 +1,7 @@
Function Add-ConditionalFormatting { Function Add-ConditionalFormatting {
<# <#
.Synopsis .Synopsis
Adds contitional formatting to worksheet. Adds conditional formatting to worksheet.
.Description .Description
Conditional formatting allows excel to Conditional formatting allows excel to
* Mark cells with Icons depending on their value * Mark cells with Icons depending on their value
@@ -20,7 +20,7 @@
$excel.Save() ; $excel.Dispose() $excel.Save() ; $excel.Dispose()
Here Export-Excel is called with the -passThru parameter so the Excel Package object is stored in $Excel 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 red text if The desired worksheet is selected and the then columns" B" and "I" are conditionally formatted (excluding the top row) to show red text if
the columns contain "2003" or "Disabled respectively. A fixed date format is then applied to columns D..G, and the top row is formatted. the columns contain "2003" or "Disabled respectively. A fixed date format is then applied to columns D..G, and the top row is formatted.
Finally the workbook is saved and the Excel object closed. Finally the workbook is saved and the Excel object closed.
.Example .Example
@@ -31,7 +31,7 @@
Again Export-Excel has been called with -passthru leaving a package object in $Excel Again Export-Excel has been called with -passthru leaving a package object in $Excel
This time B1:B100 has been conditionally formatted with 3 icons, using the flags icon set. This time B1:B100 has been conditionally formatted with 3 icons, using the flags icon set.
Add-ConditionalFormatting does not provide access to every option in the formatting rule, so passthru has been used and the Add-ConditionalFormatting does not provide access to every option in the formatting rule, so passthru has been used and the
rule is to apply the flags in reverse order, and boundaries for the number which will set the split are set to 100 and 1000 rule is modified to apply the flags in reverse order, and boundaries for the number which will set the split are set to 100 and 1000
.Example .Example
Add-ConditionalFormatting -WorkSheet $sheet -Range "D2:D1048576" -DataBarColor Red Add-ConditionalFormatting -WorkSheet $sheet -Range "D2:D1048576" -DataBarColor Red
@@ -39,8 +39,8 @@
.Example .Example
Add-ConditionalFormatting -Address $worksheet.cells["FinishPosition"] -RuleType Equal -ConditionValue 1 -ForeGroundColor Purple -Bold -Priority 1 -StopIfTrue Add-ConditionalFormatting -Address $worksheet.cells["FinishPosition"] -RuleType Equal -ConditionValue 1 -ForeGroundColor Purple -Bold -Priority 1 -StopIfTrue
In this example a named range is used to select the cells where the formula should apply. If a cell in the "FinishPosition" range is 1, then the text is turned to puple, boldface. In this example a named range is used to select the cells where the formula should apply. If a cell in the "FinishPosition" range is 1, then the text is turned to Bold & Purple.
This rule is move to first in the priority list, and where cells have a value of 1, no other rules will be processed. This rule is moved to first in the priority list, and where cells have a value of 1, no other rules will be processed.
#> #>
Param ( Param (
#A block of cells to format - you can use a named range with -Address $ws.names[1] or $ws.cells["RangeName"] #A block of cells to format - you can use a named range with -Address $ws.names[1] or $ws.cells["RangeName"]
@@ -49,14 +49,14 @@
$Address , $Address ,
#The worksheet where the format is to be applied #The worksheet where the format is to be applied
[OfficeOpenXml.ExcelWorksheet]$WorkSheet , [OfficeOpenXml.ExcelWorksheet]$WorkSheet ,
#One of the standard named rules - Top / Bottom / Less than / Greater than / Contains etc. #A standard named-rule - Top / Bottom / Less than / Greater than / Contains etc.
[Parameter(Mandatory = $true, ParameterSetName = "NamedRule", Position = 1)] [Parameter(Mandatory = $true, ParameterSetName = "NamedRule", Position = 1)]
[OfficeOpenXml.ConditionalFormatting.eExcelConditionalFormattingRuleType]$RuleType , [OfficeOpenXml.ConditionalFormatting.eExcelConditionalFormattingRuleType]$RuleType ,
#Text colour for matching objects #Text colour for matching objects
[Parameter(ParameterSetName = "NamedRule")] [Parameter(ParameterSetName = "NamedRule")]
[Alias("ForeGroundColour")] [Alias("ForeGroundColour")]
[System.Drawing.Color]$ForeGroundColor, [System.Drawing.Color]$ForeGroundColor,
#colour for databar type charts #Colour for databar type charts
[Parameter(Mandatory = $true, ParameterSetName = "DataBar")] [Parameter(Mandatory = $true, ParameterSetName = "DataBar")]
[Alias("DataBarColour")] [Alias("DataBarColour")]
[System.Drawing.Color]$DataBarColor, [System.Drawing.Color]$DataBarColor,
@@ -75,7 +75,7 @@
[Parameter(ParameterSetName = "FourIconSet")] [Parameter(ParameterSetName = "FourIconSet")]
[Parameter(ParameterSetName = "FiveIconSet")] [Parameter(ParameterSetName = "FiveIconSet")]
[switch]$Reverse, [switch]$Reverse,
#A value for the condition (e.g. 2000 if the test is 'lessthan 2000' ; Formulas should begin with "=" ) #A value for the condition (for example 2000 if the test is 'lessthan 2000'; Formulas should begin with "=" )
[Parameter(ParameterSetName = "NamedRule")] [Parameter(ParameterSetName = "NamedRule")]
$ConditionValue, $ConditionValue,
#A second value for the conditions like "between x and Y" #A second value for the conditions like "between x and Y"
@@ -108,7 +108,7 @@
#Prevent the processing of subsequent rules #Prevent the processing of subsequent rules
[Parameter(ParameterSetName = "NamedRule")] [Parameter(ParameterSetName = "NamedRule")]
[switch]$StopIfTrue, [switch]$StopIfTrue,
#Set the sequence for rule processong #Set the sequence for rule processing
[int]$Priority, [int]$Priority,
#If specified pass the rule back to the caller to allow additional customization. #If specified pass the rule back to the caller to allow additional customization.
[switch]$Passthru [switch]$Passthru

View File

@@ -15,6 +15,7 @@ if (Get-Command -Name register-argumentCompleter -ErrorAction SilentlyContinue)
Register-ArgumentCompleter -CommandName Compare-Worksheet -ParameterName BackgroundColor -ScriptBlock $Function:ColorCompletion Register-ArgumentCompleter -CommandName Compare-Worksheet -ParameterName BackgroundColor -ScriptBlock $Function:ColorCompletion
Register-ArgumentCompleter -CommandName Compare-Worksheet -ParameterName FontColor -ScriptBlock $Function:ColorCompletion Register-ArgumentCompleter -CommandName Compare-Worksheet -ParameterName FontColor -ScriptBlock $Function:ColorCompletion
Register-ArgumentCompleter -CommandName Compare-Worksheet -ParameterName TabColor -ScriptBlock $Function:ColorCompletion Register-ArgumentCompleter -CommandName Compare-Worksheet -ParameterName TabColor -ScriptBlock $Function:ColorCompletion
Register-ArgumentCompleter -CommandName Join-Worksheet -ParameterName TitleBackgroundColor -ScriptBlock $Function:ColorCompletion
Register-ArgumentCompleter -CommandName Merge-Worksheet -ParameterName AddBackgroundColor -ScriptBlock $Function:ColorCompletion Register-ArgumentCompleter -CommandName Merge-Worksheet -ParameterName AddBackgroundColor -ScriptBlock $Function:ColorCompletion
Register-ArgumentCompleter -CommandName Merge-Worksheet -ParameterName ChangeBackgroundColor -ScriptBlock $Function:ColorCompletion Register-ArgumentCompleter -CommandName Merge-Worksheet -ParameterName ChangeBackgroundColor -ScriptBlock $Function:ColorCompletion
Register-ArgumentCompleter -CommandName Merge-Worksheet ` -ParameterName DeleteBackgroundColor -ScriptBlock $Function:ColorCompletion Register-ArgumentCompleter -CommandName Merge-Worksheet ` -ParameterName DeleteBackgroundColor -ScriptBlock $Function:ColorCompletion
@@ -36,4 +37,5 @@ if (Get-Command -Name register-argumentCompleter -ErrorAction SilentlyContinue)
Register-ArgumentCompleter -CommandName Set-ExcelRow -ParameterName BackgroundColor -ScriptBlock $Function:ColorCompletion Register-ArgumentCompleter -CommandName Set-ExcelRow -ParameterName BackgroundColor -ScriptBlock $Function:ColorCompletion
Register-ArgumentCompleter -CommandName Set-ExcelRow -ParameterName FontColor -ScriptBlock $Function:ColorCompletion Register-ArgumentCompleter -CommandName Set-ExcelRow -ParameterName FontColor -ScriptBlock $Function:ColorCompletion
Register-ArgumentCompleter -CommandName Set-ExcelRow -ParameterName PatternColor -ScriptBlock $Function:ColorCompletion Register-ArgumentCompleter -CommandName Set-ExcelRow -ParameterName PatternColor -ScriptBlock $Function:ColorCompletion
} }

View File

@@ -1,3 +1,7 @@
##
# Used in Appveyor.yml
##
$PSVersionTable.PSVersion $PSVersionTable.PSVersion
## Create the zip before the tests run ## Create the zip before the tests run

View File

@@ -1,5 +1,5 @@
echo Last7Days LastMonth LastWeek NextMonth NextWeek ThisMonth ThisWeek Today Tomorrow Yesterday | echo Last7Days LastMonth LastWeek NextMonth NextWeek ThisMonth ThisWeek Today Tomorrow Yesterday |
% { Foreach-Object {
$text = @" $text = @"
`$f = ".\testExport.xlsx" `$f = ".\testExport.xlsx"

View File

@@ -8,7 +8,7 @@
$sign=@{sign=echo + -} $sign=@{sign=echo + -}
$location=@{location=echo Atlanta Newark Washington Chicago Philadelphia Houston Phoneix} $location=@{location=echo Atlanta Newark Washington Chicago Philadelphia Houston Phoneix}
$(1..6 | % { $(1..6 | Foreach-Object {
$from=$to="" $from=$to=""
while($from -eq $to) { while($from -eq $to) {

View File

@@ -1,15 +1,41 @@
Remove-item -path ~\documents\music.xlsx #requires -modules "Get-IndexedItem"
$excel = Get-IndexedItem "itemtype='.mp3'","AlbumArtist like '%'","RatingText <> '1 star'" -NoFiles -orderby AlbumArtist,AlbumTitle,TrackNumber -path c:\users -Recurse -Property AlbumArtist,Duration,title,EncodingBitrate,SampleRate,AlbumTitle,TrackNumber, Size | [cmdletbinding()]
Select-Object -Property AlbumArtist, AlbumTitle, TrackNumber, Title, Duration, SampleRate, EncodingBitRate, Size | Export-excel -path ~\documents\music.xlsx -WorksheetName Music -AutoNameRange -AutoSize -BoldTopRow -FreezeTopRow -PassThru Param()
$ws = $excel.Workbook.Worksheets[1] Remove-Item ~\documents\music.xlsx -ErrorAction SilentlyContinue
Set-ExcelColumn -Worksheet $ws -Column 6 -NumberFormat '0,"KHz"' [System.Diagnostics.Stopwatch]$stopwatch = [System.Diagnostics.Stopwatch]::StartNew()
Set-ExcelColumn -Worksheet $ws -Column 7 -NumberFormat '0,"Kbits/Sec"' -Width 18
Set-ExcelColumn -Worksheet $ws -Column 8 -NumberFormat '#.#,,"MB"' -Width 7
$pt = Add-PivotTable -PivotTableName SpaceUsedByMusic -ExcelPackage $excel -SourceWorkSheet $ws -PivotRows ALBUMARTIST -PivotData @{"Size"="Sum"} -PivotNumberFormat '#.#,,"MB"' -Activate -PassThru
$pt.RowFields[0].Sort = [OfficeOpenXml.Table.PivotTable.eSortType]::Ascending
$a = $ws.Dimension.address #Query system index for .MP3 files in C:\Users, where album artist is non-blank. Leave sorted table with columns of interest in $Music.
Add-ExcelTable -Range $ws.cells[$a] -TableStyle Light1 -TableName Musictable -ShowFilter:$false -ShowTotal -ShowFirstColumn
Add-ConditionalFormatting -Address $ws.Names[1] -RuleType ContainsText -ConditionValue "Hits" -ForeGroundColor Blue Get-IndexedItem "itemtype='.mp3'","AlbumArtist like '%'" -Recurse C:\Users -OutputVariable Music `
Add-ConditionalFormatting -Address $ws.Cells["Albumartist"] -RuleType ContainsText -ConditionValue "Numan" -ForeGroundColor red -OrderBy AlbumArtist, AlbumTitle, TrackNumber, Title -NoFiles `
Close-ExcelPackage -show $excel -Property AlbumArtist, AlbumTitle, TrackNumber, Title, Duration, Size, SampleRate
Write-Verbose -Message ("Fetched " + $music.Rows.Count + " rows from index: " + $stopwatch.Elapsed.TotalSeconds)
#Send Table in $Music to Excel, format as a table, point $ws to the Worksheet
$excel = Send-SQLDataToExcel -Path ~\documents\music.xlsx -DataTable $music -WorkSheetname Music -TableName Music -Passthru
Write-Verbose -Message ("Inserted into Excel: " + $stopwatch.Elapsed.TotalSeconds)
$ws = $excel.Music
#Strip "SYSTEM.", "SYSTEM.AUDIO", "SYSTEM.MEDIA", "SYSTEM.MUSIC" from the column headings
#Convert Duration (column 5) from 100ns ticks to days and format as minutes, seconds, decimal
#Format filesize and sample rate nicely
#Autofit the columns.
Set-ExcelRow -Worksheet $ws -Row 1 -Value {($worksheet.cells[$row,$column].value -replace '^SYSTEM\.','') -replace '^MEDIA\.|^AUDIO\.|^MUSIC\.','' }
Set-ExcelColumn -Worksheet $ws -Column 5 -NumberFormat 'mm:ss.0' -StartRow 2 -Value {$worksheet.cells[$row,$column].value / 864000000000 }
Write-Verbose -Message ("Cells Reset: " + $stopwatch.Elapsed.TotalSeconds)
Set-Column -Worksheet $ws -Column 6 -NumberFormat '#.#,,"MB"'
Set-ExcelColumn -Worksheet $ws -Column 7 -NumberFormat '0.0,"KHz"'
$ws.Cells[$ws.Dimension].AutoFitColumns()
#Make a Pivot table for sum of space and count of tracks by artist. Sort by artist, apply formatting to space, give it nice titles.
$pt = Add-PivotTable -PassThru -PivotTableName SpaceUsedByMusic -ExcelPackage $excel -SourceWorkSheet $ws `
-PivotRows ALBUMARTIST -PivotData ([ordered]@{"Size"="Sum"; "Duration"="Count"}) -PivotDataToColumn
$pt.RowFields[0].Sort = [OfficeOpenXml.Table.PivotTable.eSortType]::Ascending
$pt.DataFields[0].Format = '#.0,,"MB"'
$pt.DataFields[0].Name = 'Space Used'
$pt.DataFields[1].Name = 'Tracks'
#Save the file, and load it into Excel
$stopwatch.Stop()
Write-Verbose -Message ("Pivot Done: " + $stopwatch.Elapsed.TotalSeconds)
Close-ExcelPackage -show $excel

View File

@@ -21,6 +21,6 @@ Add-PivotTable -Address $excel.Sheet1.Cells["F1"] -SourceWorkSheet $Excel.Sheet1
ChartType="ColumnClustered"; ChartType="ColumnClustered";
Column=11; Width=500; Height=360; Column=11; Width=500; Height=360;
YMajorUnit=500; YMinorUnit=100; YAxisNumberformat="$#,##0" YMajorUnit=500; YMinorUnit=100; YAxisNumberformat="$#,##0"
LegendPostion="Bottom"} LegendPosition="Bottom"}
#Save and open in excel #Save and open in excel
Close-ExcelPackage $excel -Show Close-ExcelPackage $excel -Show

View File

@@ -1,6 +1,6 @@
try {. $PSScriptRoot\..\..\LoadPSD1.ps1} catch {} try {. $PSScriptRoot\..\..\LoadPSD1.ps1} catch {}
$plt = New-Plot $plt = New-Plot
$plt.Plot((Get-Range 0 5 .02|%{[math]::Cos(2*[math]::pi*$_)})) $plt.Plot((Get-Range 0 5 .02|Foreach-Object {[math]::Cos(2*[math]::pi*$_)}))
$plt.SetChartSize(800,300) $plt.SetChartSize(800,300)
$plt.Show() $plt.Show()

View File

@@ -1,5 +1,7 @@
try {. $PSScriptRoot\..\..\LoadPSD1.ps1} catch {} #requires -modules "getSql"
try {. $PSScriptRoot\..\..\LoadPSD1.ps1} catch {}
#download f1Results from https://1drv.ms/f/s!AhfYu7-CJv4egbt5FD7Cdxi8jSz3aQ and update the path below
Get-SQL -Session f1 -Excel -Connection C:\Users\mcp\OneDrive\Public\F1\f1Results.xlsx -showtables -Verbose Get-SQL -Session f1 -Excel -Connection C:\Users\mcp\OneDrive\Public\F1\f1Results.xlsx -showtables -Verbose
Remove-Item .\demo3.xlsx Remove-Item .\demo3.xlsx

View File

@@ -2,6 +2,6 @@ try {. $PSScriptRoot\..\..\LoadPSD1.ps1} catch {}
. $PSScriptRoot\TestAPIReadXls.ps1 . $PSScriptRoot\TestAPIReadXls.ps1
Test-APIReadXls $PSScriptRoot\testlist.xlsx | % { Test-APIReadXls $PSScriptRoot\testlist.xlsx | Foreach-Object {
Invoke-Pester -Script $_.fullname -PassThru -Show None Invoke-Pester -Script $_.fullname -PassThru -Show None
} }

View File

@@ -39,22 +39,24 @@
.PARAMETER IncludePivotTable .PARAMETER IncludePivotTable
Adds a Pivot table using the data in the worksheet. Adds a Pivot table using the data in the worksheet.
.PARAMETER PivotTableName .PARAMETER PivotTableName
If a Pivot table is created from command line parameters, specificies the name of the new sheet holding the pivot. If Omitted this will be "WorksheetName-PivotTable" If a Pivot table is created from command line parameters, specifies the name of the new sheet holding the pivot. Defaults to "WorksheetName-PivotTable"
.PARAMETER PivotRows .PARAMETER PivotRows
Name(s) columns from the spreadhseet which will provide the Row name(s) in a pivot table created from command line parameters. Name(s) columns from the spreadsheet which will provide the Row name(s) in a pivot table created from command line parameters.
.PARAMETER PivotColumns .PARAMETER PivotColumns
Name(s) columns from the spreadhseet which will provide the Column name(s) in a pivot table created from command line parameters. Name(s) columns from the spreadsheet which will provide the Column name(s) in a pivot table created from command line parameters.
.PARAMETER PivotFilter .PARAMETER PivotFilter
Name(s) columns from the spreadhseet which will provide the Filter name(s) in a pivot table created from command line parameters. Name(s) columns from the spreadsheet which will provide the Filter name(s) in a pivot table created from command line parameters.
.PARAMETER PivotData .PARAMETER PivotData
In a pivot table created from command line parameters, the fields to use in the table body are given as a Hash table in the form ColumnName = Average|Count|CountNums|Max|Min|Product|None|StdDev|StdDevP|Sum|Var|VarP . In a pivot table created from command line parameters, the fields to use in the table body are given as a Hash table in the form ColumnName = Average|Count|CountNums|Max|Min|Product|None|StdDev|StdDevP|Sum|Var|VarP.
.PARAMETER PivotDataToColumn .PARAMETER PivotDataToColumn
If there are multiple datasets in a PivotTable, by default they are shown seperatate rows under the given row heading; this switch makes them seperate columns. If there are multiple datasets in a PivotTable, by default they are shown as separate rows under the given row heading; this switch makes them separate columns.
.PARAMETER NoTotalsInPivot .PARAMETER NoTotalsInPivot
In a pivot table created from command line parameters, prevents the addition of totals to rows and columns. In a pivot table created from command line parameters, prevents the addition of totals to rows and columns.
.PARAMETER PivotTotals
By default, Pivot tables have totals for each Row (on the right) and for each column at the bottom. This allows just one or neither to be selected.
.PARAMETER PivotTableDefinition .PARAMETER PivotTableDefinition
Instead of describing a single pivot table with mutliple commandline paramters; you can use a HashTable in the form PivotTableName = Definition; Instead of describing a single pivot table with multiple commandline parameters; you can use a hashTable in the form PivotTableName = Definition;
Definition is itself a hashtable with Sheet PivotTows, PivotColumns, PivotData, IncludePivotChart and ChartType values. Definition is itself a hashtable with Sheet, PivotRows, PivotColumns, PivotData, IncludePivotChart and ChartType values.
.PARAMETER IncludePivotChart .PARAMETER IncludePivotChart
Include a chart with the Pivot table - implies -IncludePivotTable. Include a chart with the Pivot table - implies -IncludePivotTable.
.PARAMETER ChartType .PARAMETER ChartType
@@ -92,20 +94,20 @@
.PARAMETER ExcelChartDefinition .PARAMETER ExcelChartDefinition
A hash table containing ChartType, Title, NoLegend, ShowCategory, ShowPercent, Yrange, Xrange and SeriesHeader for one or more [non-pivot] charts. A hash table containing ChartType, Title, NoLegend, ShowCategory, ShowPercent, Yrange, Xrange and SeriesHeader for one or more [non-pivot] charts.
.PARAMETER HideSheet .PARAMETER HideSheet
Name(s) of Sheet(s) to hide in the workbook, supports wildcards. If all sheets would be hidden, the sheet being worked on will be revealed . Name(s) of Sheet(s) to hide in the workbook, supports wildcards. If all sheets would be hidden, the sheet being worked on will be revealed.
.PARAMETER UnHideSheet .PARAMETER UnHideSheet
Name(s) of Sheet(s) to Reveal in the workbook, supports wildcards. Name(s) of Sheet(s) to Reveal in the workbook, supports wildcards.
.PARAMETER MoveToStart .PARAMETER MoveToStart
If specified, the worksheet will be moved to the start of the workbook. If specified, the worksheet will be moved to the start of the workbook.
MoveToStart takes precedence over MoveToEnd, Movebefore and MoveAfter if more than one is specified. -MoveToStart takes precedence over -MoveToEnd, -Movebefore and -MoveAfter if more than one is specified.
.PARAMETER MoveToEnd .PARAMETER MoveToEnd
If specified, the worksheet will be moved to the end of the workbook. If specified, the worksheet will be moved to the end of the workbook.
(This is the default position for newly created sheets, but this can be used to move existing sheets.) (This is the default position for newly created sheets, but this can be used to move existing sheets.)
.PARAMETER MoveBefore .PARAMETER MoveBefore
If specified, the worksheet will be moved before the nominated one (which can be a postion starting from 1, or a name). If specified, the worksheet will be moved before the nominated one (which can be a position starting from 1, or a name).
MoveBefore takes precedence over MoveAfter if both are specified. -MoveBefore takes precedence over -MoveAfter if both are specified.
.PARAMETER MoveAfter .PARAMETER MoveAfter
If specified, the worksheet will be moved after the nominated one (which can be a postion starting from 1, or a name or *). If specified, the worksheet will be moved after the nominated one (which can be a position starting from 1, or a name or *).
If * is used, the worksheet names will be examined starting with the first one, and the sheet placed after the last sheet which comes before it alphabetically. If * is used, the worksheet names will be examined starting with the first one, and the sheet placed after the last sheet which comes before it alphabetically.
.PARAMETER KillExcel .PARAMETER KillExcel
Closes Excel - prevents errors writing to the file because Excel has it open. Closes Excel - prevents errors writing to the file because Excel has it open.
@@ -122,9 +124,9 @@
.PARAMETER FreezeTopRowFirstColumn .PARAMETER FreezeTopRowFirstColumn
Freezes top row and left column (equivalent to Freeze pane 2,2 ). Freezes top row and left column (equivalent to Freeze pane 2,2 ).
.PARAMETER FreezePane .PARAMETER FreezePane
Freezes panes at specified coordinates (in the form RowNumber , ColumnNumber). Freezes panes at specified coordinates (in the form RowNumber, ColumnNumber).
.PARAMETER AutoFilter .PARAMETER AutoFilter
Enables the 'Filter' in Excel on the complete header row. So users can easily sort, filter and/or search the data in the selected column from within Excel. Enables the 'Filter' in Excel on the complete header row, so users can easily sort, filter and/or search the data in the selected column from within Excel.
.PARAMETER AutoSize .PARAMETER AutoSize
Sizes the width of the Excel column to the maximum width needed to display all the containing data in that cell. Sizes the width of the Excel column to the maximum width needed to display all the containing data in that cell.
.PARAMETER Activate .PARAMETER Activate
@@ -147,10 +149,10 @@
# number with 2 decimal places. # number with 2 decimal places.
'0.00' '0.00'
# number with 2 decimal places and thousand separator. # number with 2 decimal places and thousand-separator.
'#,##0.00' '#,##0.00'
# number with 2 decimal places and thousand separator and money symbol. # number with 2 decimal places and thousand-separator and money-symbol.
'€#,##0.00' '€#,##0.00'
# percentage (1 = 100%, 0.01 = 1%) # percentage (1 = 100%, 0.01 = 1%)
@@ -171,8 +173,8 @@
.PARAMETER ReturnRange .PARAMETER ReturnRange
If specified, Export-Excel returns the range of added cells in the format "A1:Z100" If specified, Export-Excel returns the range of added cells in the format "A1:Z100"
.PARAMETER PassThru .PARAMETER PassThru
If specified, Export-Excel returns an object representing the Excel package without saving the package first. To save it you need to call the save or Saveas method or send it back to Export-Excel. If specified, Export-Excel returns an object representing the Excel package without saving the package first.
To save, you need to call Close-ExcelPackage or send the object back to Export-Excel, or use its .Save() or SaveAs() method.
.EXAMPLE .EXAMPLE
Get-Process | Export-Excel .\Test.xlsx -show Get-Process | Export-Excel .\Test.xlsx -show
Export all the processes to the Excel file 'Test.xlsx' and open the file immediately. Export all the processes to the Excel file 'Test.xlsx' and open the file immediately.
@@ -255,7 +257,9 @@
New-ConditionalText -ConditionalType GreaterThan 525 -ConditionalTextColor DarkRed -BackgroundColor LightPink New-ConditionalText -ConditionalType GreaterThan 525 -ConditionalTextColor DarkRed -BackgroundColor LightPink
) )
Exports data that will have a 'Conditional formatting rule' in Excel on these cells that will show the background fill color in 'LightPink' and the text color in 'DarkRed' when the value is greater then '525'. In case this condition is not met the color will be the default, black text on a white background. Exports data that will have a 'Conditional formatting rule' in Excel on these cells that will show the background fill color in
'LightPink' and the text color in 'DarkRed' when the value is greater than '525'. In case this condition is not met the color will
be the default, black text on a white background.
.EXAMPLE .EXAMPLE
> >
@@ -265,7 +269,7 @@
Verbose = $true Verbose = $true
} }
Remove-Item -Path $ExcelParams.Path -Force -EA Ignore Remove-Item -Path $ExcelParams.Path -Force -EA Ignore
Get-Service | Select Name, Status, DisplayName, ServiceName | Get-Service | Select-Object -Property Name, Status, DisplayName, ServiceName |
Export-Excel @ExcelParams -ConditionalText $( Export-Excel @ExcelParams -ConditionalText $(
New-ConditionalText Stop DarkRed LightPink New-ConditionalText Stop DarkRed LightPink
New-ConditionalText Running Blue Cyan New-ConditionalText Running Blue Cyan
@@ -338,7 +342,7 @@
Export-Excel -Path .\test.xlsx -PivotTableDefinition $pt -Show Export-Excel -Path .\test.xlsx -PivotTableDefinition $pt -Show
This example defines two pivot tables. Then it puts Service data on Sheet1 with one call to Export-Excel and Process Data on sheet2 with a second call to Export-Excel. This example defines two pivot tables. Then it puts Service data on Sheet1 with one call to Export-Excel and Process Data on sheet2 with a second call to Export-Excel.
The thrid and final call adds the two pivot tables and opens the spreadsheet in Excel. The third and final call adds the two pivot tables and opens the spreadsheet in Excel.
.EXAMPLE .EXAMPLE
@@ -352,13 +356,12 @@
$excel.Dispose() $excel.Dispose()
Start-Process .\test.xlsx Start-Process .\test.xlsx
This example uses -passthrough - put service information into sheet1 of the work book and saves the excelPackageObject in $Excel. This example uses -passthrough. It puts service information into sheet1 of the workbook and saves the ExcelPackageObject in $Excel.
It then uses the package object to apply formatting, and then saves the workbook and disposes of the object before loading the document in Excel. It then uses the package object to apply formatting, and then saves the workbook and disposes of the object before loading the document in Excel.
.EXAMPLE .EXAMPLE
> >
PS> Remove-Item -Path .\test.xlsx -ErrorAction Ignore PS> Remove-Item -Path .\test.xlsx -ErrorAction Ignore
$excel = Get-Process | Select-Object -Property Name,Company,Handles,CPU,PM,NPM,WS | Export-Excel -Path .\test.xlsx -ClearSheet -WorksheetName "Processes" -PassThru $excel = Get-Process | Select-Object -Property Name,Company,Handles,CPU,PM,NPM,WS | Export-Excel -Path .\test.xlsx -ClearSheet -WorksheetName "Processes" -PassThru
$sheet = $excel.Workbook.Worksheets["Processes"] $sheet = $excel.Workbook.Worksheets["Processes"]
$sheet.Column(1) | Set-ExcelRange -Bold -AutoFit $sheet.Column(1) | Set-ExcelRange -Bold -AutoFit
@@ -681,15 +684,14 @@
} }
Process { Process {
if ($TargetData) { if ($PSBoundParameters.ContainsKey("TargetData")) {
try { try {
if ($firstTimeThru) { if ($firstTimeThru) {
$firstTimeThru = $false $firstTimeThru = $false
$isDataTypeValueType = $TargetData.GetType().name -match 'string|timespan|datetime|bool|byte|char|decimal|double|float|int|long|sbyte|short|uint|ulong|ushort|URI|ExcelHyperLink' $isDataTypeValueType = ($null -eq $TargetData) -or ($TargetData.GetType().name -match 'string|timespan|datetime|bool|byte|char|decimal|double|float|int|long|sbyte|short|uint|ulong|ushort|URI|ExcelHyperLink')
if ($isDataTypeValueType -and -not $Append) {$row -= 1} #row incremented before adding values, so it is set to the number of rows inserted at the end if ($isDataTypeValueType -and -not $Append) {$row -= 1} #row incremented before adding values, so it is set to the number of rows inserted at the end
Write-Debug "DataTypeName is '$($TargetData.GetType().name)' isDataTypeValueType '$isDataTypeValueType'" if ($null -ne $TargetData) {Write-Debug "DataTypeName is '$($TargetData.GetType().name)' isDataTypeValueType '$isDataTypeValueType'" }
} }
if ($isDataTypeValueType) { if ($isDataTypeValueType) {
$ColumnIndex = $StartColumn $ColumnIndex = $StartColumn
$Row += 1 $Row += 1
@@ -741,18 +743,18 @@
} }
End { End {
if ($firstTimeThru) { if ($firstTimeThru -and $ws.Dimension) {
$LastRow = $ws.Dimension.End.Row $LastRow = $ws.Dimension.End.Row
$LastCol = $ws.Dimension.End.Column $LastCol = $ws.Dimension.End.Column
$endAddress = $ws.Dimension.End.Address $endAddress = $ws.Dimension.End.Address
} }
else { else {
$LastRow = $Row $LastRow = $Row
$LastCol = $ColumnIndex $LastCol = $ColumnIndex
$endAddress = [OfficeOpenXml.ExcelAddress]::GetAddress($LastRow , $LastCol) $endAddress = [OfficeOpenXml.ExcelAddress]::GetAddress($LastRow , $LastCol)
} }
$startAddress = [OfficeOpenXml.ExcelAddress]::GetAddress($StartRow, $StartColumn) $startAddress = [OfficeOpenXml.ExcelAddress]::GetAddress($StartRow, $StartColumn)
$dataRange = "{0}:{1}" -f $startAddress, $endAddress $dataRange = "{0}:{1}" -f $startAddress, $endAddress
Write-Debug "Data Range '$dataRange'" Write-Debug "Data Range '$dataRange'"
if ($AutoNameRange) { if ($AutoNameRange) {
@@ -762,29 +764,29 @@
$headerRange = $ws.Dimension.Address -replace "\d+$", $StartRow $headerRange = $ws.Dimension.Address -replace "\d+$", $StartRow
#using a slightly odd syntax otherwise header ends up as a 2D array #using a slightly odd syntax otherwise header ends up as a 2D array
$ws.Cells[$headerRange].Value | ForEach-Object -Begin {$Script:header = @()} -Process {$Script:header += $_ } $ws.Cells[$headerRange].Value | ForEach-Object -Begin {$Script:header = @()} -Process {$Script:header += $_ }
#if there is no header start the range at $startRow if ($PSBoundParameters.ContainsKey($TargetData)) { #if Export was called with data that writes no header start the range at $startRow ($startRow is data)
$targetRow = $StartRow $targetRow = $StartRow
} }
else { else { $targetRow = $StartRow + 1 } #if Export was called without data to add names (assume $startRow is a header) or...
#if there is a header, start the range and the next row down. } # ... called with data that writes a header, then start the range at $startRow + 1
$targetRow = $StartRow + 1 else { $targetRow = $StartRow + 1 }
}
#Dimension.start.row always seems to be one so we work out the target row #Dimension.start.row always seems to be one so we work out the target row
#, but start.column is the first populated one and .Columns is the count of populated ones. #, but start.column is the first populated one and .Columns is the count of populated ones.
# if we have 5 columns from 3 to 8, headers are numbered 0..4, so that is in the for loop and used for getting the name... # if we have 5 columns from 3 to 8, headers are numbered 0..4, so that is in the for loop and used for getting the name...
# but we have to add the start column on when referencing positions # but we have to add the start column on when referencing positions
foreach ($c in 0..($LastCol - $StartColumn)) { foreach ($c in 0..($LastCol - $StartColumn)) {
$targetRangeName = $script:Header[$c] -replace '\W' , '_' $targetRangeName = $script:Header[$c] #Let Add-ExcelName fix (and warn about) bad names
Add-ExcelName -RangeName $targetRangeName -Range $ws.Cells[$targetRow, ($StartColumn + $c ), $LastRow, ($StartColumn + $c )] Add-ExcelName -RangeName $targetRangeName -Range $ws.Cells[$targetRow, ($StartColumn + $c ), $LastRow, ($StartColumn + $c )]
if ([OfficeOpenXml.FormulaParsing.ExcelUtilities.ExcelAddressUtil]::IsValidAddress($targetRangeName)) { try {#this test can throw with some names, surpress any error
Write-Warning "AutoNameRange: Property name '$targetRangeName' is also a valid Excel address and may cause issues. Consider renaming the property name." if ([OfficeOpenXml.FormulaParsing.ExcelUtilities.ExcelAddressUtil]::IsValidAddress(($targetRangeName -replace '\W' , '_' ))) {
} Write-Warning "AutoNameRange: Property name '$targetRangeName' is also a valid Excel address and may cause issues. Consider renaming the property name."
}
} Catch {}
} }
} }
catch {Write-Warning -Message "Failed adding named ranges to worksheet '$WorksheetName': $_" } catch {Write-Warning -Message "Failed adding named ranges to worksheet '$WorksheetName': $_" }
} }
if ($RangeName) { Add-ExcelName -Range $ws.Cells[$dataRange] -RangeName $RangeName} if ($RangeName) { Add-ExcelName -Range $ws.Cells[$dataRange] -RangeName $RangeName}
if ($TableName) { if ($TableName) {
@@ -1077,10 +1079,10 @@ function Add-WorkSheet {
#An object representing an Excel Package. #An object representing an Excel Package.
[Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "Package", Position = 0)] [Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "Package", Position = 0)]
[OfficeOpenXml.ExcelPackage]$ExcelPackage, [OfficeOpenXml.ExcelPackage]$ExcelPackage,
#An Excel workbook to which the Worksheet will be added - a package contains one workbook so you can use whichever fits at the time. #An Excel Workbook to which the Worksheet will be added - a Package contains one Workbook, so you can use whichever fits at the time.
[Parameter(Mandatory = $true, ParameterSetName = "WorkBook")] [Parameter(Mandatory = $true, ParameterSetName = "WorkBook")]
[OfficeOpenXml.ExcelWorkbook]$ExcelWorkbook, [OfficeOpenXml.ExcelWorkbook]$ExcelWorkbook,
#The name of the worksheet 'Sheet1' by default. #The name of the worksheet, 'Sheet1' by default.
[string]$WorksheetName , [string]$WorksheetName ,
#If the worksheet already exists, by default it will returned, unless -ClearSheet is specified in which case it will be deleted and re-created. #If the worksheet already exists, by default it will returned, unless -ClearSheet is specified in which case it will be deleted and re-created.
[switch]$ClearSheet, [switch]$ClearSheet,
@@ -1090,13 +1092,13 @@ function Add-WorkSheet {
#If specified, the worksheet will be moved to the end of the workbook. #If specified, the worksheet will be moved to the end of the workbook.
#(This is the default position for newly created sheets, but this can be used to move existing sheets.) #(This is the default position for newly created sheets, but this can be used to move existing sheets.)
[Switch]$MoveToEnd, [Switch]$MoveToEnd,
#If specified, the worksheet will be moved before the nominated one (which can be a postion starting from 1, or a name). #If specified, the worksheet will be moved before the nominated one (which can be an index starting from 1, or a name).
#MoveBefore takes precedence over MoveAfter if both are specified. #MoveBefore takes precedence over MoveAfter if both are specified.
$MoveBefore , $MoveBefore ,
# If specified, the worksheet will be moved after the nominated one (which can be a postion starting from 1, or a name or *). # If specified, the worksheet will be moved after the nominated one (which can be an index starting from 1, or a name or *).
# If * is used, the worksheet names will be examined starting with the first one, and the sheet placed after the last sheet which comes before it alphabetically. # If * is used, the worksheet names will be examined starting with the first one, and the sheet placed after the last sheet which comes before it alphabetically.
$MoveAfter , $MoveAfter ,
#If there is already content in the workbook the new sheet will not be active UNLESS Activate is specified #If there is already content in the workbook the new sheet will not be active UNLESS Activate is specified.
[switch]$Activate, [switch]$Activate,
#If worksheet is provided as a copy source the new worksheet will be a copy of it. The source can be in the same workbook, or in a different file. #If worksheet is provided as a copy source the new worksheet will be a copy of it. The source can be in the same workbook, or in a different file.
[OfficeOpenXml.ExcelWorksheet]$CopySource, [OfficeOpenXml.ExcelWorksheet]$CopySource,
@@ -1168,34 +1170,34 @@ function Add-WorkSheet {
function Select-Worksheet { function Select-Worksheet {
<# <#
.SYNOPSIS .SYNOPSIS
Sets the selected tab in an Excel workbook to be the chosen sheet, and unselects all the others. Sets the selected tab in an Excel workbook to be the chosen sheet and unselects all the others.
.DESCRIPTION .DESCRIPTION
Sometimes when a sheet is added we want it to be the active sheet, sometimes we want the active sheet to be left as it was. Sometimes when a sheet is added we want it to be the active sheet, sometimes we want the active sheet to be left as it was.
Select-Worksheet exists to change the which sheet is the selected tab when Excel opens the file. Select-Worksheet exists to change the which sheet is the selected tab when Excel opens the file.
.EXAMPLE .EXAMPLE
Select-Worksheet -ExcelWorkbook $ExcelWorkbook -WorksheetName "NewSheet" Select-Worksheet -ExcelWorkbook $ExcelWorkbook -WorksheetName "NewSheet"
$ExcelWorkbook holds the a workbook object containing a sheet named "NewSheet"; $ExcelWorkbook holds a workbook object containing a sheet named "NewSheet";
This sheet will become the [only] active sheet in the workbook This sheet will become the [only] active sheet in the workbook
.EXAMPLE .EXAMPLE
Select-Worksheet -ExcelPackage $Pkg -WorksheetName "NewSheet2" Select-Worksheet -ExcelPackage $Pkg -WorksheetName "NewSheet2"
$pkg holds an Excel Package, whose workbook contains a sheet named "NewSheet2" $pkg holds an Excel Package, whose workbook contains a sheet named "NewSheet2"
This sheet will become the [only] active sheet in the workbook This sheet will become the [only] active sheet in the workbook.
.EXAMPLE .EXAMPLE
Select-Worksheet -ExcelWorksheet $ws Select-Worksheet -ExcelWorksheet $ws
$ws holds an Excel worksheet which will become the [only] active sheet in the workbook $ws holds an Excel worksheet which will become the [only] active sheet in the workbook.
#> #>
param ( param (
#An object representing an Excel Package. #An object representing an Excel Package.
[Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = 'Package', Position = 0)] [Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = 'Package', Position = 0)]
[OfficeOpenXml.ExcelPackage]$ExcelPackage, [OfficeOpenXml.ExcelPackage]$ExcelPackage,
#An Excel workbook to which the Worksheet will be added - a package contains one workbook so you can use workbook or package as it suits #An Excel workbook to which the Worksheet will be added - a package contains one Workbook so you can use workbook or package as it suits.
[Parameter(Mandatory = $true, ParameterSetName = 'WorkBook')] [Parameter(Mandatory = $true, ParameterSetName = 'WorkBook')]
[OfficeOpenXml.ExcelWorkbook]$ExcelWorkbook, [OfficeOpenXml.ExcelWorkbook]$ExcelWorkbook,
[Parameter(ParameterSetName='Package')] [Parameter(ParameterSetName='Package')]
[Parameter(ParameterSetName='Workbook')] [Parameter(ParameterSetName='Workbook')]
#The name of the worksheet 'Sheet1' by default. #The name of the worksheet 'Sheet1' by default.
[string]$WorksheetName, [string]$WorksheetName,
#An object representing an Excel worksheet #An object representing an Excel worksheet.
[Parameter(ParameterSetName='Sheet',Mandatory=$true)] [Parameter(ParameterSetName='Sheet',Mandatory=$true)]
[OfficeOpenXml.ExcelWorksheet]$ExcelWorksheet [OfficeOpenXml.ExcelWorksheet]$ExcelWorksheet
) )
@@ -1215,7 +1217,7 @@ function Select-Worksheet {
Function Add-ExcelName { Function Add-ExcelName {
<# <#
.SYNOPSIS .SYNOPSIS
Adds a named range to an existing Excel worksheet Adds a named-range to an existing Excel worksheet.
.DESCRIPTION .DESCRIPTION
It is often helpful to be able to refer to sets of cells with a name rather than using their co-ordinates; Add-ExcelName sets up these names. It is often helpful to be able to refer to sets of cells with a name rather than using their co-ordinates; Add-ExcelName sets up these names.
.EXAMPLE .EXAMPLE
@@ -1228,7 +1230,7 @@ Function Add-ExcelName {
#The range of cells to assign as a name. #The range of cells to assign as a name.
[Parameter(Mandatory=$true)] [Parameter(Mandatory=$true)]
[OfficeOpenXml.ExcelRange]$Range, [OfficeOpenXml.ExcelRange]$Range,
#The name to assign to the range. If the name exists it will be updated to the new range. If no name is specified the first cell in the range will be used as the name #The name to assign to the range. If the name exists it will be updated to the new range. If no name is specified, the first cell in the range will be used as the name.
[String]$RangeName [String]$RangeName
) )
try { try {
@@ -1268,36 +1270,36 @@ function Add-ExcelTable {
.EXAMPLE .EXAMPLE
Add-ExcelTable -Range $ws.cells[$($ws.Dimension.address)] -TableStyle Light1 -TableName Musictable -ShowFilter:$false -ShowTotal -ShowFirstColumn Add-ExcelTable -Range $ws.cells[$($ws.Dimension.address)] -TableStyle Light1 -TableName Musictable -ShowFilter:$false -ShowTotal -ShowFirstColumn
Again $ws is a worksheet, range here is the whole of the active part of the worksheet. The table style and name are set, Again $ws is a worksheet, range here is the whole of the active part of the worksheet. The table style and name are set,
the filter is turned off, a totals row added and first column set in bold. the filter is turned off, and a "Totals" row added, and first column is set in bold.
#> #>
[CmdletBinding()] [CmdletBinding()]
[OutputType([OfficeOpenXml.Table.ExcelTable])] [OutputType([OfficeOpenXml.Table.ExcelTable])]
param ( param (
#The range of cells to assign to a table #The range of cells to assign to a table.
[Parameter(Mandatory=$true)] [Parameter(Mandatory=$true)]
[OfficeOpenXml.ExcelRange]$Range, [OfficeOpenXml.ExcelRange]$Range,
#The name for the table #The name for the Table - this should be unqiue in the Workbook.
[Parameter(Mandatory=$true)] [Parameter(Mandatory=$true)]
[String]$TableName, [String]$TableName,
#The Style for the table, by default Medium 6 #The Style for the table, by default "Medium6" is used
[OfficeOpenXml.Table.TableStyles]$TableStyle = 'Medium6', [OfficeOpenXml.Table.TableStyles]$TableStyle = 'Medium6',
#By default the header row is shown - it can be turned off with -ShowHeader:$false #By default the header row is shown - it can be turned off with -ShowHeader:$false.
[Switch]$ShowHeader , [Switch]$ShowHeader ,
#By default the filter is enabled - it can be turned off with -ShowFilter:$false #By default the filter is enabled - it can be turned off with -ShowFilter:$false.
[Switch]$ShowFilter, [Switch]$ShowFilter,
#Show total adds a totals row. This does not automatically sum the columns but provides a drop-down in each to select sum, average etc #Show total adds a totals row. This does not automatically sum the columns but provides a drop-down in each to select sum, average etc
[Switch]$ShowTotal, [Switch]$ShowTotal,
#Hashtable in the form ColumnName = "Average"|"Count"|"CountNums"|"Max"|"Min"|"None"|"StdDev"|"Sum"|"Var" - if specified ShowTotal is not needed. #A HashTable in the form ColumnName = "Average"|"Count"|"CountNums"|"Max"|"Min"|"None"|"StdDev"|"Sum"|"Var" - if specified, -ShowTotal is not needed.
[hashtable]$TotalSettings, [hashtable]$TotalSettings,
#Highlights the first column in bold #Highlights the first column in bold.
[Switch]$ShowFirstColumn, [Switch]$ShowFirstColumn,
#Highlights the last column in bold #Highlights the last column in bold.
[Switch]$ShowLastColumn, [Switch]$ShowLastColumn,
#By default the table formats show striped rows, the can be turned off with -ShowRowStripes:$false #By default the table formats show striped rows, the can be turned off with -ShowRowStripes:$false
[Switch]$ShowRowStripes, [Switch]$ShowRowStripes,
#Turns on column stripes. #Turns on column stripes.
[Switch]$ShowColumnStripes, [Switch]$ShowColumnStripes,
#If -PassThru is specified the table object will be returned to allow additional #If -PassThru is specified, the table object will be returned to allow additional changes to be made.
[Switch]$PassThru [Switch]$PassThru
) )
try { try {

View File

@@ -21,9 +21,9 @@ function Get-HtmlTable {
if(!$propertyNames) { if(!$propertyNames) {
if($cells[0].tagName -eq 'th') { if($cells[0].tagName -eq 'th') {
$propertyNames = @($cells | foreach {$_.innertext -replace ' ',''}) $propertyNames = @($cells | ForEach-Object {$_.innertext -replace ' ',''})
} else { } else {
$propertyNames = @(1..($cells.Count + 2) | % { "P$_" }) $propertyNames = @(1..($cells.Count + 2) | Foreach-Object { "P$_" })
} }
continue continue
} }

View File

@@ -1,7 +1,7 @@
function Get-XYRange { function Get-XYRange {
param($targetData) param($targetData)
$record = $targetData| select -First 1 $record = $targetData | Select-Object -First 1
$p=$record.psobject.Properties.name $p=$record.psobject.Properties.name
$infer = for ($idx = 0; $idx -lt $p.Count; $idx++) { $infer = for ($idx = 0; $idx -lt $p.Count; $idx++) {
@@ -20,7 +20,7 @@ function Get-XYRange {
} }
[PSCustomObject]@{ [PSCustomObject]@{
XRange = $infer | ? {$_.datatype -match 'string'} | select -First 1 excelcolumn, name XRange = $infer | Where-Object -FilterScript {$_.datatype -match 'string'} | Select-Object -First 1 -Property excelcolumn, name
YRange = $infer | ? {$_.datatype -match 'int|double'} |select -First 1 excelcolumn, name YRange = $infer | Where-Object -FilterScript {$_.datatype -match 'int|double'} | Select-Object -First 1 -Property excelcolumn, name
} }
} }

View File

@@ -89,7 +89,7 @@ function ConvertFrom-ExcelColumnName {
$sum=0 $sum=0
$columnName.ToCharArray() | $columnName.ToCharArray() |
ForEach { ForEach-Object {
$sum*=26 $sum*=26
$sum+=[char]$_.tostring().toupper()-[char]'A'+1 $sum+=[char]$_.tostring().toupper()-[char]'A'+1
} }

View File

@@ -1,120 +1,120 @@
@{ @{
# Script module or binary module file associated with this manifest. # Script module or binary module file associated with this manifest.
RootModule = 'ImportExcel.psm1' RootModule = 'ImportExcel.psm1'
# Version number of this module. # Version number of this module.
ModuleVersion = '5.3.0' ModuleVersion = '5.3.3'
# ID used to uniquely identify this module # ID used to uniquely identify this module
GUID = '60dd4136-feff-401a-ba27-a84458c57ede' GUID = '60dd4136-feff-401a-ba27-a84458c57ede'
# Author of this module # Author of this module
Author = 'Douglas Finke' Author = 'Douglas Finke'
# Company or vendor of this module # Company or vendor of this module
CompanyName = 'Doug Finke' CompanyName = 'Doug Finke'
# Copyright statement for this module # Copyright statement for this module
Copyright = 'c 2015 All rights reserved.' Copyright = 'c 2015 All rights reserved.'
# Description of the functionality provided by this module # Description of the functionality provided by this module
Description = @' Description = @'
PowerShell module to import/export Excel spreadsheets, without Excel. PowerShell module to import/export Excel spreadsheets, without Excel.
Check out the How To Videos https://www.youtube.com/watch?v=U3Ne_yX4tYo&list=PL5uoqS92stXioZw-u-ze_NtvSo0k0K0kq Check out the How To Videos https://www.youtube.com/watch?v=U3Ne_yX4tYo&list=PL5uoqS92stXioZw-u-ze_NtvSo0k0K0kq
'@ '@
# Minimum version of the Windows PowerShell engine required by this module # Minimum version of the Windows PowerShell engine required by this module
# PowerShellVersion = '' # PowerShellVersion = ''
# Name of the Windows PowerShell host required by this module # Name of the Windows PowerShell host required by this module
# PowerShellHostName = '' # PowerShellHostName = ''
# Minimum version of the Windows PowerShell host required by this module # Minimum version of the Windows PowerShell host required by this module
# PowerShellHostVersion = '' # PowerShellHostVersion = ''
# Minimum version of Microsoft .NET Framework required by this module # Minimum version of Microsoft .NET Framework required by this module
# DotNetFrameworkVersion = '' # DotNetFrameworkVersion = ''
# Minimum version of the common language runtime (CLR) required by this module # Minimum version of the common language runtime (CLR) required by this module
# CLRVersion = '' # CLRVersion = ''
# Processor architecture (None, X86, Amd64) required by this module # Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = '' # ProcessorArchitecture = ''
# Modules that must be imported into the global environment prior to importing this module # Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @() # RequiredModules = @()
# Assemblies that must be loaded prior to importing this module # Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @() # RequiredAssemblies = @()
# Script files (.ps1) that are run in the caller's environment prior to importing this module. # Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @() # ScriptsToProcess = @()
# Type files (.ps1xml) to be loaded when importing this module # Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @() # TypesToProcess = @()
# Format files (.ps1xml) to be loaded when importing this module # Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @() # FormatsToProcess = @()
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @() # NestedModules = @()
# Functions to export from this module # Functions to export from this module
FunctionsToExport = '*' FunctionsToExport = '*'
# Cmdlets to export from this module # Cmdlets to export from this module
CmdletsToExport = '*' CmdletsToExport = '*'
# Variables to export from this module # Variables to export from this module
VariablesToExport = '*' VariablesToExport = '*'
# Aliases to export from this module # Aliases to export from this module
AliasesToExport = '*' AliasesToExport = '*'
# List of all modules packaged with this module # List of all modules packaged with this module
# ModuleList = @() # ModuleList = @()
# List of all files packaged with this module # List of all files packaged with this module
# FileList = @() # FileList = @()
# Private data to pass to the module specified in RootModule/ModuleToProcess # Private data to pass to the module specified in RootModule/ModuleToProcess
PrivateData = @{ PrivateData = @{
# PSData is module packaging and gallery metadata embedded in PrivateData # PSData is module packaging and gallery metadata embedded in PrivateData
# It's for rebuilding PowerShellGet (and PoshCode) NuGet-style packages # It's for rebuilding PowerShellGet (and PoshCode) NuGet-style packages
# We had to do this because it's the only place we're allowed to extend the manifest # We had to do this because it's the only place we're allowed to extend the manifest
# https://connect.microsoft.com/PowerShell/feedback/details/421837 # https://connect.microsoft.com/PowerShell/feedback/details/421837
PSData = @{ PSData = @{
# The primary categorization of this module (from the TechNet Gallery tech tree). # The primary categorization of this module (from the TechNet Gallery tech tree).
Category = "Scripting Excel" Category = "Scripting Excel"
# Keyword tags to help users find this module via navigations and search. # Keyword tags to help users find this module via navigations and search.
Tags = @("Excel","EPPlus","Export","Import") Tags = @("Excel", "EPPlus", "Export", "Import")
# The web address of an icon which can be used in galleries to represent this module # The web address of an icon which can be used in galleries to represent this module
#IconUri = "http://pesterbdd.com/images/Pester.png" #IconUri = "http://pesterbdd.com/images/Pester.png"
# The web address of this module's project or support homepage. # The web address of this module's project or support homepage.
ProjectUri = "https://github.com/dfinke/ImportExcel" ProjectUri = "https://github.com/dfinke/ImportExcel"
# The web address of this module's license. Points to a page that's embeddable and linkable. # The web address of this module's license. Points to a page that's embeddable and linkable.
LicenseUri = "https://github.com/dfinke/ImportExcel/blob/master/LICENSE.txt" LicenseUri = "https://github.com/dfinke/ImportExcel/blob/master/LICENSE.txt"
# Release notes for this particular version of the module # Release notes for this particular version of the module
#ReleaseNotes = $True #ReleaseNotes = $True
# If true, the LicenseUrl points to an end-user license (not just a source license) which requires the user agreement before use. # If true, the LicenseUrl points to an end-user license (not just a source license) which requires the user agreement before use.
# RequireLicenseAcceptance = "" # RequireLicenseAcceptance = ""
# Indicates this is a pre-release/testing version of the module. # Indicates this is a pre-release/testing version of the module.
IsPrerelease = 'False' IsPrerelease = 'False'
}
} }
}
# HelpInfo URI of this module # HelpInfo URI of this module
# HelpInfoURI = '' # HelpInfoURI = ''
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = '' # DefaultCommandPrefix = ''
} }

View File

@@ -68,7 +68,7 @@ function Invoke-AllTests {
) )
$resultCount=0 $resultCount=0
$tests.GetEnumerator() | ForEach { $tests.GetEnumerator() | ForEach-Object {
$result=& $_.Value $target $result=& $_.Value $target

View File

@@ -1,47 +1,3 @@
<# $fullPath = 'C:\Program Files\WindowsPowerShell\Modules\ImportExcel'
.SYNOPSIS
Install the module in the PowerShell module folder.
.DESCRIPTION Robocopy . $fullPath /mir /XD .vscode .git examples testimonials images spikes /XF appveyor.yml .gitattributes .gitignore
Install the module in the PowerShell module folder by copying all the files.
#>
[CmdLetBinding()]
Param (
[ValidateNotNullOrEmpty()]
[String]$ModuleName = 'ImportExcel',
[ValidateScript({Test-Path -Path $_ -Type Container})]
[String]$ModulePath = 'C:\Program Files\WindowsPowerShell\Modules'
)
Begin {
Try {
Write-Verbose "$ModuleName module installation started"
$Files = Get-Content $PSScriptRoot\filelist.txt
}
Catch {
throw "Failed installing the module '$ModuleName': $_"
}
}
Process {
Try {
$TargetPath = Join-Path -Path $ModulePath -ChildPath $ModuleName
if (-not (Test-Path $TargetPath)) {
New-Item -Path $TargetPath -ItemType Directory -EA Stop | Out-Null
Write-Verbose "$ModuleName created module folder '$TargetPath'"
}
Get-ChildItem $Files | ForEach-Object {
Copy-Item -Path $_.FullName -Destination "$($TargetPath)\$($_.Name)"
Write-Verbose "$ModuleName installed module file '$($_.Name)'"
}
Write-Verbose "$ModuleName module installation successful"
}
Catch {
throw "Failed installing the module '$ModuleName': $_"
}
}

View File

@@ -8,32 +8,30 @@
In the former case the header row is copied from the first sheet and, by default, each row of data is labelled with the name of the sheet it came from. In the former case the header row is copied from the first sheet and, by default, each row of data is labelled with the name of the sheet it came from.
In the latter case -NoHeader is specified, and each copied block can have the sheet it came from placed above it as a title. In the latter case -NoHeader is specified, and each copied block can have the sheet it came from placed above it as a title.
.EXAMPLE .EXAMPLE
.EXAMPLE
> >
PS> foreach ($computerName in @('Server1', 'Server2', 'Server3', 'Server4')) { PS> foreach ($computerName in @('Server1', 'Server2', 'Server3', 'Server4')) {
Get-Service -ComputerName $computerName | Select-Object -Property Status, Name, DisplayName, StartType | Get-Service -ComputerName $computerName | Select-Object -Property Status, Name, DisplayName, StartType |
Export-Excel -Path .\test.xlsx -WorkSheetname $computerName -AutoSize Export-Excel -Path .\test.xlsx -WorkSheetname $computerName -AutoSize
} }
$ptDef =New-PivotTableDefinition -PivotTableName "Pivot1" -SourceWorkSheet "Combined" -PivotRows "Status" -PivotFilter "MachineName" -PivotData @{Status='Count'} -IncludePivotChart -ChartType BarClustered3D PS> $ptDef =New-PivotTableDefinition -PivotTableName "Pivot1" -SourceWorkSheet "Combined" -PivotRows "Status" -PivotFilter "MachineName" -PivotData @{Status='Count'} -IncludePivotChart -ChartType BarClustered3D
Join-Worksheet -Path .\test.xlsx -WorkSheetName combined -FromLabel "MachineName" -HideSource -AutoSize -FreezeTopRow -BoldTopRow -PivotTableDefinition $pt -Show PS> Join-Worksheet -Path .\test.xlsx -WorkSheetName combined -FromLabel "MachineName" -HideSource -AutoSize -FreezeTopRow -BoldTopRow -PivotTableDefinition $pt -Show
The foreach command gets the services running on four servers and exports each to its own page in Test.xlsx. The foreach command gets the services running on four servers and exports each to its own page in Test.xlsx.
$PtDef= creates a defintion for a single Pivot table. $PtDef= creates a defintion for a PivotTable.
The Join-Worksheet command uses the same file and merges the results onto a sheet named "Combined". It sets a column header of "Machinename", The Join-Worksheet command uses the same file and merges the results onto a sheet named "Combined". It sets a column header of "Machinename",
this column will contain the name of the sheet the data was copied from; after copying the data to the sheet "combined", the other sheets will be hidden. this column will contain the name of the sheet the data was copied from; after copying the data to the sheet "combined", the other sheets will be hidden.
Join-Worksheet finishes by calling export-Excel to AutoSize cells, freeze the top row and make it bold and add the Pivot table. Join-Worksheet finishes by calling Export-Excel to AutoSize cells, freeze the top row and make it bold and add the Pivot table.
.EXAMPLE .EXAMPLE
> >
PS> Get-WmiObject -Class win32_logicaldisk | select -Property DeviceId,VolumeName, Size,Freespace | PS> Get-WmiObject -Class win32_logicaldisk | Select-Object -Property DeviceId,VolumeName, Size,Freespace |
Export-Excel -Path "$env:computerName.xlsx" -WorkSheetname Volumes -NumberFormat "0,000" Export-Excel -Path "$env:computerName.xlsx" -WorkSheetname Volumes -NumberFormat "0,000"
Get-NetAdapter | Select-Object Name,InterfaceDescription,MacAddress,LinkSpeed | PS> Get-NetAdapter | Select-Object Name,InterfaceDescription,MacAddress,LinkSpeed |
Export-Excel -Path "$env:COMPUTERNAME.xlsx" -WorkSheetname NetAdapter Export-Excel -Path "$env:COMPUTERNAME.xlsx" -WorkSheetname NetAdapter
Join-Worksheet -Path "$env:COMPUTERNAME.xlsx" -WorkSheetName Summary -Title "Summary" -TitleBold -TitleSize 22 -NoHeader -LabelBlocks -AutoSize -HideSource -show PS> Join-Worksheet -Path "$env:COMPUTERNAME.xlsx" -WorkSheetName Summary -Title "Summary" -TitleBold -TitleSize 22 -NoHeader -LabelBlocks -AutoSize -HideSource -show
The first two commands get logical disk and network card information; each type is exported to its own sheet in a workbook. The first two commands get logical disk and network card information; each type is exported to its own sheet in a workbook.
The Join-worksheet command copies both onto a page named "Summary". Because the data is disimilar -NoHeader is specified, ensuring the whole of each page is copied. The Join-Worksheet command copies both onto a page named "Summary". Because the data is disimilar -NoHeader is specified, ensuring the whole of each page is copied.
Specifying -LabelBlocks causes each sheet's name to become a title on the summary page above the copied data. Specifying -LabelBlocks causes each sheet's name to become a title on the summary page above the copied data.
The source data is hidden, a title is added in 22 point boldface and the columns are sized to fit the data. The source data is hidden, a title is added in 22 point boldface and the columns are sized to fit the data.
#> #>
@@ -78,7 +76,7 @@
#Text of a title to be placed in Cell A1. #Text of a title to be placed in Cell A1.
[String]$Title, [String]$Title,
#Sets the fill pattern for the title cell. #Sets the fill pattern for the title cell.
[OfficeOpenXml.Style.ExcelFillStyle]$TitleFillPattern = 'None', [OfficeOpenXml.Style.ExcelFillStyle]$TitleFillPattern = 'Solid',
#Sets the cell background color for the title cell. #Sets the cell background color for the title cell.
[System.Drawing.Color]$TitleBackgroundColor, [System.Drawing.Color]$TitleBackgroundColor,
#Sets the title in boldface type. #Sets the title in boldface type.

View File

@@ -1,31 +1,31 @@
function New-ConditionalText { function New-ConditionalText {
<# <#
.SYNOPSIS .SYNOPSIS
Creates an object which describes a conditional formatting rule for single valued rules Creates an object which describes a conditional formatting rule for single valued rules.
.DESCRIPTION .DESCRIPTION
Some Conditional formatting rules don't apply styles to a cell (IconSets and Databars) Some Conditional formatting rules don't apply styles to a cell (IconSets and Databars).
Some take two parameters (Between) Some take two parameters (Between).
Some take none (ThisWeek , containsErrors, AboveAverage etc.) Some take none (ThisWeek , containsErrors, AboveAverage etc).
The others take a single paramter (top, BottomPercent, GreaterThan, Contains etc) The others take a single parameter (Top, BottomPercent, GreaterThan, Contains etc).
This command creates an object to describe the last two categories, which can be passed to Export-Excel This command creates an object to describe the last two categories, which can then be passed to Export-Excel.
.PARAMETER Range .PARAMETER Range
The range of cells that the conditional format applies to; if none is specified the range will be apply to all the data in the sheet The range of cells that the conditional format applies to; if none is specified the range will be apply to all the data in the sheet.
.PARAMETER ConditionalType .PARAMETER ConditionalType
One the supported rules by default - "ContainsText" is selected One of the supported rules; by default "ContainsText" is selected.
.PARAMETER Text .PARAMETER Text
The text (or other value) to use in the rule. Not that Equals, GreaterThan/LessThan rules require text to wrapped in double quotes The text (or other value) to use in the rule. Not that Equals, GreaterThan/LessThan rules require text to wrapped in double quotes.
.PARAMETER ConditionalTextColor .PARAMETER ConditionalTextColor
The font color for the cell - by default: Dark red The font color for the cell - by default: Dark red.
.PARAMETER BackgroundColor .PARAMETER BackgroundColor
The fill color for the cell - by default: light pink The fill color for the cell - by default: Light pink.
.PARAMETER PatternType .PARAMETER PatternType
The Background pattern for the cell - by deault: Solid The Background pattern for the cell - by default: Solid
.EXAMPLE .EXAMPLE
$ct = New-ConditionalText -Text 'Ferrari' $ct = New-ConditionalText -Text 'Ferrari'
Export-Excel -ExcelPackage $excel -ConditionalTest $ct -show Export-Excel -ExcelPackage $excel -ConditionalTest $ct -show
The first line creates a definition object which will highlight the word "Ferrari" in any cell. The first line creates a definition object which will highlight the word "Ferrari" in any cell.
and the secind uses Export-Excel with an open package to apply the format and save and open the file. and the second uses Export-Excel with an open package to apply the format and save and open the file.
.EXAMPLE .EXAMPLE
$ct = New-ConditionalText -Text "Ferrari" $ct = New-ConditionalText -Text "Ferrari"
$ct2 = New-ConditionalText -Range $worksheet.Names["FinishPosition"].Address -ConditionalType LessThanOrEqual -Text 3 -ConditionalTextColor Red -BackgroundColor White $ct2 = New-ConditionalText -Range $worksheet.Names["FinishPosition"].Address -ConditionalType LessThanOrEqual -Text 3 -ConditionalTextColor Red -BackgroundColor White

View File

@@ -1,10 +1,12 @@
function New-ExcelChartDefinition { function New-ExcelChartDefinition {
<# <#
.SYNOPSIS .SYNOPSIS
Creates a Definition of a chart which can be added using Export Excel Creates a Definition of a chart which can be added using Export-Excel, or Add-PivotTable
.DESCRIPTION .DESCRIPTION
All the parameters which are passed to Add-ExcelChart can be added to an object and All the parameters which are passed to Add-ExcelChart can be added to an object and
passed to Export-Excel with the -ExcelChartDefinition parameter. This command sets up those objects. passed to Export-Excel with the -ExcelChartDefinition parameter,
or to Add-PivotTable with the -PivotChartDefinition parameter.
This command sets up those definitions.
.PARAMETER Title .PARAMETER Title
The title for the chart. The title for the chart.
.PARAMETER TitleBold .PARAMETER TitleBold
@@ -12,7 +14,7 @@ function New-ExcelChartDefinition {
.PARAMETER TitleSize .PARAMETER TitleSize
Sets the point size for the title. Sets the point size for the title.
.PARAMETER ChartType .PARAMETER ChartType
One of the built in chart types, such as Pie, ClusteredColumn, Line etc. Defaults to "ColumnStacked". One of the built-in chart types, such as Pie, ClusteredColumn, Line etc. Defaults to "ColumnStacked".
.PARAMETER XRange .PARAMETER XRange
The range of cells containing values for the X-Axis - usually labels. The range of cells containing values for the X-Axis - usually labels.
.PARAMETER YRange .PARAMETER YRange
@@ -24,69 +26,69 @@ function New-ExcelChartDefinition {
.PARAMETER Row .PARAMETER Row
Row position of the top left corner of the chart. 0 places at the top of the sheet, 1 below row 1 and so on. Row position of the top left corner of the chart. 0 places at the top of the sheet, 1 below row 1 and so on.
.PARAMETER RowOffSetPixels .PARAMETER RowOffSetPixels
Offset to postion the chart by a fraction of of a row . Offset to position the chart by a fraction of of a row.
.PARAMETER Column .PARAMETER Column
Column Postion of the top left corner of the chart. 0 places at the edge of the sheet 1 to the right of column A and so on. Column position of the top left corner of the chart. 0 places at the edge of the sheet 1 to the right of column A and so on.
.PARAMETER ColumnOffSetPixels .PARAMETER ColumnOffSetPixels
Offset to postion the chart by a fraction of of a column. Offset to position the chart by a fraction of of a column.
.PARAMETER NoLegend .PARAMETER NoLegend
If specified, turns of display of the key. If you only have one data series it may be preferable to use the title to say what the chart is. If specified, turns of display of the key. If you only have one data series it may be preferable to use the title to say what the chart is.
.PARAMETER SeriesHeader .PARAMETER SeriesHeader
Specify explicit name(s) for the data series, which will appear in the legend/key Specify explicit name(s) for the data series, which will appear in the legend/key
.PARAMETER LegendPostion .PARAMETER LegendPosition
Location of the key, either left, right, top, bottom or TopRight. Location of the key, either left, right, top, bottom or TopRight.
.PARAMETER LegendSize .PARAMETER LegendSize
Font size for the key Font size for the key.
.PARAMETER LegendBold .PARAMETER LegendBold
Sets the key in bold type. Sets the key in bold type.
.PARAMETER ShowCategory .PARAMETER ShowCategory
Attaches a category label in charts which support this. Attaches a category label in charts which support this.
.PARAMETER ShowPercent .PARAMETER ShowPercent
Attaches a pecentage label in charts which support this. Attaches a percentage label in charts which support this.
.PARAMETER XAxisTitleText .PARAMETER XAxisTitleText
Specifies a title for the X axis. Specifies a title for the X-axis.
.PARAMETER XAxisTitleBold .PARAMETER XAxisTitleBold
Sets the X axis title in bold face. Sets the X-axis title in bold face.
.PARAMETER XAxisTitleSize .PARAMETER XAxisTitleSize
Sets the font size for the axis title Sets the font size for the axis title.
.PARAMETER XAxisNumberformat .PARAMETER XAxisNumberformat
A number formatting string, like "#,##0.00" for numbers along the X axis A number formatting string, like "#,##0.00", for numbers along the X-axis.
.PARAMETER XMajorUnit .PARAMETER XMajorUnit
Spacing for the major gridlines / tick marks along the X axis Spacing for the major gridlines / tick marks along the X-axis.
.PARAMETER XMinorUnit .PARAMETER XMinorUnit
Spacing for the major gridlines / tick marks along the X axis Spacing for the minor gridlines / tick marks along the X-axis.
.PARAMETER XMaxValue .PARAMETER XMaxValue
Maximum value for the scale along the Xaxis Maximum value for the scale along the X-axis.
.PARAMETER XMinValue .PARAMETER XMinValue
Minimum value for the scale along the Xaxis Minimum value for the scale along the X-axis.
.PARAMETER xAxisPosition .PARAMETER xAxisPosition
Postion for the X axis (top or bottom) Postion for the X-axis (Top or Bottom).
.PARAMETER YAxisTitleText .PARAMETER YAxisTitleText
Specifies a title for the Y axis. Specifies a title for the Y-axis.
.PARAMETER YAxisTitleBold .PARAMETER YAxisTitleBold
Sets the Y axis title in bold face. Sets the Y-axis title in bold face.
.PARAMETER YAxisTitleSize .PARAMETER YAxisTitleSize
Sets the font size for the Y axis title Sets the font size for the Y-axis title.
.PARAMETER YAxisNumberformat .PARAMETER YAxisNumberformat
A number formatting string, like "#,##0.00" for numbers on the Y axis A number formatting string, like "#,##0.00", for numbers on the Y-axis
.PARAMETER YMajorUnit .PARAMETER YMajorUnit
Spacing for the major gridlines / tick marks on the Y axis Spacing for the major gridlines / tick marks on the Y-axis.
.PARAMETER YMinorUnit .PARAMETER YMinorUnit
Spacing for the major gridlines / tick marks on the Y axis Spacing for the minor gridlines / tick marks on the Y-axis.
.PARAMETER YMaxValue .PARAMETER YMaxValue
Maximum value on the Yaxis Maximum value on the Y-axis.
.PARAMETER YMinValue .PARAMETER YMinValue
Minimum value on the Yaxis Minimum value on the Y-axis.
.PARAMETER YAxisPosition .PARAMETER YAxisPosition
Postion for the Y axis (left or right) Postion for the Y-axis (Left or Right).
.PARAMETER Header .PARAMETER Header
No longer used. This may be removed in future versions No longer used. This may be removed in future versions.
.Example .Example
> >
PS> $cDef = New-ExcelChartDefinition -ChartType line -XRange "X" -YRange "Sinx" -Title "Graph of Sine X" -TitleBold -TitleSize 14 ` PS> $cDef = New-ExcelChartDefinition -ChartType line -XRange "X" -YRange "Sinx" -Title "Graph of Sine X" -TitleBold -TitleSize 14 `
-Column 2 -ColumnOffSetPixels 35 -Width 800 -XAxisTitleText "Degrees" -XAxisTitleBold -XAxisTitleSize 12 -XMajorUnit 30 -XMinorUnit 10 -XMinValue 0 -XMaxValue 361 -XAxisNumberformat "000" ` -Column 2 -ColumnOffSetPixels 35 -Width 800 -XAxisTitleText "Degrees" -XAxisTitleBold -XAxisTitleSize 12 -XMajorUnit 30 -XMinorUnit 10 -XMinValue 0 -XMaxValue 361 -XAxisNumberformat "000" `
-YMinValue -1.25 -YMaxValue 1.25 -YMajorUnit 0.25 -YAxisNumberformat "0.00" -YAxisTitleText "Sine" -YAxisTitleBold -YAxisTitleSize 12 ` -YMinValue -1.25 -YMaxValue 1.25 -YMajorUnit 0.25 -YAxisNumberformat "0.00" -YAxisTitleText "Sine" -YAxisTitleBold -YAxisTitleSize 12 `
-SeriesHeader "Sin(x)" -LegendSize 8 -legendBold -LegendPostion Bottom -SeriesHeader "Sin(x)" -LegendSize 8 -legendBold -LegendPosition Bottom
0..360 | ForEach-Object {[pscustomobject][ordered]@{x = $_; Sinx = "=Sin(Radians(x)) "}} | Export-Excel -AutoNameRange -now -WorkSheetname SinX -ExcelChartDefinition $cDef -Show 0..360 | ForEach-Object {[pscustomobject][ordered]@{x = $_; Sinx = "=Sin(Radians(x)) "}} | Export-Excel -AutoNameRange -now -WorkSheetname SinX -ExcelChartDefinition $cDef -Show
@@ -106,7 +108,7 @@ function New-ExcelChartDefinition {
$RowOffSetPixels = 10, $RowOffSetPixels = 10,
$Column = 6, $Column = 6,
$ColumnOffSetPixels = 5, $ColumnOffSetPixels = 5,
[OfficeOpenXml.Drawing.Chart.eLegendPosition]$LegendPostion, [OfficeOpenXml.Drawing.Chart.eLegendPosition]$LegendPosition,
$LegendSize, $LegendSize,
[Switch]$LegendBold, [Switch]$LegendBold,
[Switch]$NoLegend, [Switch]$NoLegend,
@@ -147,7 +149,7 @@ function New-ExcelChartDefinition {
RowOffSetPixels = $RowOffSetPixels RowOffSetPixels = $RowOffSetPixels
Column = $Column Column = $Column
ColumnOffSetPixels = $ColumnOffSetPixels ColumnOffSetPixels = $ColumnOffSetPixels
LegendPostion = $LegendPostion LegendPosition = $LegendPosition
LegendSize = $LegendSize LegendSize = $LegendSize
Legendbold = $LegendBold Legendbold = $LegendBold
NoLegend = $NoLegend -as [Boolean] NoLegend = $NoLegend -as [Boolean]
@@ -180,13 +182,13 @@ function New-ExcelChartDefinition {
function Add-ExcelChart { function Add-ExcelChart {
<# <#
.SYNOPSIS .SYNOPSIS
Creates a chart in an existing Excel worksheet Creates a chart in an existing Excel worksheet.
.DESCRIPTION .DESCRIPTION
Creates a chart. It is possible to configure the type of chart, the range of X values (labels) and Y values. Creates a chart. It is possible to configure the type of chart, the range of X values (labels) and Y values.
the title, the legend, the ranges for both axes, the format and postion of the axes. the title, the legend, the ranges for both axes, the format and position of the axes.
Normally the command does not return anything, but if -passthru is specified the chart is returned so that it can be customized. Normally the command does not return anything, but if -passthru is specified the chart is returned so that it can be customized.
.PARAMETER Worksheet .PARAMETER Worksheet
An exisiting Sheet where the chart will be created. An existing Sheet where the chart will be created.
.PARAMETER Title .PARAMETER Title
The title for the chart. The title for the chart.
.PARAMETER TitleBold .PARAMETER TitleBold
@@ -194,7 +196,7 @@ function Add-ExcelChart {
.PARAMETER TitleSize .PARAMETER TitleSize
Sets the point size for the title. Sets the point size for the title.
.PARAMETER ChartType .PARAMETER ChartType
One of the built in chart types, such as Pie, ClusteredColumn, Line etc. Defaults to "ColumnStacked". One of the built-in chart types, such as Pie, ClusteredColumn, Line etc. Defaults to "ColumnStacked".
.PARAMETER XRange .PARAMETER XRange
The range of cells containing values for the X-Axis - usually labels. The range of cells containing values for the X-Axis - usually labels.
.PARAMETER YRange .PARAMETER YRange
@@ -208,63 +210,63 @@ function Add-ExcelChart {
.PARAMETER Row .PARAMETER Row
Row position of the top left corner of the chart. 0 places at the top of the sheet, 1 below row 1 and so on. Row position of the top left corner of the chart. 0 places at the top of the sheet, 1 below row 1 and so on.
.PARAMETER RowOffSetPixels .PARAMETER RowOffSetPixels
Offset to postion the chart by a fraction of of a row . Offset to position the chart by a fraction of a row.
.PARAMETER Column .PARAMETER Column
Column Postion of the top left corner of the chart. 0 places at the edge of the sheet 1 to the right of column A and so on. Column position of the top left corner of the chart. 0 places at the edge of the sheet 1 to the right of column A and so on.
.PARAMETER ColumnOffSetPixels .PARAMETER ColumnOffSetPixels
Offset to postion the chart by a fraction of of a column. Offset to position the chart by a fraction of a column.
.PARAMETER NoLegend .PARAMETER NoLegend
If specified, turns of display of the key. If you only have one data series it may be preferable to use the title to say what the chart is. If specified, turns of display of the key. If you only have one data series it may be preferable to use the title to say what the chart is.
.PARAMETER SeriesHeader .PARAMETER SeriesHeader
Specify explicit name(s) for the data series, which will appear in the legend/key Specify explicit name(s) for the data series, which will appear in the legend/key
.PARAMETER LegendPostion .PARAMETER LegendPosition
Location of the key, either left, right, top, bottom or TopRight. Location of the key, either left, right, top, bottom or TopRight.
.PARAMETER LegendSize .PARAMETER LegendSize
Font size for the key Font size for the key.
.PARAMETER LegendBold .PARAMETER LegendBold
Sets the key in bold type. Sets the key in bold type.
.PARAMETER ShowCategory .PARAMETER ShowCategory
Attaches a category label in charts which support this. Attaches a category label in charts which support this.
.PARAMETER ShowPercent .PARAMETER ShowPercent
Attaches a pecentage label in charts which support this. Attaches a percentage label in charts which support this.
.PARAMETER XAxisTitleText .PARAMETER XAxisTitleText
Specifies a title for the X axis. Specifies a title for the X-axis.
.PARAMETER XAxisTitleBold .PARAMETER XAxisTitleBold
Sets the X axis title in bold face. Sets the X-axis title in bold face.
.PARAMETER XAxisTitleSize .PARAMETER XAxisTitleSize
Sets the font size for the axis title Sets the font size for the axis title.
.PARAMETER XAxisNumberformat .PARAMETER XAxisNumberformat
A number formatting string, like "#,##0.00" for numbers along the X axis A number formatting string, like "#,##0.00", for numbers along the X-axis.
.PARAMETER XMajorUnit .PARAMETER XMajorUnit
Spacing for the major gridlines / tick marks along the X axis Spacing for the major gridlines / tick marks along the X-axis.
.PARAMETER XMinorUnit .PARAMETER XMinorUnit
Spacing for the major gridlines / tick marks along the X axis Spacing for the minor gridlines / tick marks along the X-axis.
.PARAMETER XMaxValue .PARAMETER XMaxValue
Maximum value for the scale along the Xaxis Maximum value for the scale along the X-axis.
.PARAMETER XMinValue .PARAMETER XMinValue
Minimum value for the scale along the Xaxis Minimum value for the scale along the X-axis.
.PARAMETER xAxisPosition .PARAMETER xAxisPosition
Postion for the X axis (top or bottom) Position for the X-axis (Top or Bottom).
.PARAMETER YAxisTitleText .PARAMETER YAxisTitleText
Specifies a title for the Y axis. Specifies a title for the Y-axis.
.PARAMETER YAxisTitleBold .PARAMETER YAxisTitleBold
Sets the Y axis title in bold face. Sets the Y-axis title in bold face.
.PARAMETER YAxisTitleSize .PARAMETER YAxisTitleSize
Sets the font size for the Y axis title Sets the font size for the Y-axis title
.PARAMETER YAxisNumberformat .PARAMETER YAxisNumberformat
A number formatting string, like "#,##0.00" for numbers on the Y axis A number formatting string, like "#,##0.00", for numbers on the Y-axis.
.PARAMETER YMajorUnit .PARAMETER YMajorUnit
Spacing for the major gridlines / tick marks on the Y axis Spacing for the major gridlines / tick marks on the Y-axis.
.PARAMETER YMinorUnit .PARAMETER YMinorUnit
Spacing for the major gridlines / tick marks on the Y axis Spacing for the minor gridlines / tick marks on the Y-axis.
.PARAMETER YMaxValue .PARAMETER YMaxValue
Maximum value on the Yaxis Maximum value on the Y-axis.
.PARAMETER YMinValue .PARAMETER YMinValue
Minimum value on the Yaxis Minimum value on the Y-axis.
.PARAMETER YAxisPosition .PARAMETER YAxisPosition
Postion for the Y axis (left or right) Position for the Y-axis (Left or Right).
.PARAMETER PassThru .PARAMETER PassThru
Add-Excel chart doesn't normally return anything, but if -PassThru is specified it returns the newly created chart to allow it to be fine tuned Add-Excel chart doesn't normally return anything, but if -PassThru is specified it returns the newly created chart to allow it to be fine tuned.
.EXAMPLE .EXAMPLE
> >
PS> $Excel = ConvertFrom-Csv @" PS> $Excel = ConvertFrom-Csv @"
@@ -280,8 +282,8 @@ function Add-ExcelChart {
Close-ExcelPackage -Show $Excel Close-ExcelPackage -Show $Excel
The first command expands a multi-line string into 6 rows of data which is exported to new Excel file; leaving an ExcelPackage object in $excel The first command expands a multi-line string into 6 rows of data which is exported to new Excel file; leaving an ExcelPackage object in $excel
The second command adds a chart - the cell ranges are explitly specified. Note the at the XRange (labels) is TWO columns wide and the chart will The second command adds a chart - the cell ranges are explicitly specified. Note that the XRange (labels) is TWO columns wide and the chart will
combine the name of the product and the name of the City to create the table. combine the name of the product and the name of the City to create the label.
The width of the chart is set explictly, the default legend is used and there is no Chart title. The width of the chart is set explictly, the default legend is used and there is no Chart title.
.EXAMPLE .EXAMPLE
> >
@@ -307,16 +309,20 @@ function Add-ExcelChart {
Add-ExcelChart -Worksheet $excel.Workbook.Worksheets["Sinx"] -ChartType line -XRange "X" -YRange "Sinx" -Title "Graph of Sine X" -TitleBold -TitleSize 14 ` Add-ExcelChart -Worksheet $excel.Workbook.Worksheets["Sinx"] -ChartType line -XRange "X" -YRange "Sinx" -Title "Graph of Sine X" -TitleBold -TitleSize 14 `
-Column 2 -ColumnOffSetPixels 35 -Width 800 -XAxisTitleText "Degrees" -XAxisTitleBold -XAxisTitleSize 12 -XMajorUnit 30 -XMinorUnit 10 -XMinValue 0 -XMaxValue 361 -XAxisNumberformat "000" ` -Column 2 -ColumnOffSetPixels 35 -Width 800 -XAxisTitleText "Degrees" -XAxisTitleBold -XAxisTitleSize 12 -XMajorUnit 30 -XMinorUnit 10 -XMinValue 0 -XMaxValue 361 -XAxisNumberformat "000" `
-YMinValue -1.25 -YMaxValue 1.25 -YMajorUnit 0.25 -YAxisNumberformat "0.00" -YAxisTitleText "Sine" -YAxisTitleBold -YAxisTitleSize 12 ` -YMinValue -1.25 -YMaxValue 1.25 -YMajorUnit 0.25 -YAxisNumberformat "0.00" -YAxisTitleText "Sine" -YAxisTitleBold -YAxisTitleSize 12 `
-SeriesHeader "Sin(x)" -LegendSize 8 -legendBold -LegendPostion Bottom -SeriesHeader "Sin(x)" -LegendSize 8 -legendBold -LegendPosition Bottom
Close-ExcelPackage $Excel -Show Close-ExcelPackage $Excel -Show
The first line puts numbers from 0 to 360 into a sheet, as the first column, and a formula to calculate the Sine of that number of number of degrees in the second column. The first line puts numbers from 0 to 360 into a sheet, as the first column, and
It creates ranges for the two columns - "X" and "SinX" respectively a formula to calculate the Sine of that number of number of degrees in the second column.
The Add-Excel chart colum adds a chart to that work sheet, specifying a line chart with the X values comming from named range "X" and the the Y values comming the range named "SinX". It creates named-ranges for the two columns - "X" and "SinX" respectively
The chart has a title, and is positioned to the right of column 2 and sized 8000 pixels wide The Add-ExcelChart command adds a chart to that worksheet, specifying a line chart
Thed X axis s labeled "Degrees", in bold 12 point type and runs from 0 to 361 with labels every 30, and minor tick marks every 10. Degres are shown badded to 3 didits. with the X values coming from named-range "X" and the Y values coming from named-range "SinX".
The Y axis is labeled "Sine" and to allow some room above and below its scale runs from -1.25 to 1.25, and is marked off in units of 0.25 show to two decimal places. The chart has a title, and is positioned to the right of column 2 and sized 800 pixels wide
The key will for the chart will be at the bottom in 8 point bold type and the line will be named "Sin(x)" The X-axis is labelled "Degrees", in bold 12 point type and runs from 0 to 361 with labels every 30,
and minor tick marks every 10. Degrees are shown padded to 3 digits.
The Y-axis is labelled "Sine" and to allow some room above and below its scale runs from -1.25 to 1.25,
and is marked off in units of 0.25 shown to two decimal places.
The key will for the chart will be at the bottom in 8 point bold type and the line will be named "Sin(x)".
#> #>
[cmdletbinding(DefaultParameterSetName='Worksheet')] [cmdletbinding(DefaultParameterSetName='Worksheet')]
[OutputType([OfficeOpenXml.Drawing.Chart.ExcelChart])] [OutputType([OfficeOpenXml.Drawing.Chart.ExcelChart])]
@@ -336,7 +342,7 @@ function Add-ExcelChart {
[int]$RowOffSetPixels = 10, [int]$RowOffSetPixels = 10,
[int]$Column = 6, [int]$Column = 6,
[int]$ColumnOffSetPixels = 5, [int]$ColumnOffSetPixels = 5,
[OfficeOpenXml.Drawing.Chart.eLegendPosition]$LegendPostion, [OfficeOpenXml.Drawing.Chart.eLegendPosition]$LegendPosition,
$LegendSize, $LegendSize,
[Switch]$LegendBold, [Switch]$LegendBold,
[Switch]$NoLegend, [Switch]$NoLegend,
@@ -394,7 +400,7 @@ function Add-ExcelChart {
} }
if ($NoLegend) { $chart.Legend.Remove() } if ($NoLegend) { $chart.Legend.Remove() }
else { else {
if ($LegendPostion) {$Chart.Legend.Position = $LegendPostion} if ($LegendPosition) {$Chart.Legend.Position = $LegendPosition}
if ($LegendSize) {$chart.Legend.Font.Size = $LegendSize} if ($LegendSize) {$chart.Legend.Font.Size = $LegendSize}
if ($legendBold) {$chart.Legend.Font.Bold = $true} if ($legendBold) {$chart.Legend.Font.Bold = $true}
} }
@@ -404,7 +410,7 @@ function Add-ExcelChart {
if ($XAxisTitleBold) {$chart.XAxis.Title.Font.Bold = $true} if ($XAxisTitleBold) {$chart.XAxis.Title.Font.Bold = $true}
if ($XAxisTitleSize) {$chart.XAxis.Title.Font.Size = $XAxisTitleSize} if ($XAxisTitleSize) {$chart.XAxis.Title.Font.Size = $XAxisTitleSize}
} }
if ($XAxisPosition) {Write-Warning "X Axis position is not being set propertly at the moment, parameter ignored" } if ($XAxisPosition) {Write-Warning "X-axis position is not being set propertly at the moment, parameter ignored" }
#$chart.ChartXml.chartSpace.chart.plotArea.catAx.axPos.val = $XAxisPosition.ToString().substring(0,1)} #$chart.ChartXml.chartSpace.chart.plotArea.catAx.axPos.val = $XAxisPosition.ToString().substring(0,1)}
if ($XMajorUnit) {$chart.XAxis.MajorUnit = $XMajorUnit} if ($XMajorUnit) {$chart.XAxis.MajorUnit = $XMajorUnit}
if ($XMinorUnit) {$chart.XAxis.MinorUnit = $XMinorUnit} if ($XMinorUnit) {$chart.XAxis.MinorUnit = $XMinorUnit}
@@ -417,7 +423,7 @@ function Add-ExcelChart {
if ($YAxisTitleBold) {$chart.YAxis.Title.Font.Bold = $true} if ($YAxisTitleBold) {$chart.YAxis.Title.Font.Bold = $true}
if ($YAxisTitleSize) {$chart.YAxis.Title.Font.Size = $YAxisTitleSize} if ($YAxisTitleSize) {$chart.YAxis.Title.Font.Size = $YAxisTitleSize}
} }
if ($YAxisPosition) {Write-Warning "Y Axis position is not being set propertly at the moment, parameter ignored" } if ($YAxisPosition) {Write-Warning "Y-axis position is not being set propertly at the moment, parameter ignored" }
#$chart.ChartXml.chartSpace.chart.plotArea.valAx.axPos.val= $YAxisPosition.ToString().substring(0,1)} #$chart.ChartXml.chartSpace.chart.plotArea.valAx.axPos.val= $YAxisPosition.ToString().substring(0,1)}
if ($YMajorUnit) {$chart.YAxis.MajorUnit = $YMajorUnit} if ($YMajorUnit) {$chart.YAxis.MajorUnit = $YMajorUnit}
if ($YMinorUnit) {$chart.YAxis.MinorUnit = $YMinorUnit} if ($YMinorUnit) {$chart.YAxis.MinorUnit = $YMinorUnit}

View File

@@ -73,9 +73,10 @@ Function Close-ExcelPackage {
.Synopsis .Synopsis
Closes an Excel Package, saving, saving under a new name or abandoning changes and opening the file in Excel as required. Closes an Excel Package, saving, saving under a new name or abandoning changes and opening the file in Excel as required.
.Description .Description
When working with an Excel packaage object the workbook is held in memory and not saved until the Save() method of the package is called. When working with an ExcelPackage object, the Workbook is held in memory and not saved until the .Save() method of the package is called.
Close package saves and disposes of the package object. It can be called with -NoSave to abandon the file without saving, with a new "SaveAs" filename Close-ExcelPackage saves and disposes of the Package object. It can be called with -NoSave to abandon the file without saving, with a new "SaveAs" filename,
with a password to protect the file. And with Show to open it in Excel. -Calculate will try to update the workbook, although not everything can be recalculated and/or with a password to protect the file. And -Show will open the file in Excel;
-Calculate will try to update the workbook, although not everything can be recalculated
.Example .Example
Close-ExcelPackage -show $excel Close-ExcelPackage -show $excel
$excel holds a package object, this saves the workbook and loads it into Excel. $excel holds a package object, this saves the workbook and loads it into Excel.

View File

@@ -1,9 +1,9 @@
function Add-PivotTable { function Add-PivotTable {
<# <#
.Synopsis .Synopsis
Adds a Pivot table (and optional pivot chart) to a workbook Adds a PivotTable (and optional PivotChart) to a workbook.
.Description .Description
If the pivot table already exists, the source data will be updated. If the PivotTable already exists, the source data will be updated.
.Example .Example
> >
PS> $excel = Get-Service | Export-Excel -Path test.xlsx -WorksheetName Services -PassThru -AutoSize -DisplayPropertySet -TableName ServiceTable -Title "Services on $Env:COMPUTERNAME" PS> $excel = Get-Service | Export-Excel -Path test.xlsx -WorksheetName Services -PassThru -AutoSize -DisplayPropertySet -TableName ServiceTable -Title "Services on $Env:COMPUTERNAME"
@@ -15,7 +15,7 @@
.Example .Example
> >
PS> $chartdef = New-ExcelChartDefinition -Title "Gross and net by city and product" -ChartType ColumnClustered ` PS> $chartdef = New-ExcelChartDefinition -Title "Gross and net by city and product" -ChartType ColumnClustered `
-Column 11 -Width 500 -Height 360 -YMajorUnit 500 -YMinorUnit 100 -YAxisNumberformat "$#,##0" -LegendPostion Bottom -Column 11 -Width 500 -Height 360 -YMajorUnit 500 -YMinorUnit 100 -YAxisNumberformat "$#,##0" -LegendPosition Bottom
$excel = ConvertFrom-Csv @" $excel = ConvertFrom-Csv @"
Product, City, Gross, Net Product, City, Gross, Net
@@ -34,66 +34,66 @@
This script starts by defining a chart. Then it exports some data to an XLSX file and keeps the file open. This script starts by defining a chart. Then it exports some data to an XLSX file and keeps the file open.
The next step is to add the pivot table, normally this would be on its own sheeet in the workbook, The next step is to add the pivot table, normally this would be on its own sheet in the workbook,
but here -Address is specified to place it beside the data. The Add-Pivot table is given the chart definition and told to create a tale but here -Address is specified to place it beside the data. The Add-Pivot table is given the chart definition and told to create a tale
using the City field to create rows, the Product field to create columns and the data should be the sum of the gross field and the sum of the net field; using the City field to create rows, the Product field to create columns and the data should be the sum of the gross field and the sum of the net field;
grand totals for both gross and net are included for rows (Cities) and columns (product) and the the data is explicitly formatted as a currency. grand totals for both gross and net are included for rows (Cities) and columns (product) and the data is explicitly formatted as a currency.
Not that in thee the chart definition the number format for the axis does not include any fraction part Not that in the chart definition the number format for the axis does not include any fraction part.
#> #>
[cmdletbinding(defaultParameterSetName='ChartbyParams')] [cmdletbinding(defaultParameterSetName='ChartbyParams')]
[OutputType([OfficeOpenXml.Table.PivotTable.ExcelPivotTable])] [OutputType([OfficeOpenXml.Table.PivotTable.ExcelPivotTable])]
param ( param (
#Name for the new Pivot table - this will be the name of a sheet in the workbook #Name for the new PivotTable - this will be the name of a sheet in the Workbook.
[Parameter(Mandatory = $true)] [Parameter(Mandatory = $true)]
[string]$PivotTableName, [string]$PivotTableName,
#By default a pivot table will be created on its own sheet, but it can be created on an existing sheet by giving the address where the top left corner of the table should go. (Allow two rows for the filter if one is used.) #By default, a PivotTable will be created on its own sheet, but it can be created on an existing sheet by giving the address where the top left corner of the table should go. (Allow two rows for the filter if one is used.)
[OfficeOpenXml.ExcelAddressBase] [OfficeOpenXml.ExcelAddressBase]
$Address, $Address,
#An excel package object for the workbook. #An excel package object for the workbook.
$ExcelPackage, $ExcelPackage,
#Worksheet where the data is found #Worksheet where the data is found.
$SourceWorkSheet, $SourceWorkSheet,
#Address range in the worksheet e.g "A10:F20" - the first row must be column names: if not specified the whole sheet will be used. #Address range in the worksheet e.g "A10:F20" - the first row must be column names: if not specified the whole sheet will be used.
$SourceRange, $SourceRange,
#Fields to set as rows in the Pivot table #Fields to set as rows in the PivotTable.
$PivotRows, $PivotRows,
#A hash table in form "FieldName"="Function", where function is one of #A hash table in form "FieldName"="Function", where function is one of
#Average, Count, CountNums, Max, Min, Product, None, StdDev, StdDevP, Sum, Var, VarP #Average, Count, CountNums, Max, Min, Product, None, StdDev, StdDevP, Sum, Var, VarP.
$PivotData, $PivotData,
#Fields to set as columns in the Pivot table #Fields to set as columns in the PivotTable.
$PivotColumns, $PivotColumns,
#Fields to use to filter in the Pivot table #Fields to use to filter in the PivotTable.
$PivotFilter, $PivotFilter,
#If there are multiple datasets in a PivotTable, by default they are shown seperatate rows under the given row heading; this switch makes them seperate columns. #If there are multiple data items in a PivotTable, by default they are shown on separate rows; this switch makes them separate columns.
[Switch]$PivotDataToColumn, [Switch]$PivotDataToColumn,
#Define whther totals should be added to rows, columns neither, or both (the default is both) #Define whether totals should be added to rows, columns neither, or both (the default is both).
[ValidateSet("Both","Columns","Rows","None")] [ValidateSet("Both","Columns","Rows","None")]
[String]$PivotTotals = "Both", [String]$PivotTotals = "Both",
#Included for compatibility - equivalent to -PivotTotals "None" #Included for compatibility - equivalent to -PivotTotals "None".
[Switch]$NoTotalsInPivot, [Switch]$NoTotalsInPivot,
#Number format to apply to the data cells in the Pivot table #Number format to apply to the data cells in the PivotTable.
[string]$PivotNumberFormat, [string]$PivotNumberFormat,
#Apply a table style to the PivotTable #Apply a table style to the PivotTable.
[OfficeOpenXml.Table.TableStyles]$PivotTableSyle, [OfficeOpenXml.Table.TableStyles]$PivotTableSyle,
#Use a chart definition instead of specifying chart settings one by one #Use a chart definition instead of specifying chart settings one by one.
[Parameter(ParameterSetName='ChartbyDef', Mandatory=$true, ValueFromPipelineByPropertyName=$true)] [Parameter(ParameterSetName='ChartbyDef', Mandatory=$true, ValueFromPipelineByPropertyName=$true)]
$PivotChartDefinition, $PivotChartDefinition,
#If specified a chart Will be included. #If specified, a chart will be included.
[Parameter(ParameterSetName='ChartbyParams')] [Parameter(ParameterSetName='ChartbyParams')]
[Switch]$IncludePivotChart, [Switch]$IncludePivotChart,
#Optional title for the pivot chart, by default the title omitted. #Optional title for the pivot chart, by default the title omitted.
[Parameter(ParameterSetName='ChartbyParams')] [Parameter(ParameterSetName='ChartbyParams')]
[String]$ChartTitle = "", [String]$ChartTitle = "",
#Height of the chart in Pixels (400 by default) #Height of the chart in Pixels (400 by default).
[Parameter(ParameterSetName='ChartbyParams')] [Parameter(ParameterSetName='ChartbyParams')]
[int]$ChartHeight = 400 , [int]$ChartHeight = 400 ,
#Width of the chart in Pixels (600 by default) #Width of the chart in Pixels (600 by default).
[Parameter(ParameterSetName='ChartbyParams')] [Parameter(ParameterSetName='ChartbyParams')]
[int]$ChartWidth = 600, [int]$ChartWidth = 600,
#Cell position of the top left corner of the chart, there will be this number of rows above the top edge of the chart (default is 0, chart starts at top edge of row 1). #Cell position of the top left corner of the chart, there will be this number of rows above the top edge of the chart (default is 0, chart starts at top edge of row 1).
[Parameter(ParameterSetName='ChartbyParams')] [Parameter(ParameterSetName='ChartbyParams')]
[Int]$ChartRow = 0 , [Int]$ChartRow = 0 ,
#Cell position of the top left corner of the chart, there will be this number of cells to the left of the chart (default is 4, chart starts at left edge of column E) #Cell position of the top left corner of the chart, there will be this number of cells to the left of the chart (default is 4, chart starts at left edge of column E).
[Parameter(ParameterSetName='ChartbyParams')] [Parameter(ParameterSetName='ChartbyParams')]
[Int]$ChartColumn = 4, [Int]$ChartColumn = 4,
#Vertical offset of the chart from the cell corner. #Vertical offset of the chart from the cell corner.
@@ -102,25 +102,25 @@
[Parameter(ParameterSetName='ChartbyParams')] [Parameter(ParameterSetName='ChartbyParams')]
#Horizontal offset of the chart from the cell corner. #Horizontal offset of the chart from the cell corner.
[Int]$ChartColumnOffSetPixels = 0, [Int]$ChartColumnOffSetPixels = 0,
#Type of chart #Type of chart; defaults to "Pie".
[Parameter(ParameterSetName='ChartbyParams')] [Parameter(ParameterSetName='ChartbyParams')]
[OfficeOpenXml.Drawing.Chart.eChartType]$ChartType = 'Pie', [OfficeOpenXml.Drawing.Chart.eChartType]$ChartType = 'Pie',
#If specified hides the chart legend #If specified hides the chart legend.
[Parameter(ParameterSetName='ChartbyParams')] [Parameter(ParameterSetName='ChartbyParams')]
[Switch]$NoLegend, [Switch]$NoLegend,
#if specified attaches the category to slices in a pie chart : not supported on all chart types, this may give errors if applied to an unsupported type. #If specified attaches the category to slices in a pie chart : not supported on all chart types, this may give errors if applied to an unsupported type.
[Parameter(ParameterSetName='ChartbyParams')] [Parameter(ParameterSetName='ChartbyParams')]
[Switch]$ShowCategory, [Switch]$ShowCategory,
#If specified attaches percentages to slices in a pie chart. #If specified attaches percentages to slices in a pie chart.
[Parameter(ParameterSetName='ChartbyParams')] [Parameter(ParameterSetName='ChartbyParams')]
[Switch]$ShowPercent, [Switch]$ShowPercent,
#If there is already content in the workbook the sheet with the Pivot table will not be active UNLESS Activate is specified #If there is already content in the workbook the sheet with the PivotTable will not be active UNLESS Activate is specified.
[switch]$Activate, [switch]$Activate,
#Return the pivot table so it can be customized #Return the PivotTable so it can be customized.
[Switch]$PassThru [Switch]$PassThru
) )
if ($PivotTableName.length -gt 250) { if ($PivotTableName.length -gt 250) {
Write-warning -Message "Pivot table name will be truncated" Write-warning -Message "PivotTable name will be truncated"
$PivotTableName = $PivotTableName.Substring(0,250) $PivotTableName = $PivotTableName.Substring(0,250)
} }
if ($Address) { if ($Address) {
@@ -130,13 +130,13 @@
try { try {
if (-not $ExcelPackage) {Write-Warning -message "This combination of Parameters needs to include the ExcelPackage." ; return } if (-not $ExcelPackage) {Write-Warning -message "This combination of Parameters needs to include the ExcelPackage." ; return }
[OfficeOpenXml.ExcelWorksheet]$wsPivot = Add-WorkSheet -ExcelPackage $ExcelPackage -WorksheetName $pivotTableName -Activate:$Activate [OfficeOpenXml.ExcelWorksheet]$wsPivot = Add-WorkSheet -ExcelPackage $ExcelPackage -WorksheetName $pivotTableName -Activate:$Activate
if ($wsPivot.Name -ne $PivotTableName) {Write-Warning -Message "The Worksheet name for the pivot table does not match the table name '$PivotTableName'; probably because excess or illegal characters were removed." } if ($wsPivot.Name -ne $PivotTableName) {Write-Warning -Message "The Worksheet name for the PivotTable does not match the table name '$PivotTableName'; probably because excess or illegal characters were removed." }
if ($PivotFilter) {$Address = $wsPivot.Cells["A3"]} else { $Address = $wsPivot.Cells["A1"]} if ($PivotFilter) {$Address = $wsPivot.Cells["A3"]} else { $Address = $wsPivot.Cells["A1"]}
} }
catch {throw "Could not create the sheet for the Pivot table. $_" } catch {throw "Could not create the sheet for the PivotTable. $_" }
} }
#if the pivot doesn't exist, create it. #if the pivot doesn't exist, create it.
if (-not $wsPivot) {throw "There was a problem getting the worksheet for the pivot table"} if (-not $wsPivot) {throw "There was a problem getting the worksheet for the PivotTable"}
if (-not $wsPivot.PivotTables[$pivotTableName] ) { if (-not $wsPivot.PivotTables[$pivotTableName] ) {
try { try {
#Accept a string or a worksheet object as $SourceWorksheet - we don't need a worksheet if we have a Rangebase . #Accept a string or a worksheet object as $SourceWorksheet - we don't need a worksheet if we have a Rangebase .
@@ -160,7 +160,7 @@
elseif ( $SourceRange -is [String] -or $SourceRange -is [OfficeOpenXml.ExcelAddress]) { elseif ( $SourceRange -is [String] -or $SourceRange -is [OfficeOpenXml.ExcelAddress]) {
$pivotTable = $wsPivot.PivotTables.Add($Address,$SourceWorkSheet.Cells[$SourceRange], $pivotTableName) $pivotTable = $wsPivot.PivotTables.Add($Address,$SourceWorkSheet.Cells[$SourceRange], $pivotTableName)
} }
else {Write-warning "Could not create a pivot table with the Source Range provided."; return} else {Write-warning "Could not create a PivotTable with the Source Range provided."; return}
foreach ($Row in $PivotRows) { foreach ($Row in $PivotRows) {
try {$null = $pivotTable.RowFields.Add($pivotTable.Fields[$Row]) } try {$null = $pivotTable.RowFields.Add($pivotTable.Fields[$Row]) }
catch {Write-Warning -message "Could not add '$row' to Rows in PivotTable $pivotTableName." } catch {Write-Warning -message "Could not add '$row' to Rows in PivotTable $pivotTableName." }
@@ -203,7 +203,7 @@
catch {Write-Warning -Message "Failed adding PivotTable '$pivotTableName': $_"} catch {Write-Warning -Message "Failed adding PivotTable '$pivotTableName': $_"}
} }
else { else {
Write-Warning -Message "Pivot table defined in $($pivotTableName) already exists, only the data range will be changed." Write-Warning -Message "PivotTable defined in $($pivotTableName) already exists, only the data range will be changed."
$pivotTable = $wsPivot.PivotTables[$pivotTableName] $pivotTable = $wsPivot.PivotTables[$pivotTableName]
if (-not $SourceRange) { $SourceRange = $SourceWorkSheet.Dimension.Address} if (-not $SourceRange) { $SourceRange = $SourceWorkSheet.Dimension.Address}
$pivotTable.CacheDefinition.CacheDefinitionXml.pivotCacheDefinition.cacheSource.worksheetSource.ref = $SourceRange $pivotTable.CacheDefinition.CacheDefinitionXml.pivotCacheDefinition.cacheSource.worksheetSource.ref = $SourceRange
@@ -230,11 +230,11 @@
function New-PivotTableDefinition { function New-PivotTableDefinition {
<# <#
.Synopsis .Synopsis
Creates Pivot table definitons for Export-Excel Creates PivotTable definitons for Export-Excel
.Description .Description
Export-Excel allows a single Pivot table to be defined using the parameters -IncludePivotTable, -PivotColumns -PivotRows, Export-Excel allows a single PivotTable to be defined using the parameters -IncludePivotTable, -PivotColumns -PivotRows,
=PivotData, -PivotFilter, -PivotTotals, -PivotDataToColumn, -IncludePivotChart and -ChartType. -PivotData, -PivotFilter, -PivotTotals, -PivotDataToColumn, -IncludePivotChart and -ChartType.
Its -PivotTableDefintion paramater allows multiple pivot tables to be defined, with additional parameters. Its -PivotTableDefintion paramater allows multiple PivotTables to be defined, with additional parameters.
New-PivotTableDefinition is a convenient way to build these definitions. New-PivotTableDefinition is a convenient way to build these definitions.
.Example .Example
> >
@@ -254,24 +254,24 @@ function New-PivotTableDefinition {
$SourceWorkSheet, $SourceWorkSheet,
#Address range in the worksheet e.g "A10:F20" - the first row must be column names: if not specified the whole sheet will be used/ #Address range in the worksheet e.g "A10:F20" - the first row must be column names: if not specified the whole sheet will be used/
$SourceRange, $SourceRange,
#Fields to set as rows in the Pivot table #Fields to set as rows in the PivotTable
$PivotRows, $PivotRows,
#A hash table in form "FieldName"="Function", where function is one of #A hash table in form "FieldName"="Function", where function is one of
#Average, Count, CountNums, Max, Min, Product, None, StdDev, StdDevP, Sum, Var, VarP #Average, Count, CountNums, Max, Min, Product, None, StdDev, StdDevP, Sum, Var, VarP
[hashtable]$PivotData, [hashtable]$PivotData,
#Fields to set as columns in the Pivot table #Fields to set as columns in the PivotTable
$PivotColumns, $PivotColumns,
#Fields to use to filter in the Pivot table #Fields to use to filter in the PivotTable
$PivotFilter, $PivotFilter,
#If there are multiple datasets in a PivotTable, by default they are shown seperatate rows under the given row heading; this switch makes them seperate columns. #If there are multiple datasets in a PivotTable, by default they are shown seperatate rows under the given row heading; this switch makes them seperate columns.
[Switch]$PivotDataToColumn, [Switch]$PivotDataToColumn,
#By default Pivot tables have Totals for each Row (on the right) and for each column at the bottom. This allows just one or neither to be selected. #By default PivotTables have Totals for each Row (on the right) and for each column at the bottom. This allows just one or neither to be selected.
#Define whther totals should be added to rows, columns neither, or both (the default is both) #Define whther totals should be added to rows, columns neither, or both (the default is both)
[ValidateSet("Both","Columns","Rows","None")] [ValidateSet("Both","Columns","Rows","None")]
[String]$PivotTotals = "Both", [String]$PivotTotals = "Both",
#Included for compatibility - equivalent to -PivotTotals "None" #Included for compatibility - equivalent to -PivotTotals "None"
[Switch]$NoTotalsInPivot, [Switch]$NoTotalsInPivot,
#Number format to apply to the data cells in the Pivot table #Number format to apply to the data cells in the PivotTable
[string]$PivotNumberFormat, [string]$PivotNumberFormat,
#Apply a table style to the PivotTable #Apply a table style to the PivotTable
[OfficeOpenXml.Table.TableStyles]$PivotTableSyle, [OfficeOpenXml.Table.TableStyles]$PivotTableSyle,
@@ -314,7 +314,7 @@ function New-PivotTableDefinition {
#If specified attaches percentages to slices in a pie chart. #If specified attaches percentages to slices in a pie chart.
[Parameter(ParameterSetName='ChartbyParams')] [Parameter(ParameterSetName='ChartbyParams')]
[Switch]$ShowPercent, [Switch]$ShowPercent,
#If there is already content in the workbook the sheet with the Pivot table will not be active UNLESS Activate is specified #If there is already content in the workbook the sheet with the PivotTable will not be active UNLESS Activate is specified
[switch]$Activate [switch]$Activate
) )
$validDataFuntions = [system.enum]::GetNames([OfficeOpenXml.Table.PivotTable.DataFieldFunctions]) $validDataFuntions = [system.enum]::GetNames([OfficeOpenXml.Table.PivotTable.DataFieldFunctions])

View File

@@ -13,6 +13,7 @@ If this project helped you reduce the time to get your job done, let me know.
<br/> <br/>
<p align="center"> <p align="center">
<a href="https://ci.appveyor.com/project/dfinke/importexcel/branch/master"><img src="https://ci.appveyor.com/api/projects/status/21hko6eqtpccrkba/branch/master?svg=true"></a> <a href="https://ci.appveyor.com/project/dfinke/importexcel/branch/master"><img src="https://ci.appveyor.com/api/projects/status/21hko6eqtpccrkba/branch/master?svg=true"></a>
<a href="https://dougfinke.visualstudio.com/ImportExcel/_build?definitionId=10"><img src="https://dougfinke.visualstudio.com/ImportExcel/_apis/build/status/ImportExcel-CI?branchName=master"></a>
</p> </p>
<p align="center"> <p align="center">
@@ -52,6 +53,23 @@ Install-Module ImportExcel -scope CurrentUser
Install-Module ImportExcel Install-Module ImportExcel
``` ```
# What's new 5.3.3
- Thank you to (lazywinadmin)[https://github.com/lazywinadmin] - Expand aliases in examples and elsewhere
- In Export-Excel fixed a bug where -AutoNameRange on pre-existing data included the header in the range.
- In Export-Excel fixed a bug which caused a zero, null, or empty string in a list of simple objects to be skipped.
- In Export-Excel improved the behaviour when a new worksheet is created without data, and Tables etc are added to it.
- In Join-Worksheet: added argument completer to -TitleBackgroundColor and set default for -TitleBackgroundStyle to 'Solid'.
- In Add-Excel chart, New-ExcelChart, tests and Examples fixed mis-spelling of "Position"
- In Send-SqlDataToExcel: improved robustness of check for no data returned.
- In Set-ExcelColumn: -column can come from the pipeline (supporting an array introduces complications for supporting script blocks); -AutoNameRange no longer requires heading to specified (so you can do 1..10 | Set-ExcelColumn -AutoNameRange ); In Set-ExcelRow: -Row can come from the pipeline
- Improved test coverage (back over 80%).
- Help and example improvements. In "Index - music.ps1" the module for querying the index can be downloaded from PowerShell gallery #requires set to demand it. In SQL+FillColumns+Pivot\example2.ps1 the GetSQL module can be downloaded and #Requires has been set. The F1 results spreadsheet is available from one drive and a link is provided.
- Added Azure DevOps continuous integration and badges <a href="https://dougfinke.visualstudio.com/ImportExcel/_build?definitionId=10"><img src="https://dougfinke.visualstudio.com/ImportExcel/_apis/build/status/ImportExcel-CI?branchName=master"></a>
# What's new in Release 5.3 # What's new in Release 5.3
- Help improvements and tidying up of examples and extra examples - Help improvements and tidying up of examples and extra examples

View File

@@ -29,6 +29,6 @@
Import-Module .\ImportExcel.psd1 -Force Import-Module .\ImportExcel.psd1 -Force
$names = Get-ExcelSheetInfo C:\Temp\testDelete.xlsx $names = Get-ExcelSheetInfo C:\Temp\testDelete.xlsx
$names | % { Remove-WorkSheet C:\Temp\testDelete.xlsx $_.Name} $names | Foreach-Object { Remove-WorkSheet C:\Temp\testDelete.xlsx $_.Name}
##Remove-WorkSheet C:\Temp\testDelete.xlsx sheet6 ##Remove-WorkSheet C:\Temp\testDelete.xlsx sheet6

View File

@@ -3,21 +3,26 @@
.SYNOPSIS .SYNOPSIS
Inserts a DataTable - returned by SQL query into an ExcelSheet, more efficiently than sending it via Export-Excel Inserts a DataTable - returned by SQL query into an ExcelSheet, more efficiently than sending it via Export-Excel
.DESCRIPTION .DESCRIPTION
This command can accept a data table object or take a SQL command and run it against a database connection. This command can accept a data table object or take a SQL statement and run it against a database connection.
If running the SQL command, it accepts an object representing a session with a SQL server or ODBC database, or a connection String to make a session. If running a SQL statement, the accepts either
It the DataTable is inserted into the Excel sheet * an object representing a session with a SQL server or ODBC database, or
It takes most of the parameters of Export-Excel, but it is more efficient than getting dataRows and piping them into Export-Excel, * a connection String to make a session.
data-rows have additional properties which need to be stripped off. The command takes most of the parameters of Export-Excel, and after inserting the table into the worksheet it
calls Export-Excel to carry out other tasks on the sheet. It is more efficient to do this than to get data-rows
and pipe them into Export-Excel, stripped off the database 'housekeeping' properties.
.PARAMETER DataTable .PARAMETER DataTable
A System.Data.DataTable object containing the data to be inserted into the spreadsheet without running a query. A System.Data.DataTable object containing the data to be inserted into the spreadsheet without running a query.
.PARAMETER Session .PARAMETER Session
An active ODBC Connection or SQL connection object representing a session with a database which will be queried to get the data . An active ODBC Connection or SQL connection object representing a session with a database which will be queried to get the data .
.PARAMETER Connection .PARAMETER Connection
Database connection string; either DSN=ODBC_Data_Source_Name, a full odbc or SQL Connection string, or the name of a SQL server. This is used to create a database session. A database connection string to be used to create a database session; either
* A Data source name written in the form DSN=ODBC_Data_Source_Name, or
* A full odbc or SQL Connection string, or
* The name of a SQL server.
.PARAMETER MSSQLServer .PARAMETER MSSQLServer
Specifies the connection string is for SQL server, not ODBC . Specifies the connection string is for SQL server, not ODBC.
.PARAMETER SQL .PARAMETER SQL
The SQL query to run against the session which was passed in -Session or set up from $Connection. The SQL query to run against the session which was passed in -Session or set up from -Connection.
.PARAMETER Database .PARAMETER Database
Switches to a specific database on a SQL server. Switches to a specific database on a SQL server.
.PARAMETER QueryTimeout .PARAMETER QueryTimeout
@@ -25,9 +30,9 @@
.PARAMETER Path .PARAMETER Path
Path to a new or existing .XLSX file. Path to a new or existing .XLSX file.
.PARAMETER WorkSheetName .PARAMETER WorkSheetName
The name of a sheet within the workbook - "Sheet1" by default . The name of a sheet within the workbook - "Sheet1" by default.
.PARAMETER KillExcel .PARAMETER KillExcel
Closes Excel - prevents errors writing to the file because Excel has it open Closes Excel - prevents errors writing to the file because Excel has it open.
.PARAMETER Title .PARAMETER Title
Text of a title to be placed in the top left cell. Text of a title to be placed in the top left cell.
.PARAMETER TitleBold .PARAMETER TitleBold
@@ -123,7 +128,8 @@
.EXAMPLE .EXAMPLE
C:\> Send-SQLDataToExcel -MsSQLserver -Connection localhost -SQL "select name,type,type_desc from [master].[sys].[all_objects]" -Path .\temp.xlsx -WorkSheetname master -AutoSize -FreezeTopRow -AutoFilter -BoldTopRow C:\> Send-SQLDataToExcel -MsSQLserver -Connection localhost -SQL "select name,type,type_desc from [master].[sys].[all_objects]" -Path .\temp.xlsx -WorkSheetname master -AutoSize -FreezeTopRow -AutoFilter -BoldTopRow
Connects to the local SQL server and selects 3 columns from [Sys].[all_objects] and exports then to a sheet named master with some basic header manager
Connects to the local SQL server and selects 3 columns from [Sys].[all_objects] and exports then to a sheet named master with some basic header management
.EXAMPLE .EXAMPLE
C:\> $SQL="SELECT top 25 DriverName, Count(RaceDate) as Races, Count(Win) as Wins, Count(Pole) as Poles, Count(FastestLap) as Fastlaps FROM Results GROUP BY DriverName ORDER BY (count(win)) DESC" C:\> $SQL="SELECT top 25 DriverName, Count(RaceDate) as Races, Count(Win) as Wins, Count(Pole) as Poles, Count(FastestLap) as Fastlaps FROM Results GROUP BY DriverName ORDER BY (count(win)) DESC"
C:\> $Connection = 'Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DriverId=790;ReadOnly=0;Dbq=C:\users\James\Documents\f1Results.xlsx;' C:\> $Connection = 'Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DriverId=790;ReadOnly=0;Dbq=C:\users\James\Documents\f1Results.xlsx;'
@@ -136,7 +142,7 @@
C:\> Get-SQL -Session F1 -excel -Connection "C:\Users\mcp\OneDrive\public\f1\f1Results.xlsx" -sql $sql -OutputVariable Table | out-null C:\> Get-SQL -Session F1 -excel -Connection "C:\Users\mcp\OneDrive\public\f1\f1Results.xlsx" -sql $sql -OutputVariable Table | out-null
C:\> Send-SQLDataToExcel -DataTable $Table -Path ".\demo3.xlsx" -WorkSheetname Gpwinners -autosize -TableName winners -TableStyle Light6 -show C:\> Send-SQLDataToExcel -DataTable $Table -Path ".\demo3.xlsx" -WorkSheetname Gpwinners -autosize -TableName winners -TableStyle Light6 -show
This uses Get-SQL (at least V1.1 download from the gallery with Install-Module -Name GetSQL - note the function is get-SQL the module is GetSQL without the "-" ) This uses Get-SQL (at least V1.1 - download from the gallery with Install-Module -Name GetSQL - note the function is Get-SQL the module is GetSQL without the "-" )
to simplify making database connections and building /submitting SQL statements. to simplify making database connections and building /submitting SQL statements.
Here it uses the same SQL statement as before; -OutputVariable leaves a System.Data.DataTable object in $table Here it uses the same SQL statement as before; -OutputVariable leaves a System.Data.DataTable object in $table
and Send-SQLDataToExcel puts $table into the worksheet and sets it as an Excel table. and Send-SQLDataToExcel puts $table into the worksheet and sets it as an Excel table.
@@ -145,7 +151,7 @@
C:\> $SQL = "SELECT top 25 DriverName, Count(Win) as Wins FROM Results GROUP BY DriverName ORDER BY (count(win)) DESC" C:\> $SQL = "SELECT top 25 DriverName, Count(Win) as Wins FROM Results GROUP BY DriverName ORDER BY (count(win)) DESC"
C:\> Send-SQLDataToExcel -Session $DbSessions["f1"] -SQL $sql -Path ".\demo3.xlsx" -WorkSheetname Gpwinners -autosize -ColumnChart C:\> Send-SQLDataToExcel -Session $DbSessions["f1"] -SQL $sql -Path ".\demo3.xlsx" -WorkSheetname Gpwinners -autosize -ColumnChart
Like the previous example, this uses Get-SQL (download from the gallery with Install-Module -Name GetSQL).It uses the connection which Get-SQL made rather than an ODFBC connection string Like the previous example, this uses Get-SQL (download from the gallery with Install-Module -Name GetSQL). It uses the connection which Get-SQL made rather than an ODFBC connection string
Here the data is presented as a quick chart. Here the data is presented as a quick chart.
.EXAMPLE .EXAMPLE
C:\> Send-SQLDataToExcel -path .\demo3.xlsx -WorkSheetname "LR" -Connection "DSN=LR" -sql "SELECT name AS CollectionName FROM AgLibraryCollection Collection ORDER BY CollectionName" C:\> Send-SQLDataToExcel -path .\demo3.xlsx -WorkSheetname "LR" -Connection "DSN=LR" -sql "SELECT name AS CollectionName FROM AgLibraryCollection Collection ORDER BY CollectionName"
@@ -254,7 +260,7 @@
$rowCount = $dataAdapter.fill($dataTable) $rowCount = $dataAdapter.fill($dataTable)
Write-Verbose -Message "Query returned $rowCount row(s)" Write-Verbose -Message "Query returned $rowCount row(s)"
} }
if ($DataTable.Rows) { if ($DataTable.Rows.Count) {
#ExportExcel user a -NoHeader parameter so that's what we use here, but needs to be the other way around. #ExportExcel user a -NoHeader parameter so that's what we use here, but needs to be the other way around.
$printHeaders = -not $NoHeader $printHeaders = -not $NoHeader
if ($Title) {$r = $StartRow +1 } if ($Title) {$r = $StartRow +1 }
@@ -263,6 +269,13 @@
$excelPackage = Export-Excel -Path $Path -WorkSheetname $WorkSheetname -PassThru $excelPackage = Export-Excel -Path $Path -WorkSheetname $WorkSheetname -PassThru
$excelPackage.Workbook.Worksheets[$WorkSheetname].Cells[$r,$StartColumn].LoadFromDataTable($dataTable, $printHeaders ) | Out-Null $excelPackage.Workbook.Worksheets[$WorkSheetname].Cells[$r,$StartColumn].LoadFromDataTable($dataTable, $printHeaders ) | Out-Null
#Apply date format
for ($c=0 ; $c -lt $DataTable.Columns.Count ; $c++) {
if ($DataTable.Columns[$c].DataType -eq [datetime]) {
Set-ExcelColumn -Worksheet $excelPackage.Workbook.Worksheets[$WorkSheetname] -Column ($c +1) -NumberFormat 'Date-Time'
}
}
#Call export-excel with any parameters which don't relate to the SQL query #Call export-excel with any parameters which don't relate to the SQL query
"Connection", "Database" , "Session", "MsSQLserver", "Destination" , "SQL" , "DataTable", "Path" | ForEach-Object {$null = $PSBoundParameters.Remove($_) } "Connection", "Database" , "Session", "MsSQLserver", "Destination" , "SQL" , "DataTable", "Path" | ForEach-Object {$null = $PSBoundParameters.Remove($_) }
Export-Excel -ExcelPackage $excelPackage @PSBoundParameters Export-Excel -ExcelPackage $excelPackage @PSBoundParameters

View File

@@ -1,166 +1,181 @@
Function Set-ExcelColumn { Function Set-ExcelColumn {
<# <#
.SYNOPSIS .SYNOPSIS
Adds a column to the existing data area in an Excel sheet, fills values and sets formatting Adds or modifies a column in an Excel sheet, filling values, settings formatting and/or creating named ranges.
.DESCRIPTION .DESCRIPTION
Set-ExcelColumn takes a value which is either a string containing a value or formula or a scriptblock Set-ExcelColumn can take a value which is either a string containing a value or formula or a scriptblock
which evaluates to a string, and optionally a column number and fills that value down the column. which evaluates to a string, and optionally a column number and fills that value down the column.
A column heading can be specified and the new column can be made a named range. A column heading can be specified, and the column can be made a named range.
The column can be formatted in the same operation. The column can be formatted in the same operation.
.EXAMPLE .EXAMPLE
Set-ExcelColumn -Worksheet $ws -Column 5 -NumberFormat 'Currency' Set-ExcelColumn -Worksheet $ws -Column 5 -NumberFormat 'Currency'
$ws contains a worksheet object - and column E is set to use the local currecy format. $ws contains a worksheet object - and column E is set to use the local currency format.
Intelisense will complete predefined number formats. You can see how currency is interpreted on the local computer with the command Intelisense will complete predefined number formats. You can see how currency is interpreted on the local computer with the command
Expand-NumberFormat currency Expand-NumberFormat currency
.EXAMPLE .EXAMPLE
Set-ExcelColumn -Worksheet $ws -Heading "WinsToFastLaps" -Value {"=E$row/C$row"} -Column 7 -AutoSize -AutoNameRange Set-ExcelColumn -Worksheet $ws -Heading "WinsToFastLaps" -Value {"=E$row/C$row"} -Column 7 -AutoSize -AutoNameRange
Here $WS already contains a worksheet which contains counts of races won and fastest laps recorded by racing drivers (in columns C and E) Here, $WS already contains a worksheet which contains counts of races won and fastest laps recorded by racing drivers (in columns C and E).
Set-ExcelColumn specifies that Column 7 should have a heading of "WinsToFastLaps" and the data cells should contain =E2/C2 , =E3/C3 etc Set-ExcelColumn specifies that Column 7 should have a heading of "WinsToFastLaps" and the data cells should contain =E2/C2 , =E3/C3 etc
the data cells should become a named range, which will also be "WinsToFastLaps" the column width will be set automatically the new data cells should become a named range, which will also be named "WinsToFastLaps" the column width will be set automatically.
.EXAMPLE .EXAMPLE.
Set-ExcelColumn -Worksheet $ws -Heading "Link" -Value {"https://en.wikipedia.org" + $worksheet.cells["B$Row"].value } -AutoSize Set-ExcelColumn -Worksheet $ws -Heading "Link" -Value {"https://en.wikipedia.org" + $worksheet.cells["B$Row"].value } -AutoSize
In this example, the worksheet in $ws has partial links to wikipedia pages in column B. In this example, the worksheet in $ws has partial links to wikipedia pages in column B.
The Value parameter is is a script block and it outputs a string which begins https... and ends with the value of cell at column B in the current row. The -Value parameter is is a script block and it outputs a string which begins https... and ends with the value of cell at
When given a valid URI, Set-ExcelColumn makes it a hyperlink. The column will be autosized to fit the links. column B in the current row. When given a valid URI, Set-ExcelColumn makes it a hyperlink. The column will be autosized to fit the links.
.EXAMPLE
4..6 | Set-ExcelColumn -Worksheet $ws -AutoNameRange
Again $ws contains a worksheet. Here columns 4 to 6 are made into named ranges, row 1 is used for the range name
and the rest of the column becomes the range.
#> #>
[cmdletbinding()] [cmdletbinding()]
[Alias(" Set-Column")] [Alias("Set-Column")]
[OutputType([OfficeOpenXml.ExcelColumn],[String])] [OutputType([OfficeOpenXml.ExcelColumn],[String])]
Param ( Param (
#If specifing the worksheet by name the ExcelPackage object which contains it needs to be passed #If specifying the worksheet by name, the ExcelPackage object which contains the Sheet also needs to be passed.
[Parameter(ParameterSetName="Package",Mandatory=$true)] [Parameter(ParameterSetName="Package",Mandatory=$true)]
[OfficeOpenXml.ExcelPackage]$ExcelPackage, [OfficeOpenXml.ExcelPackage]$ExcelPackage,
#The sheet to update can be a given as a name or an Excel Worksheet object - this sets it by name #The sheet to update can be a given as a name or an Excel Worksheet object - this sets it by name.
[Parameter(ParameterSetName="Package")] [Parameter(ParameterSetName="Package")]
#The sheet to update can be a given as a name or an Excel Worksheet object - $workSheet contains the object
[String]$Worksheetname = "Sheet1", [String]$Worksheetname = "Sheet1",
#The worksheet object can be passed instead of passing a sheet name and a package. #This passes the worksheet object instead of passing a sheet name and a package.
[Parameter(ParameterSetName="sheet",Mandatory=$true)] [Parameter(ParameterSetName="sheet",Mandatory=$true)]
[OfficeOpenXml.ExcelWorksheet]$Worksheet, [OfficeOpenXml.ExcelWorksheet]$Worksheet,
#Column to fill down - first column is 1. 0 will be interpreted as first unused column #Column to fill down - the first column is 1. 0 will be interpreted as first empty column.
[Parameter(ValueFromPipeline=$true)]
[ValidateRange(0,16384)] [ValidateRange(0,16384)]
$Column = 0 , $Column = 0 ,
#First row to fill data in #First row to fill data in.
[ValidateRange(1,1048576)] [ValidateRange(1,1048576)]
[Int]$StartRow , [Int]$StartRow ,
#value, formula or script block to fill in. Script block can use $row, $column [number], $columnName [letter(s)], $startRow, $startColumn, $endRow, $endColumn #A value, formula or scriptblock to fill in. A script block can use $worksheet, $row, $column [number], $columnName [letter(s)], $startRow, $startColumn, $endRow, $endColumn.
$Value , $Value ,
#Optional column heading #Optional column heading.
$Heading , $Heading ,
#Number format to apply to cells e.g. "dd/MM/yyyy HH:mm", "£#,##0.00;[Red]-£#,##0.00", "0.00%" , "##/##" , "0.0E+0" etc #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")] [Alias("NFormat")]
$NumberFormat, $NumberFormat,
#Style of border to draw around the row #Style of border to draw around the row.
[OfficeOpenXml.Style.ExcelBorderStyle]$BorderAround, [OfficeOpenXml.Style.ExcelBorderStyle]$BorderAround,
#Colour for the text - if none specified it will be left as it it is #Colour for the text - if none specified it will be left as it it is.
[System.Drawing.Color]$FontColor, [System.Drawing.Color]$FontColor,
#Make text bold; use -Bold:$false to remove bold #Make text bold; use -Bold:$false to remove bold.
[Switch]$Bold, [Switch]$Bold,
#Make text italic; use -Italic:$false to remove italic #Make text italic; use -Italic:$false to remove italic.
[Switch]$Italic, [Switch]$Italic,
#Underline the text using the underline style in -underline type; use -Underline:$false to remove underlining #Underline the text using the underline style in -UnderlineType; use -Underline:$false to remove underlining.
[Switch]$Underline, [Switch]$Underline,
#Should Underline use single or double, normal or accounting mode : default is single normal #Should Underline use single or double, normal or accounting mode ? the default is single normal.
[OfficeOpenXml.Style.ExcelUnderLineType]$UnderLineType = [OfficeOpenXml.Style.ExcelUnderLineType]::Single, [OfficeOpenXml.Style.ExcelUnderLineType]$UnderLineType = [OfficeOpenXml.Style.ExcelUnderLineType]::Single,
#Strike through text; use -Strikethru:$false to remove Strike through #Strike through text; use -Strikethru:$false to remove Strike through.
[Switch]$StrikeThru, [Switch]$StrikeThru,
#Subscript or superscript (or none) #Subscript or Superscript (or None).
[OfficeOpenXml.Style.ExcelVerticalAlignmentFont]$FontShift, [OfficeOpenXml.Style.ExcelVerticalAlignmentFont]$FontShift,
#Font to use - Excel defaults to Calibri #Font to use - Excel defaults to Calibri.
[String]$FontName, [String]$FontName,
#Point size for the text #Point size for the text.
[float]$FontSize, [float]$FontSize,
#Change background colour #Change background color.
[System.Drawing.Color]$BackgroundColor, [System.Drawing.Color]$BackgroundColor,
#Background pattern - solid by default #Background pattern - Solid by default.
[OfficeOpenXml.Style.ExcelFillStyle]$BackgroundPattern = [OfficeOpenXml.Style.ExcelFillStyle]::Solid , [OfficeOpenXml.Style.ExcelFillStyle]$BackgroundPattern = [OfficeOpenXml.Style.ExcelFillStyle]::Solid ,
#Secondary colour for background pattern #Secondary color for background pattern.
[Alias("PatternColour")] [Alias("PatternColour")]
[System.Drawing.Color]$PatternColor, [System.Drawing.Color]$PatternColor,
#Turn on text wrapping; use -WrapText:$false to turn off word wrapping #Turn on text wrapping; use -WrapText:$false to turn off word wrapping.
[Switch]$WrapText, [Switch]$WrapText,
#Position cell contents to left, right, center etc. default is 'General' #Position cell contents to Left, Right, Center etc. Default is 'General'.
[OfficeOpenXml.Style.ExcelHorizontalAlignment]$HorizontalAlignment, [OfficeOpenXml.Style.ExcelHorizontalAlignment]$HorizontalAlignment,
#Position cell contents to top bottom or centre #Position cell contents to Top, Bottom or Center.
[OfficeOpenXml.Style.ExcelVerticalAlignment]$VerticalAlignment, [OfficeOpenXml.Style.ExcelVerticalAlignment]$VerticalAlignment,
#Degrees to rotate text. Up to +90 for anti-clockwise ("upwards"), or to -90 for clockwise. #Degrees to rotate text. Up to +90 for anti-clockwise ("upwards"), or to -90 for clockwise.
[ValidateRange(-90, 90)] [ValidateRange(-90, 90)]
[int]$TextRotation , [int]$TextRotation ,
#Autofit cells to width #Autofit cells to width.
[Alias("AutoFit")] [Alias("AutoFit")]
[Switch]$AutoSize, [Switch]$AutoSize,
#Set cells to a fixed width, ignored if Autosize is specified #Set cells to a fixed width, ignored if -Autosize is specified.
[float]$Width, [float]$Width,
#Set the inserted data to be a named range (ignored if header is not specified) #Set the inserted data to be a named range.
[Switch]$AutoNameRange, [Switch]$AutoNameRange,
#Hide the column #Hide the column.
[Switch]$Hide, [Switch]$Hide,
#If Sepecified returns the range of cells which were affected #If Sepecified, returns the range of cells which were affected.
[Switch]$ReturnRange, [Switch]$Specified,
#If Specified, return an ExcelPackage object to allow further work to be done on the file. #If Specified, return the Column to allow further work to be done on it.
[Switch]$PassThru [Switch]$PassThru
) )
#if we were passed a package object and a worksheet name , get the worksheet.
if ($ExcelPackage) {$Worksheet = $ExcelPackage.Workbook.Worksheets[$Worksheetname] }
#In a script block to build a formula, we may want any of corners or the column name, begin {
#if Column and Startrow aren't specified, assume first unused column, and first row #if we were passed a package object and a worksheet name , get the worksheet.
if (-not $StartRow) {$startRow = $Worksheet.Dimension.Start.Row } if ($ExcelPackage) {$Worksheet = $ExcelPackage.Workbook.Worksheets[$Worksheetname] }
$startColumn = $Worksheet.Dimension.Start.Column
$endColumn = $Worksheet.Dimension.End.Column
$endRow = $Worksheet.Dimension.End.Row
if ($Column -eq 0 ) {$Column = $endColumn + 1 }
$columnName = [OfficeOpenXml.ExcelCellAddress]::new(1,$column).Address -replace "1",""
#In a script block to build a formula, we may want any of corners or the column name,
Write-Verbose -Message "Updating Column $columnName" #if Column and Startrow aren't specified, assume first unused column, and first row
#If there is a heading, insert it and use it as the name for a range (if we're creating one) if (-not $StartRow) {$startRow = $Worksheet.Dimension.Start.Row }
if ($Heading) { $startColumn = $Worksheet.Dimension.Start.Column
$Worksheet.Cells[$StartRow, $Column].Value = $Heading $endColumn = $Worksheet.Dimension.End.Column
$StartRow ++ $endRow = $Worksheet.Dimension.End.Row
if ($AutoNameRange) { Add-ExcelName -Range $Worksheet.Cells[$StartRow, $Column, $endRow, $Column] -RangeName $Heading }
} }
#Fill in the data process {
if ($PSBoundParameters.ContainsKey('Value')) { foreach ($row in ($StartRow..$endRow)) { if ($Column -eq 0 ) {$Column = $endColumn + 1 }
if ($Value -is [scriptblock]) { #re-create the script block otherwise variables from this function are out of scope. $columnName = [OfficeOpenXml.ExcelCellAddress]::new(1,$column).Address -replace "1",""
$cellData = & ([scriptblock]::create( $Value )) Write-Verbose -Message "Updating Column $columnName"
Write-Verbose -Message $cellData #If there is a heading, insert it and use it as the name for a range (if we're creating one)
if ($PSBoundParameters.ContainsKey('Heading')) {
$Worksheet.Cells[$StartRow, $Column].Value = $Heading
$StartRow ++
if ($AutoNameRange) {
Add-ExcelName -Range $Worksheet.Cells[$StartRow, $Column, $endRow, $Column] -RangeName $Heading
}
} }
else { $cellData = $Value} elseif ($AutoNameRange) {
if ($cellData -match "^=") { $Worksheet.Cells[$Row, $Column].Formula = ($cellData -replace '^=','') } #EPPlus likes formulas with no = sign; Excel doesn't care Add-ExcelName -Range $Worksheet.Cells[($StartRow+1), $Column, $endRow, $Column] -RangeName $Worksheet.Cells[$StartRow, $Column].Value
elseif ( [System.Uri]::IsWellFormedUriString($cellData , [System.UriKind]::Absolute)) { }
# Save a hyperlink : internal links can be in the form xl://sheet!E419 (use A1 as goto sheet), or xl://RangeName
if ($cellData -match "^xl://internal/") { #Fill in the data
$referenceAddress = $cellData -replace "^xl://internal/" , "" if ($PSBoundParameters.ContainsKey('Value')) { foreach ($row in ($StartRow..$endRow)) {
$display = $referenceAddress -replace "!A1$" , "" if ($Value -is [scriptblock]) { #re-create the script block otherwise variables from this function are out of scope.
$h = New-Object -TypeName OfficeOpenXml.ExcelHyperLink -ArgumentList $referenceAddress , $display $cellData = & ([scriptblock]::create( $Value ))
$Worksheet.Cells[$Row, $Column].HyperLink = $h Write-Verbose -Message $cellData
} }
else {$Worksheet.Cells[$Row, $Column].HyperLink = $cellData } else { $cellData = $Value}
$Worksheet.Cells[$Row, $Column].Style.Font.Color.SetColor([System.Drawing.Color]::Blue) if ($cellData -match "^=") { $Worksheet.Cells[$Row, $Column].Formula = ($cellData -replace '^=','') } #EPPlus likes formulas with no = sign; Excel doesn't care
$Worksheet.Cells[$Row, $Column].Style.Font.UnderLine = $true elseif ( [System.Uri]::IsWellFormedUriString($cellData , [System.UriKind]::Absolute)) {
# Save a hyperlink : internal links can be in the form xl://sheet!E419 (use A1 as goto sheet), or xl://RangeName
if ($cellData -match "^xl://internal/") {
$referenceAddress = $cellData -replace "^xl://internal/" , ""
$display = $referenceAddress -replace "!A1$" , ""
$h = New-Object -TypeName OfficeOpenXml.ExcelHyperLink -ArgumentList $referenceAddress , $display
$Worksheet.Cells[$Row, $Column].HyperLink = $h
}
else {$Worksheet.Cells[$Row, $Column].HyperLink = $cellData }
$Worksheet.Cells[$Row, $Column].Style.Font.Color.SetColor([System.Drawing.Color]::Blue)
$Worksheet.Cells[$Row, $Column].Style.Font.UnderLine = $true
}
else { $Worksheet.Cells[$Row, $Column].Value = $cellData }
if ($cellData -is [datetime]) { $Worksheet.Cells[$Row, $Column].Style.Numberformat.Format = 'm/d/yy h:mm' } # This is not a custom format, but a preset recognized as date and localized.
if ($cellData -is [timespan]) { $Worksheet.Cells[$Row, $Column].Style.Numberformat.Format = '[h]:mm:ss' }
}}
#region Apply formatting
$params = @{}
foreach ($p in @('Underline','Bold','Italic','StrikeThru','FontSize','FontShift','NumberFormat','TextRotation',
'WrapText', 'HorizontalAlignment','VerticalAlignment', 'Autosize', 'Width', 'FontColor'
'BorderAround', 'BackgroundColor', 'BackgroundPattern', 'PatternColor')) {
if ($PSBoundParameters.ContainsKey($p)) {$params[$p] = $PSBoundParameters[$p]}
} }
else { $Worksheet.Cells[$Row, $Column].Value = $cellData } if ($params.Count) {
if ($cellData -is [datetime]) { $Worksheet.Cells[$Row, $Column].Style.Numberformat.Format = 'm/d/yy h:mm' } # This is not a custom format, but a preset recognized as date and localized. $theRange = "$columnName$StartRow`:$columnName$endRow"
if ($cellData -is [timespan]) { $Worksheet.Cells[$Row, $Column].Style.Numberformat.Format = '[h]:mm:ss' } Set-ExcelRange -WorkSheet $Worksheet -Range $theRange @params
}} }
#region Apply formatting #endregion
$params = @{} if ($PSBoundParameters.ContainsKey('Hide')) {$workSheet.Column($Column).Hidden = [bool]$Hide}
foreach ($p in @('Underline','Bold','Italic','StrikeThru','FontSize','FontShift','NumberFormat','TextRotation', #return the new data if -passthru was specified.
'WrapText', 'HorizontalAlignment','VerticalAlignment', 'Autosize', 'Width', 'FontColor' if ($PassThru) { $Worksheet.Column($Column)}
'BorderAround', 'BackgroundColor', 'BackgroundPattern', 'PatternColor')) { elseif ($ReturnRange) { $theRange}
if ($PSBoundParameters.ContainsKey($p)) {$params[$p] = $PSBoundParameters[$p]}
} }
$theRange = "$columnName$StartRow`:$columnName$endRow"
if ($params.Count) {
Set-ExcelRange -WorkSheet $Worksheet -Range $theRange @params
}
#endregion
if ($PSBoundParameters["Hide"]) {$workSheet.Column($Column).Hidden = [bool]$Hide}
#return the new data if -passthru was specified.
if ($passThru) { $Worksheet.Column($Column)}
elseif ($ReturnRange) { $theRange}
} }

View File

@@ -1,20 +1,20 @@
Function Set-ExcelRow { Function Set-ExcelRow {
<# <#
.Synopsis .Synopsis
Fills values into a [new] row in an Excel spreadsheet. And sets row formmats. Fills values into a [new] row in an Excel spreadsheet. And sets row formats.
.Description .Description
Set-ExcelRow accepts either a Worksheet object or an Excel package object returned by Export-Excel and the name of a sheet, Set-ExcelRow accepts either a Worksheet object or an Excel Package object returned by Export-Excel and the name of a sheet,
and inserts the chosen contents into a row of the sheet. and inserts the chosen contents into a row of the sheet.
The contents can be a constant "42" , a formula or a script block which is converted into a constant or formula. The contents can be a constant e.g. "42", a formula or a script block which is converted into a constant or a formula.
The first cell of the row can optionally be given a heading. The first cell of the row can optionally be given a heading.
.Example .Example
Set-ExcelRow -Worksheet $ws -Heading Total -Value {"=sum($columnName`2:$columnName$endrow)" } Set-ExcelRow -Worksheet $ws -Heading Total -Value {"=sum($columnName`2:$columnName$endrow)" }
$Ws contains a worksheet object, and no Row number is specified so Set-ExcelRow will select the next row after the end of the data in the sheet $Ws contains a worksheet object, and no Row number is specified so Set-ExcelRow will select the next row after the end
The first cell will contain "Total", and each other cell will contain of the data in the sheet. The first cell in the row will contain "Total", and each other cell will contain
=Sum(xx2:xx99) - where xx is the column name, and 99 is the last row of data. =Sum(xx2:xx99) - where xx is the column name, and 99 is the last row of data.
Note the use of `2 to Prevent 2 becoming part of the variable "ColumnName" Note the use of `2 to Prevent 2 becoming part of the variable "ColumnName"
The script block can use $row, $column, $ColumnName, $startRow/Column $endRow/Column The script block can use $Worksheet, $Row, $Column (number), $ColumnName (letter), $StartRow/Column and $EndRow/Column
.Example .Example
Set-ExcelRow -Worksheet $ws -Heading Total -HeadingBold -Value {"=sum($columnName`2:$columnName$endrow)" } -NumberFormat 'Currency' -StartColumn 2 -Bold -BorderTop Double -BorderBottom Thin Set-ExcelRow -Worksheet $ws -Heading Total -HeadingBold -Value {"=sum($columnName`2:$columnName$endrow)" } -NumberFormat 'Currency' -StartColumn 2 -Bold -BorderTop Double -BorderBottom Thin
@@ -23,149 +23,153 @@
and given a double line border above and single line border below. and given a double line border above and single line border below.
#> #>
[cmdletbinding()] [cmdletbinding()]
[Alias(" Set-Row")] [Alias("Set-Row")]
[OutputType([OfficeOpenXml.ExcelRow],[String])] [OutputType([OfficeOpenXml.ExcelRow],[String])]
Param ( Param (
#An Excel package object - e.g. from Export-Excel -passthru - requires a sheet name #An Excel package object - e.g. from Export-Excel -passthru - requires a sheet name.
[Parameter(ParameterSetName="Package",Mandatory=$true)] [Parameter(ParameterSetName="Package",Mandatory=$true)]
[OfficeOpenXml.ExcelPackage]$ExcelPackage, [OfficeOpenXml.ExcelPackage]$ExcelPackage,
#the name to update in the package #The name of the sheet to update in the package.
[Parameter(ParameterSetName="Package")] [Parameter(ParameterSetName="Package")]
$Worksheetname = "Sheet1", $Worksheetname = "Sheet1",
#A worksheet object #A worksheet object instead of passing a name and package.
[Parameter(ParameterSetName="Sheet",Mandatory=$true)] [Parameter(ParameterSetName="Sheet",Mandatory=$true)]
[OfficeOpenXml.Excelworksheet] $Worksheet, [OfficeOpenXml.Excelworksheet] $Worksheet,
#Row to fill right - first row is 1. 0 will be interpreted as first unused row #Row to fill right - first row is 1. 0 will be interpreted as first unused row.
[Parameter(ValueFromPipeline = $true)]
$Row = 0 , $Row = 0 ,
#Position in the row to start from #Position in the row to start from.
[int]$StartColumn, [int]$StartColumn,
#Value, formula or script block to fill in. Script block can use $worksheet, $row, $Column [number], $ColumnName [letter(s)], $startRow, $startColumn, $endRow, $endColumn #Value, formula or script block to fill in. Script block can use $worksheet, $row, $Column [number], $ColumnName [letter(s)], $startRow, $startColumn, $endRow, $endColumn
$Value, $Value,
#Optional Row heading #Optional Row heading.
$Heading , $Heading ,
#Set the heading in bold type #Set the heading in bold type.
[Switch]$HeadingBold, [Switch]$HeadingBold,
#Change the size of the heading type #Change the size of the heading type.
[Int]$HeadingSize , [Int]$HeadingSize ,
#Number format to apply to cells e.g. "dd/MM/yyyy HH:mm", "£#,##0.00;[Red]-£#,##0.00", "0.00%" , "##/##" , "0.0E+0" etc #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")] [Alias("NFormat")]
$NumberFormat, $NumberFormat,
#Style of border to draw around the row #Style of border to draw around the row.
[OfficeOpenXml.Style.ExcelBorderStyle]$BorderAround, [OfficeOpenXml.Style.ExcelBorderStyle]$BorderAround,
#Color of the border #Color of the border
[System.Drawing.Color]$BorderColor=[System.Drawing.Color]::Black, [System.Drawing.Color]$BorderColor=[System.Drawing.Color]::Black,
#Style for the bottom border #Style for the bottom border.
[OfficeOpenXml.Style.ExcelBorderStyle]$BorderBottom, [OfficeOpenXml.Style.ExcelBorderStyle]$BorderBottom,
#Style for the top border #Style for the top border.
[OfficeOpenXml.Style.ExcelBorderStyle]$BorderTop, [OfficeOpenXml.Style.ExcelBorderStyle]$BorderTop,
#Style for the left border #Style for the left border.
[OfficeOpenXml.Style.ExcelBorderStyle]$BorderLeft, [OfficeOpenXml.Style.ExcelBorderStyle]$BorderLeft,
#Style for the right border #Style for the right border.
[OfficeOpenXml.Style.ExcelBorderStyle]$BorderRight, [OfficeOpenXml.Style.ExcelBorderStyle]$BorderRight,
#Colour for the text - if none specified it will be left as it it is #Colour for the text - if none specified it will be left as it it is.
[System.Drawing.Color]$FontColor, [System.Drawing.Color]$FontColor,
#Make text bold; use -Bold:$false to remove bold #Make text bold; use -Bold:$false to remove bold.
[Switch]$Bold, [Switch]$Bold,
#Make text italic; use -Italic:$false to remove italic #Make text italic; use -Italic:$false to remove italic.
[Switch]$Italic, [Switch]$Italic,
#Underline the text using the underline style in -underline type; use -Underline:$false to remove underlining #Underline the text using the underline style in -UnderlineType; use -Underline:$false to remove underlining.
[Switch]$Underline, [Switch]$Underline,
#Should Underline use single or double, normal or accounting mode : default is single normal #Should Underline use single or double, normal or accounting mode : default is single normal.
[OfficeOpenXml.Style.ExcelUnderLineType]$UnderLineType = [OfficeOpenXml.Style.ExcelUnderLineType]::Single, [OfficeOpenXml.Style.ExcelUnderLineType]$UnderLineType = [OfficeOpenXml.Style.ExcelUnderLineType]::Single,
#Strike through text; use -Strikethru:$false to remove Strike through #Strike through text; use -Strikethru:$false to remove Strike through.
[Switch]$StrikeThru, [Switch]$StrikeThru,
#Subscript or superscript (or none) #Subscript or Superscript (or none).
[OfficeOpenXml.Style.ExcelVerticalAlignmentFont]$FontShift, [OfficeOpenXml.Style.ExcelVerticalAlignmentFont]$FontShift,
#Font to use - Excel defaults to Calibri #Font to use - Excel defaults to Calibri.
[String]$FontName, [String]$FontName,
#Point size for the text #Point size for the text.
[float]$FontSize, [float]$FontSize,
#Change background colour #Change background color.
[System.Drawing.Color]$BackgroundColor, [System.Drawing.Color]$BackgroundColor,
#Background pattern - solid by default #Background pattern - solid by default.
[OfficeOpenXml.Style.ExcelFillStyle]$BackgroundPattern = [OfficeOpenXml.Style.ExcelFillStyle]::Solid , [OfficeOpenXml.Style.ExcelFillStyle]$BackgroundPattern = [OfficeOpenXml.Style.ExcelFillStyle]::Solid ,
#Secondary colour for background pattern #Secondary color for background pattern.
[Alias("PatternColour")] [Alias("PatternColour")]
[System.Drawing.Color]$PatternColor, [System.Drawing.Color]$PatternColor,
#Turn on text wrapping; use -WrapText:$false to turn off word wrapping #Turn on text wrapping; use -WrapText:$false to turn off word wrapping.
[Switch]$WrapText, [Switch]$WrapText,
#Position cell contents to left, right, center etc. default is 'General' #Position cell contents to Left, Right, Center etc. default is 'General'.
[OfficeOpenXml.Style.ExcelHorizontalAlignment]$HorizontalAlignment, [OfficeOpenXml.Style.ExcelHorizontalAlignment]$HorizontalAlignment,
#Position cell contents to top bottom or centre #Position cell contents to Top Bottom or Center.
[OfficeOpenXml.Style.ExcelVerticalAlignment]$VerticalAlignment, [OfficeOpenXml.Style.ExcelVerticalAlignment]$VerticalAlignment,
#Degrees to rotate text. Up to +90 for anti-clockwise ("upwards"), or to -90 for clockwise #Degrees to rotate text. Up to +90 for anti-clockwise ("upwards"), or to -90 for clockwise.
[ValidateRange(-90, 90)] [ValidateRange(-90, 90)]
[int]$TextRotation , [int]$TextRotation ,
#Set cells to a fixed hieght #Set cells to a fixed hieght.
[float]$Height, [float]$Height,
#Hide the Row #Hide the Row.
[Switch]$Hide, [Switch]$Hide,
#If Sepecified returns the range of cells which were affected #If Sepecified returns the range of cells which were affected.
[Switch]$ReturnRange, [Switch]$ReturnRange,
#If Specified, return a row object to allow further work to be done #If Specified, return a row object to allow further work to be done.
[Switch]$PassThru [Switch]$PassThru
) )
begin {
#if we were passed a package object and a worksheet name , get the worksheet.
if ($ExcelPackage) {$Worksheet = $ExcelPackage.Workbook.worksheets[$Worksheetname] }
#if we were passed a package object and a worksheet name , get the worksheet. #In a script block to build a formula, we may want any of corners or the columnname,
if ($ExcelPackage) {$Worksheet = $ExcelPackage.Workbook.worksheets[$Worksheetname] } #if row and start column aren't specified assume first unused row, and first column
if (-not $StartColumn) {$StartColumn = $Worksheet.Dimension.Start.Column }
#In a script block to build a formula, we may want any of corners or the columnname, $startRow = $Worksheet.Dimension.Start.Row + 1
#if row and start column aren't specified assume first unused row, and first column $endColumn = $Worksheet.Dimension.End.Column
if (-not $StartColumn) {$StartColumn = $Worksheet.Dimension.Start.Column } $endRow = $Worksheet.Dimension.End.Row
$startRow = $Worksheet.Dimension.Start.Row + 1
$endColumn = $Worksheet.Dimension.End.Column
$endRow = $Worksheet.Dimension.End.Row
if ($Row -eq 0 ) {$Row = $endRow + 1 }
Write-Verbose -Message "Updating Row $Row"
#Add a row label
if ($Heading) {
$Worksheet.Cells[$Row, $StartColumn].Value = $Heading
if ($HeadingBold) {$Worksheet.Cells[$Row, $StartColumn].Style.Font.Bold = $true}
if ($HeadingSize) {$Worksheet.Cells[$Row, $StartColumn].Style.Font.Size = $HeadingSize}
$StartColumn ++
} }
#Fill in the data process {
if ($PSBoundParameters.ContainsKey('Value')) {foreach ($column in ($StartColumn..$endColumn)) { if ($Row -eq 0 ) {$Row = $endRow + 1 }
#We might want the column name in a script block Write-Verbose -Message "Updating Row $Row"
$columnName = [OfficeOpenXml.ExcelCellAddress]::new(1,$column).Address -replace "1","" #Add a row label
if ($Value -is [scriptblock] ) { if ($Heading) {
#re-create the script block otherwise variables from this function are out of scope. $Worksheet.Cells[$Row, $StartColumn].Value = $Heading
$cellData = & ([scriptblock]::create( $Value )) if ($HeadingBold) {$Worksheet.Cells[$Row, $StartColumn].Style.Font.Bold = $true}
Write-Verbose -Message $cellData if ($HeadingSize) {$Worksheet.Cells[$Row, $StartColumn].Style.Font.Size = $HeadingSize}
$StartColumn ++
} }
else{$cellData = $Value} #Fill in the data
if ($cellData -match "^=") { $Worksheet.Cells[$Row, $column].Formula = ($cellData -replace '^=','') } #EPPlus likes formulas with no = sign; Excel doesn't care if ($PSBoundParameters.ContainsKey('Value')) {foreach ($column in ($StartColumn..$endColumn)) {
elseif ( [System.Uri]::IsWellFormedUriString($cellData , [System.UriKind]::Absolute)) { #We might want the column name in a script block
# Save a hyperlink : internal links can be in the form xl://sheet!E419 (use A1 as goto sheet), or xl://RangeName $columnName = [OfficeOpenXml.ExcelCellAddress]::new(1,$column).Address -replace "1",""
if ($cellData -match "^xl://internal/") { if ($Value -is [scriptblock] ) {
$referenceAddress = $cellData -replace "^xl://internal/" , "" #re-create the script block otherwise variables from this function are out of scope.
$display = $referenceAddress -replace "!A1$" , "" $cellData = & ([scriptblock]::create( $Value ))
$h = New-Object -TypeName OfficeOpenXml.ExcelHyperLink -ArgumentList $referenceAddress , $display Write-Verbose -Message $cellData
$Worksheet.Cells[$Row, $Column].HyperLink = $h
} }
else {$Worksheet.Cells[$Row, $Column].HyperLink = $cellData } else{$cellData = $Value}
$Worksheet.Cells[$Row, $Column].Style.Font.Color.SetColor([System.Drawing.Color]::Blue) if ($cellData -match "^=") { $Worksheet.Cells[$Row, $column].Formula = ($cellData -replace '^=','') } #EPPlus likes formulas with no = sign; Excel doesn't care
$Worksheet.Cells[$Row, $Column].Style.Font.UnderLine = $true elseif ( [System.Uri]::IsWellFormedUriString($cellData , [System.UriKind]::Absolute)) {
# Save a hyperlink : internal links can be in the form xl://sheet!E419 (use A1 as goto sheet), or xl://RangeName
if ($cellData -match "^xl://internal/") {
$referenceAddress = $cellData -replace "^xl://internal/" , ""
$display = $referenceAddress -replace "!A1$" , ""
$h = New-Object -TypeName OfficeOpenXml.ExcelHyperLink -ArgumentList $referenceAddress , $display
$Worksheet.Cells[$Row, $Column].HyperLink = $h
}
else {$Worksheet.Cells[$Row, $Column].HyperLink = $cellData }
$Worksheet.Cells[$Row, $Column].Style.Font.Color.SetColor([System.Drawing.Color]::Blue)
$Worksheet.Cells[$Row, $Column].Style.Font.UnderLine = $true
}
else { $Worksheet.Cells[$Row, $column].Value = $cellData }
if ($cellData -is [datetime]) { $Worksheet.Cells[$Row, $column].Style.Numberformat.Format = 'm/d/yy h:mm' } #This is not a custom format, but a preset recognized as date and localized.
if ($cellData -is [timespan]) { $Worksheet.Cells[$Row, $Column].Style.Numberformat.Format = '[h]:mm:ss' }
}}
#region Apply formatting
$params = @{}
foreach ($p in @('Underline','Bold','Italic','StrikeThru','FontSize', 'FontShift','NumberFormat','TextRotation',
'WrapText', 'HorizontalAlignment','VerticalAlignment', 'Height', 'FontColor'
'BorderAround', 'BorderBottom', 'BorderTop', 'BorderLeft', 'BorderRight', 'BorderColor',
'BackgroundColor', 'BackgroundPattern', 'PatternColor')) {
if ($PSBoundParameters.ContainsKey($p)) {$params[$p] = $PSBoundParameters[$p]}
} }
else { $Worksheet.Cells[$Row, $column].Value = $cellData } if ($params.Count) {
if ($cellData -is [datetime]) { $Worksheet.Cells[$Row, $column].Style.Numberformat.Format = 'm/d/yy h:mm' } #This is not a custom format, but a preset recognized as date and localized. $theRange = [OfficeOpenXml.ExcelAddress]::New($Row, $StartColumn, $Row, $endColumn)
if ($cellData -is [timespan]) { $Worksheet.Cells[$Row, $Column].Style.Numberformat.Format = '[h]:mm:ss' } Set-ExcelRange -WorkSheet $Worksheet -Range $theRange @params
}} }
#region Apply formatting #endregion
$params = @{} if ($PSBoundParameters.ContainsKey('Hide')) {$workSheet.Row($Row).Hidden = [bool]$Hide}
foreach ($p in @('Underline','Bold','Italic','StrikeThru','FontSize', 'FontShift','NumberFormat','TextRotation', #return the new data if -passthru was specified.
'WrapText', 'HorizontalAlignment','VerticalAlignment', 'Height', 'FontColor' if ($passThru) {$Worksheet.Row($Row)}
'BorderAround', 'BorderBottom', 'BorderTop', 'BorderLeft', 'BorderRight', 'BorderColor', elseif ($ReturnRange) {$theRange}
'BackgroundColor', 'BackgroundPattern', 'PatternColor')) {
if ($PSBoundParameters.ContainsKey($p)) {$params[$p] = $PSBoundParameters[$p]}
} }
$theRange = [OfficeOpenXml.ExcelAddress]::New($Row, $StartColumn, $Row, $endColumn)
if ($params.Count) {
Set-ExcelRange -WorkSheet $Worksheet -Range $theRange @params
}
#endregion
if ($PSBoundParameters["Hide"]) {$workSheet.Row($Row).Hidden = [bool]$Hide}
#return the new data if -passthru was specified.
if ($passThru) {$Worksheet.Row($Row)}
elseif ($ReturnRange) {$theRange}
} }

View File

@@ -1,22 +1,23 @@
Function Set-ExcelRange { Function Set-ExcelRange {
<# <#
.SYNOPSIS .SYNOPSIS
Applies Number, font, alignment and colour formatting, values or formulas to a range of Excel Cells Applies Number, font, alignment and color formatting, values or formulas to a range of Excel Cells.
.DESCRIPTION .DESCRIPTION
Set-ExcelRange was created to set the style elements for a range of cells, this includes autosizing and hiding, setting Set-ExcelRange was created to set the style elements for a range of cells, this includes
font elements (Name, Size, Bold, Italic, Underline & UnderlineStyle and Subscript & SuperScript), font and background colors, auto-sizing and hiding, setting font elements (Name, Size, Bold, Italic, Underline & UnderlineStyle and Subscript & SuperScript),
borders, text wrapping, rotation, aliginment within cells, and number format. It was orignally named "Set-ExcelRange" font and background colors, borders, text wrapping, rotation, aliginment within cells, and number format.
It has been extended to set Values, Formulas and set ArrayFormulas (sometimes called Ctrl-shift-Enter [CSE] formulas); because of this It was orignally named "Set-Format",but it has been extended to set Values, Formulas and
the name has become Set-ExcelRange - but the old name of Set-Format is preserved as an alias name may swapped. ArrayFormulas (sometimes called Ctrl-shift-Enter [CSE] formulas); because of this
The name has become Set-ExcelRange - but the old name of Set-Format is preserved as an alias name.
.EXAMPLE .EXAMPLE
$sheet.Column(3) | Set-ExcelRange -HorizontalAlignment Right -NumberFormat "#,###" -AutoFit $sheet.Column(3) | Set-ExcelRange -HorizontalAlignment Right -NumberFormat "#,###" -AutoFit
Selects column 3 from a sheet object (within a workbook object, which is a child of the ExcelPackage object) and passes it to Set-ExcelRange Selects column 3 from a sheet object (within a workbook object, which is a child of the ExcelPackage object) and passes it to Set-ExcelRange
which formats as an integer with comma seperated groups, aligns it right, and auto-fits the column to the contents. which formats as an integer with comma-separated groups, aligns it right, and auto-fits the column to the contents.
.EXAMPLE .EXAMPLE
Set-ExcelRange -Range $sheet.Cells["E1:H1048576"] -HorizontalAlignment Right -NumberFormat "#,###" Set-ExcelRange -Range $sheet.Cells["E1:H1048576"] -HorizontalAlignment Right -NumberFormat "#,###"
Instead of piping the address in this version specifies a block of cells and applies similar formatting Instead of piping the address, this version specifies a block of cells and applies similar formatting.
.EXAMPLE .EXAMPLE
Set-ExcelRange $excel.Workbook.Worksheets[1].Tables["Processes"] -Italic Set-ExcelRange $excel.Workbook.Worksheets[1].Tables["Processes"] -Italic
@@ -25,77 +26,77 @@
[cmdletbinding()] [cmdletbinding()]
[Alias("Set-Format")] [Alias("Set-Format")]
Param ( Param (
#One or more row(s), Column(s) and/or block(s) of cells to format #One or more row(s), Column(s) and/or block(s) of cells to format.
[Parameter(ValueFromPipeline = $true,Position=0)] [Parameter(ValueFromPipeline = $true,Position=0)]
[Alias("Address")] [Alias("Address")]
$Range , $Range ,
#The worksheet where the format is to be applied #The worksheet where the format is to be applied.
[OfficeOpenXml.ExcelWorksheet]$WorkSheet , [OfficeOpenXml.ExcelWorksheet]$WorkSheet ,
#Number format to apply to cells e.g. "dd/MM/yyyy HH:mm", "£#,##0.00;[Red]-£#,##0.00", "0.00%" , "##/##" , "0.0E+0" etc #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")] [Alias("NFormat")]
$NumberFormat, $NumberFormat,
#Style of border to draw around the range #Style of border to draw around the range.
[OfficeOpenXml.Style.ExcelBorderStyle]$BorderAround, [OfficeOpenXml.Style.ExcelBorderStyle]$BorderAround,
#Color of the border #Color of the border.
[System.Drawing.Color]$BorderColor=[System.Drawing.Color]::Black, [System.Drawing.Color]$BorderColor=[System.Drawing.Color]::Black,
#Style for the bottom border #Style for the bottom border.
[OfficeOpenXml.Style.ExcelBorderStyle]$BorderBottom, [OfficeOpenXml.Style.ExcelBorderStyle]$BorderBottom,
#Style for the top border #Style for the top border.
[OfficeOpenXml.Style.ExcelBorderStyle]$BorderTop, [OfficeOpenXml.Style.ExcelBorderStyle]$BorderTop,
#Style for the left border #Style for the left border.
[OfficeOpenXml.Style.ExcelBorderStyle]$BorderLeft, [OfficeOpenXml.Style.ExcelBorderStyle]$BorderLeft,
#Style for the right border #Style for the right border.
[OfficeOpenXml.Style.ExcelBorderStyle]$BorderRight, [OfficeOpenXml.Style.ExcelBorderStyle]$BorderRight,
#Colour for the text - if none specified it will be left as it it is #Colour for the text - if none is specified it will be left as it is.
[System.Drawing.Color]$FontColor, [System.Drawing.Color]$FontColor,
#Value for the cell #Value for the cell.
$Value, $Value,
#Formula for the cell #Formula for the cell.
$Formula, $Formula,
#Specifies formula should be an array formula (a.k.a CSE [ctrl-shift-enter] formula ) #Specifies formula should be an array formula (a.k.a CSE [ctrl-shift-enter] formula).
[Switch]$ArrayFormula, [Switch]$ArrayFormula,
#Clear Bold, Italic, StrikeThrough and Underline and set colour to black #Clear Bold, Italic, StrikeThrough and Underline and set colour to black.
[Switch]$ResetFont, [Switch]$ResetFont,
#Make text bold; use -Bold:$false to remove bold #Make text bold; use -Bold:$false to remove bold.
[Switch]$Bold, [Switch]$Bold,
#Make text italic; use -Italic:$false to remove italic #Make text italic; use -Italic:$false to remove italic.
[Switch]$Italic, [Switch]$Italic,
#Underline the text using the underline style in -underline type; use -Underline:$false to remove underlining #Underline the text using the underline style in -underline type; use -Underline:$false to remove underlining.
[Switch]$Underline, [Switch]$Underline,
#Should Underline use single or double, normal or accounting mode : default is single normal #Should Underline use single or double, normal or accounting mode: the default is single normal.
[OfficeOpenXml.Style.ExcelUnderLineType]$UnderLineType = [OfficeOpenXml.Style.ExcelUnderLineType]::Single, [OfficeOpenXml.Style.ExcelUnderLineType]$UnderLineType = [OfficeOpenXml.Style.ExcelUnderLineType]::Single,
#Strike through text; use -Strikethru:$false to remove Strike through #Strike through text; use -Strikethru:$false to remove Strike through
[Switch]$StrikeThru, [Switch]$StrikeThru,
#Subscript or superscript (or none) #Subscript or Superscript (or none).
[OfficeOpenXml.Style.ExcelVerticalAlignmentFont]$FontShift, [OfficeOpenXml.Style.ExcelVerticalAlignmentFont]$FontShift,
#Font to use - Excel defaults to Calibri #Font to use - Excel defaults to Calibri.
[String]$FontName, [String]$FontName,
#Point size for the text #Point size for the text.
[float]$FontSize, [float]$FontSize,
#Change background colour #Change background color.
[System.Drawing.Color]$BackgroundColor, [System.Drawing.Color]$BackgroundColor,
#Background pattern - solid by default #Background pattern - Solid by default.
[OfficeOpenXml.Style.ExcelFillStyle]$BackgroundPattern = [OfficeOpenXml.Style.ExcelFillStyle]::Solid , [OfficeOpenXml.Style.ExcelFillStyle]$BackgroundPattern = [OfficeOpenXml.Style.ExcelFillStyle]::Solid ,
#Secondary colour for background pattern #Secondary color for background pattern.
[Alias("PatternColour")] [Alias("PatternColour")]
[System.Drawing.Color]$PatternColor, [System.Drawing.Color]$PatternColor,
#Turn on text wrapping; use -WrapText:$false to turn off word wrapping #Turn on text wrapping; use -WrapText:$false to turn off word wrapping.
[Switch]$WrapText, [Switch]$WrapText,
#Position cell contents to left, right, center etc. default is 'General' #Position cell contents to Left, Right, Center etc. default is 'General'.
[OfficeOpenXml.Style.ExcelHorizontalAlignment]$HorizontalAlignment, [OfficeOpenXml.Style.ExcelHorizontalAlignment]$HorizontalAlignment,
#Position cell contents to top bottom or center #Position cell contents to Top Bottom or Center.
[OfficeOpenXml.Style.ExcelVerticalAlignment]$VerticalAlignment, [OfficeOpenXml.Style.ExcelVerticalAlignment]$VerticalAlignment,
#Degrees to rotate text. Up to +90 for anti-clockwise ("upwards"), or to -90 for clockwise. #Degrees to rotate text. Up to +90 for anti-clockwise ("upwards"), or to -90 for clockwise.
[ValidateRange(-90, 90)] [ValidateRange(-90, 90)]
[int]$TextRotation , [int]$TextRotation ,
#Autofit cells to width (columns or ranges only) #Autofit cells to width (columns or ranges only).
[Alias("AutoFit")] [Alias("AutoFit")]
[Switch]$AutoSize, [Switch]$AutoSize,
#Set cells to a fixed width (columns or ranges only), ignored if Autosize is specified #Set cells to a fixed width (columns or ranges only), ignored if Autosize is specified.
[float]$Width, [float]$Width,
#Set cells to a fixed hieght (rows or ranges only) #Set cells to a fixed hieght (rows or ranges only).
[float]$Height, [float]$Height,
#Hide a row or column (not a range); use -Hidden:$false to unhide #Hide a row or column (not a range); use -Hidden:$false to unhide.
[Switch]$Hidden [Switch]$Hidden
) )
process { process {

View File

@@ -1,4 +0,0 @@
- [ ] Investigate regional support for number conversion & possible date conversion. Also investigate feasablity of preserving number format when converting string to number
- [ ] Add help to ConvertToExcelXLSx.ps1, Get-HTMLTable.ps1, GetRange.PS1, GetExcelTable.Ps1, Import-HTML.PS1, New-Psitem.PS1 and Remove-Worksheet.ps1
- [ ] Add Examples and tests for new "Quick charts" in Export Excel (is it possible to replace examples that use Charting.ps1, GetXYRange.ps1, InferData.PS1 ? ).
- [ ] Increase Test code-covereage for import-excel

View File

@@ -1,19 +0,0 @@
$xlFile = ".\testExport.xlsx"
Remove-Item -ErrorAction Ignore $xlFile
$ExportOptions = @{
Path = $xlFile
Show = $true
IncludePivotTable = $true
IncludePivotChart = $true
PivotRows = echo Company Name
PivotData = "PM"
ChartType = "BarClustered3D"
#Password = "Test"
}
Get-Process |
Where Company |
Select Company, Name, Handles, PM |
Export-Excel @ExportOptions

View File

@@ -120,10 +120,10 @@ Describe ExportExcel {
$path = "$env:TEMP\Test.xlsx" $path = "$env:TEMP\Test.xlsx"
Remove-item -Path $path -ErrorAction SilentlyContinue Remove-item -Path $path -ErrorAction SilentlyContinue
#testing -ReturnRange switch and applying number format to Formulas as well as values. #testing -ReturnRange switch and applying number format to Formulas as well as values.
$returnedRange = Write-Output -1 668 34 777 860 -0.5 119 -0.1 234 788,"=A9+A10" | Export-Excel -NumberFormat '[Blue]$#,##0.00;[Red]-$#,##0.00' -Path $path -ReturnRange $returnedRange = @($null, -1, 0, 34, 777, "", -0.5, 119, -0.1, 234, 788,"=A9+A10") | Export-Excel -NumberFormat '[Blue]$#,##0.00;[Red]-$#,##0.00' -Path $path -ReturnRange
it "Created a new file and returned the expected range " { it "Created a new file and returned the expected range " {
Test-Path -Path $path -ErrorAction SilentlyContinue | Should be $true Test-Path -Path $path -ErrorAction SilentlyContinue | Should be $true
$returnedRange | Should be "A1:A11" $returnedRange | Should be "A1:A12"
} }
$Excel = Open-ExcelPackage -Path $path $Excel = Open-ExcelPackage -Path $path
@@ -135,16 +135,22 @@ Describe ExportExcel {
it "Created the worksheet with the expected name, number of rows and number of columns " { it "Created the worksheet with the expected name, number of rows and number of columns " {
$ws.Name | Should be "sheet1" $ws.Name | Should be "sheet1"
$ws.Dimension.Columns | Should be 1 $ws.Dimension.Columns | Should be 1
$ws.Dimension.Rows | Should be 11 $ws.Dimension.Rows | Should be 12
} }
it "Set the default style for the sheet as expected " { it "Set the default style for the sheet as expected " {
$ws.cells.Style.Numberformat.Format | Should be '[Blue]$#,##0.00;[Red]-$#,##0.00' $ws.cells.Style.Numberformat.Format | Should be '[Blue]$#,##0.00;[Red]-$#,##0.00'
} }
it "Set the default style and value for Cell A1 as expected " { it "Set the default style and set values for Cells as expected, handling null,0 and '' " {
$ws.cells[1, 1].Style.Numberformat.Format | Should be '[Blue]$#,##0.00;[Red]-$#,##0.00' $ws.cells[1, 1].Style.Numberformat.Format | Should be '[Blue]$#,##0.00;[Red]-$#,##0.00'
$ws.cells[1, 1].Value | Should be -1 $ws.cells[1, 1].Value | Should beNullorEmpty
$ws.cells[2, 1].Value | Should be -1
$ws.cells[3, 1].Value | Should be 0
$ws.cells[5, 1].Value | Should be 777
$ws.cells[6, 1].Value | Should be ""
$ws.cells[4, 1].Style.Numberformat.Format | Should be '[Blue]$#,##0.00;[Red]-$#,##0.00'
} }
} }
@@ -279,12 +285,12 @@ Describe ExportExcel {
($ws.Cells[2, 20].Value -is [valuetype] ) | Should be $true ($ws.Cells[2, 20].Value -is [valuetype] ) | Should be $true
} }
it "Converted a nested object to a string (Y2) " { it "Converted a nested object to a string (Y2) " {
$ws.Cells[2, 26].Value | should match '^System\.Diagnostics\.Process\s+\(.*\)$' $ws.Cells[2, 26].Value | Should match '^System\.Diagnostics\.Process\s+\(.*\)$'
} }
it "Processed a timespan object (Z2) " { it "Processed a timespan object (Z2) " {
$ws.cells[2, 27].Value.ToOADate() | should beGreaterThan 0 $ws.cells[2, 27].Value.ToOADate() | Should beGreaterThan 0
$ws.cells[2, 27].Value.ToOADate() | should beLessThan 1 $ws.cells[2, 27].Value.ToOADate() | Should beLessThan 1
$ws.cells[2, 27].Style.Numberformat.Format | should be '[h]:mm:ss' $ws.cells[2, 27].Style.Numberformat.Format | Should be '[h]:mm:ss'
} }
} }
@@ -452,7 +458,7 @@ Describe ExportExcel {
#Test -passthru and -worksheetName creating a new, named, sheet in an existing file. #Test -passthru and -worksheetName creating a new, named, sheet in an existing file.
$Excel = Get-Process | Select-Object -first 20 -Property Name, cpu, pm, handles, company | Export-Excel $path -WorkSheetname Processes -PassThru $Excel = Get-Process | Select-Object -first 20 -Property Name, cpu, pm, handles, company | Export-Excel $path -WorkSheetname Processes -PassThru
#Testing -Excel Pacakage and adding a Pivot-table as a second step. Want to save and re-open it ... #Testing -Excel Pacakage and adding a Pivot-table as a second step. Want to save and re-open it ...
Export-Excel -ExcelPackage $Excel -WorkSheetname Processes -IncludePivotTable -PivotRows Company -PivotData PM -NoTotalsInPivot Export-Excel -ExcelPackage $Excel -WorkSheetname Processes -IncludePivotTable -PivotRows Company -PivotData PM -NoTotalsInPivot -PivotDataToColumn -Activate
$Excel = Open-ExcelPackage $path $Excel = Open-ExcelPackage $path
$PTws = $Excel.Workbook.Worksheets["ProcessesPivotTable"] $PTws = $Excel.Workbook.Worksheets["ProcessesPivotTable"]
@@ -461,6 +467,7 @@ Describe ExportExcel {
$excel.ProcessesPivotTable | Should not beNullOrEmpty $excel.ProcessesPivotTable | Should not beNullOrEmpty
$PTws | Should not beNullOrEmpty $PTws | Should not beNullOrEmpty
$PTws.PivotTables.Count | Should be 1 $PTws.PivotTables.Count | Should be 1
$PTws.View.TabSelected | Should be $true
$Excel.Workbook.Worksheets["Processes"] | Should not beNullOrEmpty $Excel.Workbook.Worksheets["Processes"] | Should not beNullOrEmpty
$Excel.Workbook.Worksheets.Count | Should beGreaterThan 2 $Excel.Workbook.Worksheets.Count | Should beGreaterThan 2
$excel.Workbook.Worksheets["Processes"].Dimension.rows | Should be 21 #20 data + 1 header $excel.Workbook.Worksheets["Processes"].Dimension.rows | Should be 21 #20 data + 1 header
@@ -476,7 +483,7 @@ Describe ExportExcel {
} }
#test adding pivot chart using the already open sheet #test adding pivot chart using the already open sheet
$warnvar = $null $warnvar = $null
Export-Excel -ExcelPackage $Excel -WorkSheetname Processes -IncludePivotTable -PivotRows Company -PivotData PM -IncludePivotChart -ChartType PieExploded3D -ShowCategory -NoLegend -WarningAction SilentlyContinue -WarningVariable warnvar Export-Excel -ExcelPackage $Excel -WorkSheetname Processes -IncludePivotTable -PivotRows Company -PivotData PM -IncludePivotChart -ChartType PieExploded3D -ShowCategory -ShowPercent -NoLegend -WarningAction SilentlyContinue -WarningVariable warnvar
$Excel = Open-ExcelPackage $path $Excel = Open-ExcelPackage $path
it "Added a chart to the pivot table without rebuilding " { it "Added a chart to the pivot table without rebuilding " {
$ws = $Excel.Workbook.Worksheets["ProcessesPivotTable"] $ws = $Excel.Workbook.Worksheets["ProcessesPivotTable"]
@@ -512,7 +519,8 @@ Describe ExportExcel {
$null = Add-WorkSheet -ExcelPackage $Excel -WorkSheetname "NewSheet" -MoveAfter "*" -CopySource ($excel.Workbook.Worksheets["Sheet1"]) # Now its NewSheet, Sheet1, ProcessesPivotTable, Processes $null = Add-WorkSheet -ExcelPackage $Excel -WorkSheetname "NewSheet" -MoveAfter "*" -CopySource ($excel.Workbook.Worksheets["Sheet1"]) # Now its NewSheet, Sheet1, ProcessesPivotTable, Processes
$null = Add-WorkSheet -ExcelPackage $Excel -WorkSheetname "Sheet1" -MoveAfter "Processes" # Now its NewSheet, ProcessesPivotTable, Processes, Sheet1 $null = Add-WorkSheet -ExcelPackage $Excel -WorkSheetname "Sheet1" -MoveAfter "Processes" # Now its NewSheet, ProcessesPivotTable, Processes, Sheet1
$null = Add-WorkSheet -ExcelPackage $Excel -WorkSheetname "Another" -MoveToStart # Now its Another, NewSheet, ProcessesPivotTable, Processes, Sheet1 $null = Add-WorkSheet -ExcelPackage $Excel -WorkSheetname "Another" -MoveToStart # Now its Another, NewSheet, ProcessesPivotTable, Processes, Sheet1
$null = Add-WorkSheet -ExcelPackage $Excel -WorkSheetname "OneLast" -MoveBefore "ProcessesPivotTable" # Now its Another, NewSheet, Onelast, ProcessesPivotTable, Processes, Sheet1 $null = Add-WorkSheet -ExcelPackage $Excel -WorkSheetname "NearDone" -MoveBefore 5 # Now its Another, NewSheet, ProcessesPivotTable, Processes, NearDone ,Sheet1
$null = Add-WorkSheet -ExcelPackage $Excel -WorkSheetname "OneLast" -MoveBefore "ProcessesPivotTable" # Now its Another, NewSheet, Onelast, ProcessesPivotTable, Processes,NearDone ,Sheet1
Close-ExcelPackage $Excel Close-ExcelPackage $Excel
$Excel = Open-ExcelPackage $path $Excel = Open-ExcelPackage $path
@@ -523,7 +531,8 @@ Describe ExportExcel {
$excel.Workbook.Worksheets[3].Name | Should be "Onelast" $excel.Workbook.Worksheets[3].Name | Should be "Onelast"
$excel.Workbook.Worksheets[4].Name | Should be "ProcessesPivotTable" $excel.Workbook.Worksheets[4].Name | Should be "ProcessesPivotTable"
$excel.Workbook.Worksheets[5].Name | Should be "Processes" $excel.Workbook.Worksheets[5].Name | Should be "Processes"
$excel.Workbook.Worksheets[6].Name | Should be "Sheet1" $excel.Workbook.Worksheets[6].Name | Should be "NearDone"
$excel.Workbook.Worksheets[7].Name | Should be "Sheet1"
} }
it "Cloned 'Sheet1' to 'NewSheet' " { it "Cloned 'Sheet1' to 'NewSheet' " {
@@ -553,32 +562,33 @@ Describe ExportExcel {
$dataWs.Cells[3, 3].Value | Should not beNullOrEmpty $dataWs.Cells[3, 3].Value | Should not beNullOrEmpty
$dataWs.Cells[3, 3].Style.Font.Bold | Should be $true $dataWs.Cells[3, 3].Style.Font.Bold | Should be $true
$dataWs.Dimension.End.Row | Should be 23 $dataWs.Dimension.End.Row | Should be 23
$dataWs.names[0].end.row | Should be 23 $dataWs.names[0].Start.row | Should be 4 # StartRow + 1
$dataWs.names[0].name | Should be 'Name' $dataWs.names[0].End.row | Should be $dataWs.Dimension.End.Row
$dataWs.names[0].Name | Should be 'Name'
$dataWs.names.Count | Should be 7 # Name, cpu, pm, handles & company + Named Range "Procs" + xl one for autofilter $dataWs.names.Count | Should be 7 # Name, cpu, pm, handles & company + Named Range "Procs" + xl one for autofilter
$dataWs.cells[$dataws.Dimension].AutoFilter | Should be true $dataWs.cells[$dataws.Dimension].AutoFilter | Should be true
} }
it "Applied and auto-extended an autofilter " { it "Applied and auto-extended an autofilter " {
$dataWs.Names["_xlnm._FilterDatabase"].Start.Row | should be 3 #offset $dataWs.Names["_xlnm._FilterDatabase"].Start.Row | Should be 3 #offset
$dataWs.Names["_xlnm._FilterDatabase"].Start.Column | should be 3 $dataWs.Names["_xlnm._FilterDatabase"].Start.Column | Should be 3
$dataWs.Names["_xlnm._FilterDatabase"].Rows | should be 21 #2 x 10 data + 1 header $dataWs.Names["_xlnm._FilterDatabase"].Rows | Should be 21 #2 x 10 data + 1 header
$dataWs.Names["_xlnm._FilterDatabase"].Columns | should be 5 #Name, cpu, pm, handles & company $dataWs.Names["_xlnm._FilterDatabase"].Columns | Should be 5 #Name, cpu, pm, handles & company
$dataWs.Names["_xlnm._FilterDatabase"].AutoFilter | should be $true $dataWs.Names["_xlnm._FilterDatabase"].AutoFilter | Should be $true
} }
it "Created and auto-extended the named ranges " { it "Created and auto-extended the named ranges " {
$dataWs.names["procs"].rows | should be 21 $dataWs.names["procs"].rows | Should be 21
$dataWs.names["procs"].Columns | should be 5 $dataWs.names["procs"].Columns | Should be 5
$dataWs.Names["CPU"].Rows | should be 20 $dataWs.Names["CPU"].Rows | Should be 20
$dataWs.Names["CPU"].Columns | should be 1 $dataWs.Names["CPU"].Columns | Should be 1
} }
it "Created and extended the pivot table " { it "Created and extended the pivot table " {
$pt.CacheDefinition.CacheDefinitionXml.pivotCacheDefinition.cacheSource.worksheetSource.ref | $pt.CacheDefinition.CacheDefinitionXml.pivotCacheDefinition.cacheSource.worksheetSource.ref |
Should be "C3:G23" Should be "C3:G23"
$pt.ColumGrandTotals | should be $false $pt.ColumGrandTotals | Should be $false
$pt.RowGrandTotals | should be $false $pt.RowGrandTotals | Should be $false
$pt.Fields["Company"].IsRowField | should be $true $pt.Fields["Company"].IsRowField | Should be $true
$pt.Fields["PM"].IsDataField | should be $true $pt.Fields["PM"].IsDataField | Should be $true
$pt.Fields["Name"].IsPageField | should be $true $pt.Fields["Name"].IsPageField | Should be $true
} }
it "Generated a message on extending the Pivot table " { it "Generated a message on extending the Pivot table " {
$warnVar | Should not beNullOrEmpty $warnVar | Should not beNullOrEmpty
@@ -587,18 +597,22 @@ Describe ExportExcel {
Context " # Create and append explicit and auto table and range extension" { Context " # Create and append explicit and auto table and range extension" {
$path = "$env:TEMP\Test.xlsx" $path = "$env:TEMP\Test.xlsx"
#Test -Append automatically extends a table, even when it is not specified in the append command #Test -Append automatically extends a table, even when it is not specified in the append command;
Get-Process | Select-Object -first 10 -Property Name, cpu, pm, handles, company | Export-Excel -Path $path -TableName ProcTab -AutoNameRange -WorkSheetname NoOffset -ClearSheet Get-Process | Select-Object -first 10 -Property Name, cpu, pm, handles, company | Export-Excel -Path $path -TableName ProcTab -AutoNameRange -WorkSheetname NoOffset -ClearSheet
Get-Process | Select-Object -last 10 -Property Name, cpu, pm, handles, company | Export-Excel -Path $path -AutoNameRange -WorkSheetname NoOffset -Append #Test number format applying to new data
Get-Process | Select-Object -last 10 -Property Name, cpu, pm, handles, company | Export-Excel -Path $path -AutoNameRange -WorkSheetname NoOffset -Append -Numberformat 'Number'
$Excel = Open-ExcelPackage $path $Excel = Open-ExcelPackage $path
$dataWs = $Excel.Workbook.Worksheets["NoOffset"] $dataWs = $Excel.Workbook.Worksheets["NoOffset"]
it "Created a new sheet and auto-extended a table and explicitly extended named ranges " { it "Created a new sheet and auto-extended a table and explicitly extended named ranges " {
$dataWs.Tables["ProcTab"].Address.Address | should be "A1:E21" $dataWs.Tables["ProcTab"].Address.Address | Should be "A1:E21"
$dataWs.Names["CPU"].Rows | should be 20 $dataWs.Names["CPU"].Rows | Should be 20
$dataWs.Names["CPU"].Columns | should be 1 $dataWs.Names["CPU"].Columns | Should be 1
}
it "Set the expected number formats " {
$dataWs.cells["C2"].Style.Numberformat.Format | Should be "General"
$dataWs.cells["C12"].Style.Numberformat.Format | Should be "0.00"
} }
#Test extneding autofilter and range when explicitly specified in the append #Test extneding autofilter and range when explicitly specified in the append
$excel = Get-Process | Select-Object -first 10 -Property Name, cpu, pm, handles, company | Export-Excel -ExcelPackage $excel -RangeName procs -AutoFilter -WorkSheetname NoOffset -ClearSheet -PassThru $excel = Get-Process | Select-Object -first 10 -Property Name, cpu, pm, handles, company | Export-Excel -ExcelPackage $excel -RangeName procs -AutoFilter -WorkSheetname NoOffset -ClearSheet -PassThru
Get-Process | Select-Object -last 10 -Property Name, cpu, pm, handles, company | Export-Excel -ExcelPackage $excel -RangeName procs -AutoFilter -WorkSheetname NoOffset -Append Get-Process | Select-Object -last 10 -Property Name, cpu, pm, handles, company | Export-Excel -ExcelPackage $excel -RangeName procs -AutoFilter -WorkSheetname NoOffset -Append
@@ -606,11 +620,11 @@ Describe ExportExcel {
$dataWs = $Excel.Workbook.Worksheets["NoOffset"] $dataWs = $Excel.Workbook.Worksheets["NoOffset"]
it "Created a new sheet and explicitly extended named range and autofilter " { it "Created a new sheet and explicitly extended named range and autofilter " {
$dataWs.names["procs"].rows | should be 21 $dataWs.names["procs"].rows | Should be 21
$dataWs.names["procs"].Columns | should be 5 $dataWs.names["procs"].Columns | Should be 5
$dataWs.Names["_xlnm._FilterDatabase"].Rows | should be 21 #2 x 10 data + 1 header $dataWs.Names["_xlnm._FilterDatabase"].Rows | Should be 21 #2 x 10 data + 1 header
$dataWs.Names["_xlnm._FilterDatabase"].Columns | should be 5 #Name, cpu, pm, handles & company $dataWs.Names["_xlnm._FilterDatabase"].Columns | Should be 5 #Name, cpu, pm, handles & company
$dataWs.Names["_xlnm._FilterDatabase"].AutoFilter | should be $true $dataWs.Names["_xlnm._FilterDatabase"].AutoFilter | Should be $true
} }
} }
@@ -680,10 +694,10 @@ Describe ExportExcel {
$pt1.RowFields[0].Name | Should be 'Status' $pt1.RowFields[0].Name | Should be 'Status'
$pt1.DataFields[0].Field.name | Should be 'Status' $pt1.DataFields[0].Field.name | Should be 'Status'
$pt1.DataFields[0].Function | Should be 'Count' $pt1.DataFields[0].Function | Should be 'Count'
$pt1.ColumGrandTotals | should be $true $pt1.ColumGrandTotals | Should be $true
$pt1.RowGrandTotals | should be $false $pt1.RowGrandTotals | Should be $false
$pt2.ColumGrandTotals | should be $false $pt2.ColumGrandTotals | Should be $false
$pt2.RowGrandTotals | should be $true $pt2.RowGrandTotals | Should be $true
$pc1.ChartType | Should be 'BarClustered3D' $pc1.ChartType | Should be 'BarClustered3D'
$pc1.From.Column | Should be 0 #chart 1 at 0,10 chart 2 at 4,0 (default) $pc1.From.Column | Should be 0 #chart 1 at 0,10 chart 2 at 4,0 (default)
$pc2.From.Column | Should be 4 $pc2.From.Column | Should be 4
@@ -715,14 +729,14 @@ Describe ExportExcel {
#Test Set-ExcelRange with a column #Test Set-ExcelRange with a column
foreach ($c in 5..9) {Set-ExcelRange $sheet.Column($c) -AutoFit } foreach ($c in 5..9) {Set-ExcelRange $sheet.Column($c) -AutoFit }
Add-PivotTable -PivotTableName "PT_Procs" -ExcelPackage $excel -SourceWorkSheet 1 -PivotRows Company -PivotData @{'Name' = 'Count'} -IncludePivotChart -ChartType ColumnClustered -NoLegend Add-PivotTable -PivotTableName "PT_Procs" -ExcelPackage $excel -SourceWorkSheet 1 -PivotRows Company -PivotData @{'Name' = 'Count'} -IncludePivotChart -ChartType ColumnClustered -NoLegend
Close-ExcelPackage $excel Export-Excel -ExcelPackage $excel -WorksheetName "Processes" -AutoNameRange #Test adding named ranges seperately from adding data.
$excel = Open-ExcelPackage $path $excel = Open-ExcelPackage $path
$sheet = $excel.Workbook.Worksheets["Processes"] $sheet = $excel.Workbook.Worksheets["Processes"]
it "Returned the rule when calling Add-ConditionalFormatting -passthru " { it "Returned the rule when calling Add-ConditionalFormatting -passthru " {
$rule | should not beNullOrEmpty $rule | Should not beNullOrEmpty
$rule.getType().fullname | should be "OfficeOpenXml.ConditionalFormatting.ExcelConditionalFormattingTopPercent" $rule.getType().fullname | Should be "OfficeOpenXml.ConditionalFormatting.ExcelConditionalFormattingTopPercent"
$rule.Style.Font.Strike | should be true $rule.Style.Font.Strike | Should be true
} }
it "Applied the formating " { it "Applied the formating " {
$sheet | Should not beNullOrEmpty $sheet | Should not beNullOrEmpty
@@ -750,6 +764,17 @@ Describe ExportExcel {
$sheet.ConditionalFormatting[2].Formula | Should be '104857600' $sheet.ConditionalFormatting[2].Formula | Should be '104857600'
$sheet.ConditionalFormatting[2].Style.Font.Color.Color.Name | Should be 'ffff0000' $sheet.ConditionalFormatting[2].Style.Font.Color.Color.Name | Should be 'ffff0000'
} }
it "Created the named ranges " {
$sheet.Names.Count | Should be 7
$sheet.Names[0].Start.Column | Should be 1
$sheet.Names[0].Start.Row | Should be 2
$sheet.Names[0].End.Row | Should be $sheet.Dimension.End.Row
$sheet.Names[0].Name | Should be $sheet.Cells['A1'].Value
$sheet.Names[6].Start.Column | Should be 7
$sheet.Names[6].Start.Row | Should be 2
$sheet.Names[6].End.Row | Should be $sheet.Dimension.End.Row
$sheet.Names[6].Name | Should be $sheet.Cells['G1'].Value
}
it "Froze the panes " { it "Froze the panes " {
$sheet.view.Panes.Count | Should be 3 $sheet.view.Panes.Count | Should be 3
} }
@@ -831,7 +856,7 @@ Describe ExportExcel {
Add-ExcelChart -Worksheet $excel.Workbook.Worksheets["Sinx"] -ChartType line -XRange "X" -YRange "Sinx" -SeriesHeader "Sin(x)" -Title "Graph of Sine X" -TitleBold -TitleSize 14 ` Add-ExcelChart -Worksheet $excel.Workbook.Worksheets["Sinx"] -ChartType line -XRange "X" -YRange "Sinx" -SeriesHeader "Sin(x)" -Title "Graph of Sine X" -TitleBold -TitleSize 14 `
-Column 2 -ColumnOffSetPixels 35 -Width 800 -XAxisTitleText "Degrees" -XAxisTitleBold -XAxisTitleSize 12 -XMajorUnit 30 -XMinorUnit 10 -XMinValue 0 -XMaxValue 361 -XAxisNumberformat "000" ` -Column 2 -ColumnOffSetPixels 35 -Width 800 -XAxisTitleText "Degrees" -XAxisTitleBold -XAxisTitleSize 12 -XMajorUnit 30 -XMinorUnit 10 -XMinValue 0 -XMaxValue 361 -XAxisNumberformat "000" `
-YMinValue -1.25 -YMaxValue 1.25 -YMajorUnit 0.25 -YAxisNumberformat "0.00" -YAxisTitleText "Sine" -YAxisTitleBold -YAxisTitleSize 12 ` -YMinValue -1.25 -YMaxValue 1.25 -YMajorUnit 0.25 -YAxisNumberformat "0.00" -YAxisTitleText "Sine" -YAxisTitleBold -YAxisTitleSize 12 `
-LegendSize 8 -legendBold -LegendPostion Bottom -LegendSize 8 -legendBold -LegendPosition Bottom
Add-ConditionalFormatting -WorkSheet $excel.Workbook.Worksheets["Sinx"] -Range "B2:B362" -RuleType LessThan -ConditionValue "=B1" -ForeGroundColor Red Add-ConditionalFormatting -WorkSheet $excel.Workbook.Worksheets["Sinx"] -Range "B2:B362" -RuleType LessThan -ConditionValue "=B1" -ForeGroundColor Red
$ws = $Excel.Workbook.Worksheets["Sinx"] $ws = $Excel.Workbook.Worksheets["Sinx"]
$d = $ws.Drawings[0] $d = $ws.Drawings[0]
@@ -864,6 +889,24 @@ Describe ExportExcel {
} }
Close-ExcelPackage -ExcelPackage $excel -nosave Close-ExcelPackage -ExcelPackage $excel -nosave
} }
Context " # Quick line chart" {
$path = "$env:TEMP\Test.xlsx"
Remove-Item -Path $path -ErrorAction SilentlyContinue
#test drawing a chart when data doesn't have a string
0..360 | ForEach-Object {[pscustomobject][ordered]@{x = $_; Sinx = "=Sin(Radians(x)) "}} | Export-Excel -AutoNameRange -Path $path -LineChart
$excel = Open-ExcelPackage -Path $path
$ws = $excel.Sheet1
$d = $ws.Drawings[0]
it "Created the chart " {
$d.Title.text | Should beNullOrEmpty
$d.ChartType | Should be "line"
$d.Series[0].Header | Should be "Sinx"
$d.Series[0].xSeries | Should be "'Sheet1'!A2:A362"
$d.Series[0].Series | Should be "'Sheet1'!B2:B362"
}
}
Context " # Quick Pie chart and three icon conditional formating" { Context " # Quick Pie chart and three icon conditional formating" {
$path = "$Env:TEMP\Pie.xlsx" $path = "$Env:TEMP\Pie.xlsx"
@@ -875,8 +918,8 @@ Describe ExportExcel {
$Cf = New-ConditionalFormattingIconSet -Range ($range -replace "^.*:","B2:") -ConditionalFormat ThreeIconSet -Reverse -IconType Flags $Cf = New-ConditionalFormattingIconSet -Range ($range -replace "^.*:","B2:") -ConditionalFormat ThreeIconSet -Reverse -IconType Flags
$ct = New-ConditionalText -Text "Microsoft" -ConditionalTextColor red -BackgroundColor AliceBlue -ConditionalType ContainsText $ct = New-ConditionalText -Text "Microsoft" -ConditionalTextColor red -BackgroundColor AliceBlue -ConditionalType ContainsText
it "Created the Conditional formatting rules " { it "Created the Conditional formatting rules " {
$cf.Formatter | should be "ThreeIconSet" $cf.Formatter | Should be "ThreeIconSet"
$cf.IconType | should be "Flags" $cf.IconType | Should be "Flags"
$cf.Range | Should be ($range -replace "^.*:","B2:") $cf.Range | Should be ($range -replace "^.*:","B2:")
$cf.Reverse | Should be $true $cf.Reverse | Should be $true
$ct.BackgroundColor.Name | Should be "AliceBlue" $ct.BackgroundColor.Name | Should be "AliceBlue"
@@ -891,13 +934,13 @@ Describe ExportExcel {
$chart = $excel.Workbook.Worksheets["sheet1"].Drawings[0] $chart = $excel.Workbook.Worksheets["sheet1"].Drawings[0]
$cFmt = $excel.Workbook.Worksheets["sheet1"].ConditionalFormatting $cFmt = $excel.Workbook.Worksheets["sheet1"].ConditionalFormatting
it "Created the chart with the right series " { it "Created the chart with the right series " {
$chart.ChartType | should be "PieExploded3D" $chart.ChartType | Should be "PieExploded3D"
$chart.series.series | should be "'Sheet1'!B1:B$rows" #would be B2 and A2 if we had a header. $chart.series.series | Should be "'Sheet1'!B1:B$rows" #would be B2 and A2 if we had a header.
$chart.series.Xseries | should be "'Sheet1'!A1:A$rows" $chart.series.Xseries | Should be "'Sheet1'!A1:A$rows"
$chart.DataLabel.ShowPercent | should be $true $chart.DataLabel.ShowPercent | Should be $true
} }
it "Created two Conditional formatting rules " { it "Created two Conditional formatting rules " {
$cFmt.Count | should be $true $cFmt.Count | Should be $true
$cFmt.Where({$_.type -eq "ContainsText"}) | Should not beNullOrEmpty $cFmt.Where({$_.type -eq "ContainsText"}) | Should not beNullOrEmpty
$cFmt.Where({$_.type -eq "ThreeIconSet"}) | Should not beNullOrEmpty $cFmt.Where({$_.type -eq "ThreeIconSet"}) | Should not beNullOrEmpty
} }
@@ -923,17 +966,17 @@ Describe ExportExcel {
$excel = Open-ExcelPackage -Path $path $excel = Open-ExcelPackage -Path $path
$ws = $excel.Workbook.Worksheets[1] $ws = $excel.Workbook.Worksheets[1]
it "Created 3 tables " { it "Created 3 tables " {
$ws.tables.count | should be 3 $ws.tables.count | Should be 3
} }
it "Created the FileSize table in the right place with the right size and style " { it "Created the FileSize table in the right place with the right size and style " {
$ws.Tables["FileSize"].Address.Address | should be "G2:H16" #Insert at row 2, Column 7, 14 rows x 2 columns of data $ws.Tables["FileSize"].Address.Address | Should be "G2:H16" #Insert at row 2, Column 7, 14 rows x 2 columns of data
$ws.Tables["FileSize"].StyleName | should be "TableStyleMedium2" $ws.Tables["FileSize"].StyleName | Should be "TableStyleMedium2"
} }
it "Created the ExtSize table in the right place with the right size " { it "Created the ExtSize table in the right place with the right size " {
$ws.Tables["ExtSize"].Address.Address | should be "A2:B14" #tile, then 12 rows x 2 columns of data $ws.Tables["ExtSize"].Address.Address | Should be "A2:B14" #tile, then 12 rows x 2 columns of data
} }
it "Created the ExtCount table in the right place with the right size " { it "Created the ExtCount table in the right place with the right size " {
$ws.Tables["ExtCount"].Address.Address | should be "D2:E12" #title, then 10 rows x 2 columns of data $ws.Tables["ExtCount"].Address.Address | Should be "D2:E12" #title, then 10 rows x 2 columns of data
} }
} }

View File

@@ -12,7 +12,7 @@ Banana, Paris, 300, 200
Apple, New York, 1200,700 Apple, New York, 1200,700
"@ | Export-Excel -Path $path -TableStyle Medium13 -tablename "RawData" -ConditionalFormat @{Range="C2:C7"; DataBarColor="Green"} -ExcelChartDefinition @{ChartType="Doughnut";XRange="A2:B7"; YRange="C2:C7"; width=800; } -PivotTableDefinition @{Sales=@{ "@ | Export-Excel -Path $path -TableStyle Medium13 -tablename "RawData" -ConditionalFormat @{Range="C2:C7"; DataBarColor="Green"} -ExcelChartDefinition @{ChartType="Doughnut";XRange="A2:B7"; YRange="C2:C7"; width=800; } -PivotTableDefinition @{Sales=@{
PivotRows="City"; PivotColumns="Product"; PivotData=@{Gross="Sum";Net="Sum"}; PivotNumberFormat="$#,##0.00"; PivotTotals="Both"; PivotTableSyle="Medium12"; Activate=$true PivotRows="City"; PivotColumns="Product"; PivotData=@{Gross="Sum";Net="Sum"}; PivotNumberFormat="$#,##0.00"; PivotTotals="Both"; PivotTableSyle="Medium12"; Activate=$true
PivotChartDefinition=@{Title="Gross and net by city and product"; ChartType="ColumnClustered"; Column=6; Width=600; Height=360; YMajorUnit=500; YMinorUnit=100; YAxisNumberformat="$#,##0"; LegendPostion="Bottom"}}} PivotChartDefinition=@{Title="Gross and net by city and product"; ChartType="ColumnClustered"; Column=6; Width=600; Height=360; YMajorUnit=500; YMinorUnit=100; YAxisNumberformat="$#,##0"; LegendPosition="Bottom"}}}
$excel = Open-ExcelPackage $path $excel = Open-ExcelPackage $path
$ws1 = $excel.Workbook.Worksheets[1] $ws1 = $excel.Workbook.Worksheets[1]

View File

@@ -18,7 +18,7 @@ Describe "Creating small named ranges with hyperlinks" {
$worksheet = $excel.Workbook.Worksheets[1] $worksheet = $excel.Workbook.Worksheets[1]
$columns = $worksheet.Dimension.Columns $columns = $worksheet.Dimension.Columns
1..$columns | foreach {Add-ExcelName -Range $worksheet.cells[$topRow,$_,$lastDataRow,$_]} #Test Add-Excel Name on its own (outside Export-Excel) 1..$columns | ForEach-Object {Add-ExcelName -Range $worksheet.cells[$topRow,$_,$lastDataRow,$_]} #Test Add-Excel Name on its own (outside Export-Excel)
$scwarnVar = $null $scwarnVar = $null
Set-ExcelColumn -Worksheet $worksheet -StartRow $topRow -Heading "PlacesGained/Lost" ` Set-ExcelColumn -Worksheet $worksheet -StartRow $topRow -Heading "PlacesGained/Lost" `
@@ -39,7 +39,7 @@ Describe "Creating small named ranges with hyperlinks" {
$ct = New-ConditionalText -Text "Ferrari" $ct = New-ConditionalText -Text "Ferrari"
$ct2 = New-ConditionalText -Range $worksheet.Names["FinishPosition"].Address -ConditionalType LessThanOrEqual -Text 3 -ConditionalText Red -Background White #Test new-conditionalText in shortest and longest forms. $ct2 = New-ConditionalText -Range $worksheet.Names["FinishPosition"].Address -ConditionalType LessThanOrEqual -Text 3 -ConditionalText Red -Background White #Test new-conditionalText in shortest and longest forms.
#Create links for each group name (race) and Export them so they start at Cell A1; create a pivot table with definition just created, save the file and open in Excel #Create links for each group name (race) and Export them so they start at Cell A1; create a pivot table with definition just created, save the file and open in Excel
$results | foreach {(New-Object -TypeName OfficeOpenXml.ExcelHyperLink -ArgumentList "Sheet1!$($_.Name)" , "$($_.name) GP")} | #Test Exporting Hyperlinks with display property. $results | ForEach-Object {(New-Object -TypeName OfficeOpenXml.ExcelHyperLink -ArgumentList "Sheet1!$($_.Name)" , "$($_.name) GP")} | #Test Exporting Hyperlinks with display property.
Export-Excel -ExcelPackage $excel -AutoSize -PivotTableDefinition $pt -Calculate -ConditionalFormat $ct,$ct2 #Test conditional text rules in conditional format (orignally icon sets only ) Export-Excel -ExcelPackage $excel -AutoSize -PivotTableDefinition $pt -Calculate -ConditionalFormat $ct,$ct2 #Test conditional text rules in conditional format (orignally icon sets only )
$excel = Open-ExcelPackage $path $excel = Open-ExcelPackage $path

View File

@@ -0,0 +1,26 @@
#Requires -Modules Pester
Import-Module $PSScriptRoot\..\ImportExcel.psd1 -Force
Describe "Check if Function aliases exist" {
It "Set-Column should exist" {
Get-Command Set-Column | Should Not Be $null
}
It "Set-Row should exist" {
Get-Command Set-Row | Should Not Be $null
}
It "Set-Format should exist" {
Get-Command Set-Format | Should Not Be $null
}
It "Merge-MulipleSheets should exist" {
Get-Command Merge-MulipleSheets | Should Not Be $null
}
It "New-ExcelChart should exist" {
Get-Command New-ExcelChart | Should Not Be $null
}
}

View File

@@ -30,9 +30,9 @@ Describe "Join Worksheet" {
$data2 | Export-Excel -Path $path -WorkSheetname Abingdon $data2 | Export-Excel -Path $path -WorkSheetname Abingdon
$data3 | Export-Excel -Path $path -WorkSheetname Banbury $data3 | Export-Excel -Path $path -WorkSheetname Banbury
$ptdef = New-PivotTableDefinition -PivotTableName "SummaryPivot" -PivotRows "Store" -PivotColumns "Product" -PivotData @{"Total"="SUM"} -IncludePivotChart -ChartTitle "Sales Breakdown" -ChartType ColumnStacked -ChartColumn 10 $ptdef = New-PivotTableDefinition -PivotTableName "SummaryPivot" -PivotRows "Store" -PivotColumns "Product" -PivotData @{"Total"="SUM"} -IncludePivotChart -ChartTitle "Sales Breakdown" -ChartType ColumnStacked -ChartColumn 10
Join-Worksheet -Path $path -WorkSheetName "Total" -Clearsheet -FromLabel "Store" -TableName "SummaryTable" -TableStyle Light1 -AutoSize -BoldTopRow -FreezePane 2,1 -Title "Store Sales Summary" -TitleBold -TitleSize 14 -PivotTableDefinition $ptdef Join-Worksheet -Path $path -WorkSheetName "Total" -Clearsheet -FromLabel "Store" -TableName "SummaryTable" -TableStyle Light1 -AutoSize -BoldTopRow -FreezePane 2,1 -Title "Store Sales Summary" -TitleBold -TitleSize 14 -TitleBackgroundColor AliceBlue -PivotTableDefinition $ptdef
$excel = Export-Excel -path $path -WorkSheetname SummaryPivot -Activate -HideSheet * -UnHideSheet "Total","SummaryPivot" -PassThru $excel = Export-Excel -path $path -WorkSheetname SummaryPivot -Activate -NoTotalsInPivot -PivotDataToColumn -HideSheet * -UnHideSheet "Total","SummaryPivot" -PassThru
# Open-ExcelPackage -Path $path # Open-ExcelPackage -Path $path
$ws = $excel.Workbook.Worksheets["Total"] $ws = $excel.Workbook.Worksheets["Total"]
@@ -52,28 +52,31 @@ Describe "Join Worksheet" {
it "Activated the correct worksheet " { it "Activated the correct worksheet " {
$excel.Workbook.worksheets["SummaryPivot"].View.TabSelected | Should be $true $excel.Workbook.worksheets["SummaryPivot"].View.TabSelected | Should be $true
$excel.Workbook.worksheets["Total"].View.TabSelected | Should be $false $excel.Workbook.worksheets["Total"].View.TabSelected | Should be $false
} }
} }
Context "Merging 3 blocks" { Context "Merging 3 blocks" {
it "Created sheet of the right size with a title and a table " { it "Created sheet of the right size with a title and a table " {
$ws.Dimension.Address | Should be "A1:F16" $ws.Dimension.Address | Should be "A1:F16"
$ws.Tables[0].Address.Address | Should be "A2:F16" $ws.Tables[0].Address.Address | Should be "A2:F16"
$ws.cells["A1"].Value | Should be "Store Sales Summary" $ws.Cells["A1"].Value | Should be "Store Sales Summary"
$ws.cells["A1"].Style.Font.Size | Should be 14 $ws.Cells["A1"].Style.Font.Size | Should be 14
$ws.Cells["A1"].Style.Font.Bold | Should be $True
$ws.Cells["A1"].Style.Fill.BackgroundColor.Rgb | Should be "FFF0F8FF"
$ws.Cells["A1"].Style.Fill.PatternType.ToString() | Should be "Solid"
$ws.Tables[0].StyleName | Should be "TableStyleLight1" $ws.Tables[0].StyleName | Should be "TableStyleLight1"
$ws.cells["A2:F2"].Style.Font.Bold | Should be $True $ws.Cells["A2:F2"].Style.Font.Bold | Should be $True
} }
it "Added a from column with the right heading " { it "Added a from column with the right heading " {
$ws.cells["F2" ].Value | Should be "Store" $ws.Cells["F2" ].Value | Should be "Store"
$ws.cells["F3" ].Value | Should be "Oxford" $ws.Cells["F3" ].Value | Should be "Oxford"
$ws.cells["F8" ].Value | Should be "Abingdon" $ws.Cells["F8" ].Value | Should be "Abingdon"
$ws.cells["F13"].Value | Should be "Banbury" $ws.Cells["F13"].Value | Should be "Banbury"
} }
it "Filled in the data " { it "Filled in the data " {
$ws.cells["C3" ].Value | Should be $data1[0].quantity $ws.Cells["C3" ].Value | Should be $data1[0].quantity
$ws.cells["C8" ].Value | Should be $data2[0].quantity $ws.Cells["C8" ].Value | Should be $data2[0].quantity
$ws.cells["C13"].Value | Should be $data3[0].quantity $ws.Cells["C13"].Value | Should be $data3[0].quantity
} }
it "Created the pivot table " { it "Created the pivot table " {
$pt | Should not beNullOrEmpty $pt | Should not beNullOrEmpty

View File

@@ -145,7 +145,8 @@ Describe "Set-ExcelColumn, Set-ExcelRow and Set-ExcelRange" {
Set-ExcelRange -Address $ws.Column(1) -Width 0 Set-ExcelRange -Address $ws.Column(1) -Width 0
Set-ExcelRange -Address $ws.Column(2) -AutoFit Set-ExcelRange -Address $ws.Column(2) -AutoFit
Set-ExcelRange -Address $ws.Cells["E:E"] -AutoFit Set-ExcelRange -Address $ws.Cells["E:E"] -AutoFit
Set-ExcelRange -Address $ws.row(5) -Height 0 #Test alias
Set-Format -Address $ws.row(5) -Height 0
$rr = $r.row $rr = $r.row
Set-ExcelRange -WorkSheet $ws -Range "B$rr" -Value "Total" Set-ExcelRange -WorkSheet $ws -Range "B$rr" -Value "Total"
$BadHideWarnvar = $null $BadHideWarnvar = $null
@@ -242,7 +243,10 @@ Describe "Set-ExcelColumn, Set-ExcelRow and Set-ExcelRange" {
else {[datetime]::new($cyear, $bmonth, $bday) } else {[datetime]::new($cyear, $bmonth, $bday) }
} }
Set-ExcelColumn -Worksheet $ws -Heading "Age" -Value "=INT((NOW()-DateOfBirth)/365)" Set-ExcelColumn -Worksheet $ws -Heading "Age" -Value "=INT((NOW()-DateOfBirth)/365)"
Set-ExcelRange -Address $c,$ws.column(3) -NumberFormat 'Short Date' -AutoSize # Test Piping column Numbers into Set excelColumn
3, $c.ColumnMin | Set-ExcelColumn -Worksheet $ws -NumberFormat 'Short Date' -AutoSize
4..6 | Set-ExcelColumn -Worksheet $ws -AutoNameRange
Close-ExcelPackage -ExcelPackage $excel -Calculate Close-ExcelPackage -ExcelPackage $excel -Calculate
$excel = Open-ExcelPackage $path $excel = Open-ExcelPackage $path
@@ -251,9 +255,8 @@ Describe "Set-ExcelColumn, Set-ExcelRow and Set-ExcelRange" {
It "Inserted Hyperlinks " { It "Inserted Hyperlinks " {
$ws.Cells["D2"].Hyperlink | Should not beNullorEmpty $ws.Cells["D2"].Hyperlink | Should not beNullorEmpty
$ws.Cells["D2"].Style.Font.UnderLine | Should be $true $ws.Cells["D2"].Style.Font.UnderLine | Should be $true
} }
It "Inserted Dates " { It "Inserted and formatted Dates " {
$ws.Cells["C2"].Value.GetType().name | should be "DateTime" $ws.Cells["C2"].Value.GetType().name | should be "DateTime"
$ws.Cells["C2"].Style.Numberformat.NumFmtID | should be 14 $ws.Cells["C2"].Style.Numberformat.NumFmtID | should be 14
$ws.Cells["E2"].Value.GetType().name | should be "DateTime" $ws.Cells["E2"].Value.GetType().name | should be "DateTime"
@@ -262,6 +265,17 @@ Describe "Set-ExcelColumn, Set-ExcelRow and Set-ExcelRange" {
It "Inserted Formulas " { It "Inserted Formulas " {
$ws.Cells["F2"].Formula | Should not beNullorEmpty $ws.Cells["F2"].Formula | Should not beNullorEmpty
} }
It "Created Named ranges " {
$ws.Names.Count | Should be 6
$ws.Names["Age"] | Should not beNullorEmpty
$ws.Names["Age"].Start.Column | Should be 6
$ws.Names["Age"].Start.Row | Should be 2
$ws.Names["Age"].End.Row | Should be 7
$ws.names[0].name | Should be "Name"
$ws.Names[0].Start.Column | Should be 1
$ws.Names[0].Start.Row | Should be 2
}
} }
} }

View File

@@ -1,91 +1,99 @@
Function Compare-WorkSheet { Function Compare-WorkSheet {
<# <#
.Synopsis .Synopsis
Compares two worksheets with the same name in different files. Compares two worksheets and shows the differences.
.Description .Description
This command takes two file names, a worksheet name and a name for a key column. This command takes two file names, one or two worksheet name and a name for a key column.
It reads the worksheet from each file and decides the column names. It reads the worksheet from each file and decides the column names.
It builds as hashtable of the key column values and the rows they appear in It builds a hashtable of the key-column values and the rows in which they appear.
It then uses PowerShell's compare object command to compare the sheets (explicity checking all column names which have not been excluded) It then uses PowerShell's compare object command to compare the sheets (explicity checking
For the difference rows it adds the row number for the key of that row - we have to add the key after doing the comparison, all the column names which have not been excluded). For the difference rows it adds the
otherwise rows will be considered as different simply because they have different row numbers row number for the key of that row - we have to add the key after doing the comparison,
We also add the name of the file in which the difference occurs. otherwise identical rows at diffeent positions in the file will not will be considered to match.
If -BackgroundColor is specified the difference rows will be changed to that background. We also add the name of the file and sheet in which the difference occurs.
If -BackgroundColor is specified the difference rows will be changed to that background in the orginal file.
.Example .Example
Compare-WorkSheet -Referencefile 'Server56.xlsx' -Differencefile 'Server57.xlsx' -WorkSheetName Products -key IdentifyingNumber -ExcludeProperty Install* | format-table Compare-WorkSheet -Referencefile 'Server56.xlsx' -Differencefile 'Server57.xlsx' -WorkSheetName Products -key IdentifyingNumber -ExcludeProperty Install* | Format-Table
The two workbooks in this example contain the result of redirecting a subset of properties from Get-WmiObject -Class win32_product to Export-Excel
The command compares the "products" pages in the two workbooks, but we don't want to register a differnce if if the software was installed on a The two workbooks in this example contain the result of redirecting a subset of properties from Get-WmiObject -Class win32_product to Export-Excel.
different date or from a different place, so Excluding Install* removes InstallDate and InstallSource. The command compares the "Products" pages in the two workbooks, but we don't want to register a difference if the software was installed on a
This data doesn't have a "name" column" so we specify the "IdentifyingNumber" column as the key. different date or from a different place, and excluding Install* removes InstallDate and InstallSource.
This data doesn't have a "Name" column" so we specify the "IdentifyingNumber" column as the key.
The results will be presented as a table. The results will be presented as a table.
.Example .Example
compare-WorkSheet "Server54.xlsx" "Server55.xlsx" -WorkSheetName services -GridView compare-WorkSheet "Server54.xlsx" "Server55.xlsx" -WorkSheetName Services -GridView
This time two workbooks contain the result of redirecting Get-WmiObject -Class win32_service to Export-Excel
Here the -Differencefile and -Referencefile parameter switches are assumed , and the default setting for -key ("Name") works for services This time two workbooks contain the result of redirecting Get-WmiObject -Class win32_service to Export-Excel.
This will display the differences between the "services" sheets using a grid view Here the -Differencefile and -Referencefile parameter switches are assumed , and the default setting for -key ("Name") works for services
This will display the differences between the "Services" sheets using a grid view
.Example .Example
Compare-WorkSheet 'Server54.xlsx' 'Server55.xlsx' -WorkSheetName Services -BackgroundColor lightGreen Compare-WorkSheet 'Server54.xlsx' 'Server55.xlsx' -WorkSheetName Services -BackgroundColor lightGreen
This version of the command outputs the differences between the "services" pages and also highlights any different rows in the spreadsheet files.
This version of the command outputs the differences between the "services" pages and highlights any different rows in the spreadsheet files.
.Example .Example
Compare-WorkSheet 'Server54.xlsx' 'Server55.xlsx' -WorkSheetName Services -BackgroundColor lightGreen -FontColor Red -Show Compare-WorkSheet 'Server54.xlsx' 'Server55.xlsx' -WorkSheetName Services -BackgroundColor lightGreen -FontColor Red -Show
This builds on the previous example: this time Where two changed rows have the value in the "name" column (the default value for -key),
This example builds on the previous one: this time where two changed rows have the value in the "Name" column (the default value for -Key),
this version adds highlighting of the changed cells in red; and then opens the Excel file. this version adds highlighting of the changed cells in red; and then opens the Excel file.
.Example .Example
Compare-WorkSheet 'Pester-tests.xlsx' 'Pester-tests.xlsx' -WorkSheetName 'Server1','Server2' -Property "full Description","Executed","Result" -Key "full Description" Compare-WorkSheet 'Pester-tests.xlsx' 'Pester-tests.xlsx' -WorkSheetName 'Server1','Server2' -Property "full Description","Executed","Result" -Key "full Description"
This time the reference file and the difference file are the same file and two different sheets are used. Because the tests include the This time the reference file and the difference file are the same file and two different sheets are used. Because the tests include the
machine name and time the test was run the command specifies a limited set of columns should be used. machine name and time the test was run the command specifies that a limited set of columns should be used.
.Example .Example
Compare-WorkSheet 'Server54.xlsx' 'Server55.xlsx' -WorkSheetName general -Startrow 2 -Headername Label,value -Key Label -GridView -ExcludeDifferent Compare-WorkSheet 'Server54.xlsx' 'Server55.xlsx' -WorkSheetName general -Startrow 2 -Headername Label,value -Key Label -GridView -ExcludeDifferent
The "General" page has a title and two unlabelled columns with a row forCPU, Memory, Domain, Disk and so on
So the command is instructed to starts at row 2 to skip the title and to name the columns: the first is "label" and the Second "Value"; The "General" page in the two workbooks has a title and two unlabelled columns with a row each for CPU, Memory, Domain, Disk and so on;
the label acts as the key. This time we interested the rows which are the same in both sheets, so the command is instructed to start at row 2 in order to skip the title and given names for the columns: the first is "label" and the Second "Value";
the label acts as the key. This time we interested the rows which are the same in both sheets,
and the result is displayed using grid view. Note that grid view works best when the number of columns is small. and the result is displayed using grid view. Note that grid view works best when the number of columns is small.
.Example .Example
Compare-WorkSheet 'Server1.xlsx' 'Server2.xlsx' -WorkSheetName general -Startrow 2 -Headername Label,value -Key Label -BackgroundColor White -Show -AllDataBackgroundColor LightGray Compare-WorkSheet 'Server1.xlsx' 'Server2.xlsx' -WorkSheetName general -Startrow 2 -Headername Label,value -Key Label -BackgroundColor White -Show -AllDataBackgroundColor LightGray
This version of the previous command lightlights all the cells in lightgray and then sets the changed rows back to white; only
the unchanged rows are highlighted This version of the previous command highlights all the cells in lightgray and then sets the changed rows back to white;
only the unchanged rows are highlighted
#> #>
[cmdletbinding(DefaultParameterSetName)] [cmdletbinding(DefaultParameterSetName)]
Param( Param(
#First file to compare #First file to compare.
[parameter(Mandatory=$true,Position=0)] [parameter(Mandatory=$true,Position=0)]
$Referencefile , $Referencefile ,
#Second file to compare #Second file to compare.
[parameter(Mandatory=$true,Position=1)] [parameter(Mandatory=$true,Position=1)]
$Differencefile , $Differencefile ,
#Name(s) of worksheets to compare. #Name(s) of worksheets to compare.
$WorkSheetName = "Sheet1", $WorkSheetName = "Sheet1",
#Properties to include in the DIFF - supports wildcards, default is "*" #Properties to include in the DIFF - supports wildcards, default is "*".
$Property = "*" , $Property = "*" ,
#Properties to exclude from the the search - supports wildcards #Properties to exclude from the search - supports wildcards.
$ExcludeProperty , $ExcludeProperty ,
#Specifies custom property names to use, instead of the values defined in the column headers of the TopRow. #Specifies custom property names to use, instead of the values defined in the starting row of the sheet.
[Parameter(ParameterSetName='B', Mandatory)] [Parameter(ParameterSetName='B', Mandatory)]
[String[]]$Headername, [String[]]$Headername,
#Automatically generate property names (P1, P2, P3, ..) instead of the using the values the top row of the sheet #Automatically generate property names (P1, P2, P3 ...) instead of the using the values the starting row of the sheet.
[Parameter(ParameterSetName='C', Mandatory)] [Parameter(ParameterSetName='C', Mandatory)]
[switch]$NoHeader, [switch]$NoHeader,
#The row from where we start to import data, all rows above the StartRow are disregarded. By default this is the first row. #The row from where we start to import data: all rows above the start row are disregarded. By default, this is the first row.
[int]$Startrow = 1, [int]$Startrow = 1,
#If specified, highlights all the cells - so you can make Equal cells one colour, and Diff cells another. #If specified, highlights all the cells - so you can make Equal cells one colour, and Diff cells another.
[System.Drawing.Color]$AllDataBackgroundColor, [System.Drawing.Color]$AllDataBackgroundColor,
#If specified, highlights the DIFF rows #If specified, highlights the DIFF rows.
[System.Drawing.Color]$BackgroundColor, [System.Drawing.Color]$BackgroundColor,
#If specified identifies the tabs which contain DIFF rows (ignored if -backgroundColor is omitted) #If specified identifies the tabs which contain DIFF rows (ignored if -BackgroundColor is omitted).
[System.Drawing.Color]$TabColor, [System.Drawing.Color]$TabColor,
#Name of a column which is unique and will be used to add a row to the DIFF object, default is "Name" #Name of a column which is unique and will be used to add a row to the DIFF object, defaults to "Name".
$Key = "Name" , $Key = "Name" ,
#If specified, highlights the DIFF columns in rows which have the same key. #If specified, highlights the DIFF columns in rows which have the same key.
[System.Drawing.Color]$FontColor, [System.Drawing.Color]$FontColor,
#If specified opens the Excel workbooks instead of outputting the diff to the console (unless -passthru is also specified) #If specified opens the Excel workbooks instead of outputting the diff to the console (unless -Passthru is also specified).
[Switch]$Show, [Switch]$Show,
#If specified, the command tries to the show the DIFF in a Gridview and not on the console. (unless-Passthru is also specified). This Works best with few columns selected, and requires a key #If specified, the command tries to the show the DIFF in a Grid-View and not on the console. (unless-Passthru is also specified). This Works best with few columns selected, and requires a key.
[switch]$GridView, [switch]$GridView,
#If specified -Passthrough full set of diff data is returned without filtering to the specified properties #If specified -Passthrough a full set of diff data is returned without filtering to the specified properties.
[Switch]$PassThru, [Switch]$PassThru,
#If specified the result will include equal rows as well. By default only different rows are returned #If specified the result will include Equal rows as well. By default only Different rows are returned.
[Switch]$IncludeEqual, [Switch]$IncludeEqual,
#If Specified the result includes only the rows where both are equal #If Specified the result includes only the rows where both are equal.
[Switch]$ExcludeDifferent [Switch]$ExcludeDifferent
) )
@@ -198,6 +206,8 @@ Function Compare-WorkSheet {
#if nothing was found write a message which wont be redirected #if nothing was found write a message which wont be redirected
if (-not $diff) {Write-Host "Comparison of $Referencefile::$worksheet1 and $Differencefile::$WorkSheet2 returned no results." } if (-not $diff) {Write-Host "Comparison of $Referencefile::$worksheet1 and $Differencefile::$WorkSheet2 returned no results." }
if ($Show) { if ($Show) {
Start-Process -FilePath $Referencefile Start-Process -FilePath $Referencefile
if (-not $oneFile) { Start-Process -FilePath $Differencefile } if (-not $oneFile) { Start-Process -FilePath $Differencefile }

BIN
fib.xlsx

Binary file not shown.

View File

@@ -30,6 +30,7 @@ New-ExcelChart.ps1
New-PSItem.ps1 New-PSItem.ps1
Open-ExcelPackage.ps1 Open-ExcelPackage.ps1
Pivot.ps1 Pivot.ps1
PivotTable.ps1
Plot.ps1 Plot.ps1
Send-SQLDataToExcel.ps1 Send-SQLDataToExcel.ps1
Set-CellStyle.ps1 Set-CellStyle.ps1

View File

@@ -155,7 +155,7 @@ class PSPlot {
$sum=0 $sum=0
$columnName.ToCharArray() | $columnName.ToCharArray() |
ForEach { ForEach-Object {
$sum*=26 $sum*=26
$sum+=[char]$_.tostring().toupper()-[char]'A'+1 $sum+=[char]$_.tostring().toupper()-[char]'A'+1
} }

View File

@@ -3,7 +3,7 @@ function ConvertFrom-ExcelColumnName {
$sum=0 $sum=0
$columnName.ToCharArray() | $columnName.ToCharArray() |
ForEach { ForEach-Object {
$sum*=26 $sum*=26
$sum+=[char]$_.tostring().toupper()-[char]'A'+1 $sum+=[char]$_.tostring().toupper()-[char]'A'+1
} }