mirror of
https://github.com/dfinke/ImportExcel.git
synced 2025-12-06 00:23:20 +00:00
Many changes. Detailed on Readme.md under what's new
This commit is contained in:
@@ -1,22 +1,22 @@
|
||||
Function Add-ConditionalFormatting {
|
||||
<#
|
||||
.Synopsis
|
||||
Adds contitional formatting to worksheet.
|
||||
.Example
|
||||
$excel = $avdata | Export-Excel -Path (Join-path $FilePath "\Machines.XLSX" ) -WorksheetName "Server Anti-Virus" -AutoSize -FreezeTopRow -AutoFilter -PassThru
|
||||
<#
|
||||
.Synopsis
|
||||
Adds contitional formatting to worksheet.
|
||||
.Example
|
||||
$excel = $avdata | Export-Excel -Path (Join-path $FilePath "\Machines.XLSX" ) -WorksheetName "Server Anti-Virus" -AutoSize -FreezeTopRow -AutoFilter -PassThru
|
||||
|
||||
Add-ConditionalFormatting -WorkSheet $excel.Workbook.Worksheets[1] -Address "b2:b1048576" -ForeGroundColor "RED" -RuleType ContainsText -ConditionValue "2003"
|
||||
Add-ConditionalFormatting -WorkSheet $excel.Workbook.Worksheets[1] -Address "i2:i1048576" -ForeGroundColor "RED" -RuleType ContainsText -ConditionValue "Disabled"
|
||||
$excel.Workbook.Worksheets[1].Cells["D1:G1048576"].Style.Numberformat.Format = [cultureinfo]::CurrentCulture.DateTimeFormat.ShortDatePattern
|
||||
$excel.Workbook.Worksheets[1].Row(1).style.font.bold = $true
|
||||
$excel.Save() ; $excel.Dispose()
|
||||
Add-ConditionalFormatting -WorkSheet $excel.Workbook.Worksheets[1] -Address "b2:b1048576" -ForeGroundColor "RED" -RuleType ContainsText -ConditionValue "2003"
|
||||
Add-ConditionalFormatting -WorkSheet $excel.Workbook.Worksheets[1] -Address "i2:i1048576" -ForeGroundColor "RED" -RuleType ContainsText -ConditionValue "Disabled"
|
||||
$excel.Workbook.Worksheets[1].Cells["D1:G1048576"].Style.Numberformat.Format = [cultureinfo]::CurrentCulture.DateTimeFormat.ShortDatePattern
|
||||
$excel.Workbook.Worksheets[1].Row(1).style.font.bold = $true
|
||||
$excel.Save() ; $excel.Dispose()
|
||||
|
||||
Here Export-Excel is called with the -passThru parameter so the Excel Package object is stored in $Excel
|
||||
The desired worksheet is selected and the then columns B and i are conditially formatted (excluding the top row) to show red text if
|
||||
the columns contain "2003" or "Disabled respectively. A fixed date formats are then applied to columns D..G, and the top row is formatted.
|
||||
Finally the workbook is saved and the Excel object closed.
|
||||
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 columns contain "2003" or "Disabled respectively. A fixed date formats are then applied to columns D..G, and the top row is formatted.
|
||||
Finally the workbook is saved and the Excel object closed.
|
||||
|
||||
#>
|
||||
#>
|
||||
Param (
|
||||
#The worksheet where the format is to be applied
|
||||
[Parameter(Mandatory = $true, ParameterSetName = "NamedRule")]
|
||||
|
||||
@@ -1,94 +1,620 @@
|
||||
#Requires -Modules Pester
|
||||
#Requires -Modules Assert
|
||||
#Requires -Modules Pester
|
||||
|
||||
$here = Split-Path -Parent $MyInvocation.MyCommand.Path
|
||||
$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path) -replace '\.Tests\.', '.'
|
||||
|
||||
Import-Module $here -Force
|
||||
|
||||
$WarningPreference = 'SilentlyContinue'
|
||||
$ProgressPreference = 'SilentlyContinue'
|
||||
if (Get-process -Name Excel,xlim -ErrorAction SilentlyContinue) { Write-Warning -Message "You need to close Excel before running the tests." ; return}
|
||||
Describe ExportExcel {
|
||||
|
||||
Function Test-isNumeric {
|
||||
Param (
|
||||
[Parameter(ValueFromPipeline)]$x
|
||||
)
|
||||
Context "#Example 1 # Creates and opens a file with the right number of rows and columns" {
|
||||
$path = "$env:TEMP\Test.xlsx"
|
||||
Remove-item -Path $path -ErrorAction SilentlyContinue
|
||||
$processes = Get-Process
|
||||
$propertyNames = $Processes[0].psobject.properties.name
|
||||
$rowcount = $Processes.Count
|
||||
$Processes | Export-Excel $path -show
|
||||
|
||||
Return $x -is [byte] -or $x -is [int16] -or $x -is [int32] -or $x -is [int64] `
|
||||
-or $x -is [sbyte] -or $x -is [uint16] -or $x -is [uint32] -or $x -is [uint64] `
|
||||
-or $x -is [float] -or $x -is [double] -or $x -is [decimal]
|
||||
}
|
||||
it "Created a new file " {
|
||||
Test-Path -Path $path -ErrorAction SilentlyContinue | should be $true
|
||||
}
|
||||
|
||||
$fakeData = [PSCustOmobject]@{
|
||||
Property_1_Date = (Get-Date).ToString('d') # US '10/16/2017' BE '16/10/2107'
|
||||
Property_2_Formula = '=SUM(G2:H2)'
|
||||
Property_3_String = 'My String'
|
||||
Property_4_String = 'a'
|
||||
Property_5_IPAddress = '10.10.25.5'
|
||||
Property_6_Number = '0'
|
||||
Property_7_Number = '5'
|
||||
Property_8_Number = '007'
|
||||
Property_9_Number = (33).ToString('F2') # US '33.00' BE '33,00'
|
||||
Property_10_Number = (5/3).ToString('F2') # US '1.67' BE '1,67'
|
||||
Property_11_Number = (15999998/3).ToString('N2') # US '5,333,332.67' BE '5.333.332,67'
|
||||
Property_12_Number = '1.555,83'
|
||||
Property_13_PhoneNr = '+32 44'
|
||||
Property_14_PhoneNr = '+32 4 4444 444'
|
||||
Property_15_PhoneNr = '+3244444444'
|
||||
}
|
||||
it "Started Excel to display the file " {
|
||||
Get-process -Name Excel,xlim -ErrorAction SilentlyContinue | should not benullorempty
|
||||
}
|
||||
|
||||
$Path = 'Test.xlsx'
|
||||
Start-Sleep -Seconds 5 ;
|
||||
|
||||
Describe 'Export-Excel' {
|
||||
in $TestDrive {
|
||||
Describe 'Number conversion' {
|
||||
Context 'numerical values expected' {
|
||||
#region Create test file
|
||||
$fakeData | Export-Excel -Path $Path
|
||||
#Open-ExcelPackage with -Create is tested in Export-Excel
|
||||
#This is a test of using it with -KillExcel
|
||||
#TODO Need to test opening pre-existing file with no -create switch (and graceful failure when file does not exist) somewhere else
|
||||
$Excel = Open-ExcelPackage -Path $path -KillExcel
|
||||
it "Killed Excel when Open-Excelpackage was told to " {
|
||||
Get-process -Name Excel,xlim -ErrorAction SilentlyContinue | should benullorempty
|
||||
}
|
||||
|
||||
$Path = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
|
||||
$Excel = New-Object OfficeOpenXml.ExcelPackage $Path
|
||||
$Worksheet = $Excel.Workbook.WorkSheets[1]
|
||||
#endregion
|
||||
it "Created 1 worksheet " {
|
||||
$Excel.Workbook.Worksheets.count | should be 1
|
||||
}
|
||||
|
||||
it 'zero' {
|
||||
$fakeData.Property_6_Number | Should -BeExactly '0'
|
||||
$Worksheet.Cells[2, 6].Text | Should -BeExactly $fakeData.Property_6_Number
|
||||
$Worksheet.Cells[2, 6].Value | Test-isNumeric | Should -Be $true
|
||||
}
|
||||
$ws = $Excel.Workbook.Worksheets[1]
|
||||
it "Created the worksheet with the expected name, number of rows and number of columns " {
|
||||
$ws.Name | should be "sheet1"
|
||||
$ws.Dimension.Columns | should be $propertyNames.Count
|
||||
$ws.Dimension.Rows | should be ($rowcount + 1)
|
||||
}
|
||||
|
||||
It 'regular number' {
|
||||
$fakeData.Property_7_Number | Should -BeExactly '5'
|
||||
$Worksheet.Cells[2, 7].Text | Should -BeExactly $fakeData.Property_7_Number
|
||||
$Worksheet.Cells[2, 7].Value | Test-isNumeric | Should -Be $true
|
||||
}
|
||||
|
||||
It 'number starting with zero' {
|
||||
$fakeData.Property_8_Number | Should -BeExactly '007'
|
||||
$Worksheet.Cells[2, 8].Text | Should -BeExactly '7'
|
||||
$Worksheet.Cells[2, 8].Value | Test-isNumeric | Should -Be $true
|
||||
}
|
||||
|
||||
It 'decimal number' {
|
||||
# US '33.00' BE '33,00'
|
||||
$fakeData.Property_9_Number | Should -BeExactly (33).ToString('F2')
|
||||
$Worksheet.Cells[2, 9].Text | Should -BeExactly '33'
|
||||
$Worksheet.Cells[2, 9].Value | Test-isNumeric | Should -Be $true
|
||||
|
||||
# US '1.67' BE '1,67'
|
||||
$fakeData.Property_10_Number | Should -BeExactly (5/3).ToString('F2')
|
||||
$Worksheet.Cells[2, 10].Text | Should -BeExactly $fakeData.Property_10_Number
|
||||
$Worksheet.Cells[2, 10].Value | Test-isNumeric | Should -Be $true
|
||||
}
|
||||
|
||||
It 'thousand seperator and decimal number' {
|
||||
# US '5,333,332.67' BE '5.333.332,67'
|
||||
# Excel BE '5333332,67'
|
||||
$fakeData.Property_11_Number | Should -BeExactly (15999998/3).ToString('N2')
|
||||
$Worksheet.Cells[2, 11].Text | Should -BeExactly $fakeData.Property_11_Number
|
||||
$Worksheet.Cells[2, 11].Value | Test-isNumeric | Should -Be $true
|
||||
}
|
||||
$headingNames = $ws.cells["1:1"].Value
|
||||
it "Created the worksheet with the correct header names " {
|
||||
foreach ($p in $propertyNames) {
|
||||
$headingnames -contains $p | should be $true
|
||||
}
|
||||
}
|
||||
|
||||
it "Formatted the process StartTime field as 'local short date' " {
|
||||
$STHeader = $ws.cells["1:1"].where({$_.Value -eq "StartTime"})[0]
|
||||
$STCell = $STHeader.Address -replace '1$','2'
|
||||
$ws.cells[$stcell].Style.Numberformat.NumFmtID | should be 22
|
||||
}
|
||||
|
||||
it "Formatted the process ID field as 'General' " {
|
||||
$IDHeader = $ws.cells["1:1"].where({$_.Value -eq "ID"})[0]
|
||||
$IDCell = $IDHeader.Address -replace '1$','2'
|
||||
$ws.cells[$IDcell].Style.Numberformat.NumFmtID | should be 0
|
||||
}
|
||||
}
|
||||
|
||||
Context " # NoAliasOrScriptPropeties -ExcludeProperty and -DisplayPropertySet work" {
|
||||
$path = "$env:TEMP\Test.xlsx"
|
||||
Remove-item -Path $path -ErrorAction SilentlyContinue
|
||||
$processes = Get-Process
|
||||
$propertyNames = $Processes[0].psobject.properties.where( {$_.MemberType -eq 'Property'}).name
|
||||
$rowcount = $Processes.Count
|
||||
#TestCreating a range with a name which needs illegal chars removing
|
||||
$warnVar = $null
|
||||
$Processes | Export-Excel $path -NoAliasOrScriptPropeties -RangeName "No Spaces" -WarningVariable warnvar -WarningAction SilentlyContinue
|
||||
|
||||
$Excel = Open-ExcelPackage -Path $path
|
||||
$ws = $Excel.Workbook.Worksheets[1]
|
||||
it "Created a new file with alias & Script Properties removed. " {
|
||||
$ws.Name | should be "sheet1"
|
||||
$ws.Dimension.Columns | should be $propertyNames.Count
|
||||
$ws.Dimension.Rows | should be ($rowcount + 1 ) # +1 for the header.
|
||||
}
|
||||
it "Created a Range - even though the name given was invalid. " {
|
||||
$ws.Names["No_spaces"] | should not beNullOrEmpty
|
||||
$ws.Names["No_spaces"].End.Column | should be $propertyNames.Count
|
||||
$ws.names["No_spaces"].End.Row | should be ($rowcount + 1 ) # +1 for the header.
|
||||
$warnVar.Count | should be 1
|
||||
}
|
||||
#This time use clearsheet instead of deleting the file
|
||||
$Processes | Export-Excel $path -NoAliasOrScriptPropeties -ExcludeProperty SafeHandle, modules, MainModule, StartTime, Threads -ClearSheet
|
||||
|
||||
$Excel = Open-ExcelPackage -Path $path
|
||||
$ws = $Excel.Workbook.Worksheets[1]
|
||||
it "Created a new file with a further 5 properties excluded and cleared the old sheet " {
|
||||
$ws.Name | should be "sheet1"
|
||||
$ws.Dimension.Columns | should be ($propertyNames.Count - 5)
|
||||
$ws.Dimension.Rows | should be ($rowcount + 1) # +1 for the header
|
||||
}
|
||||
|
||||
$propertyNames = $Processes[0].psStandardmembers.DefaultDisplayPropertySet.ReferencedPropertyNames
|
||||
Remove-item -Path $path -ErrorAction SilentlyContinue
|
||||
$Processes | Export-Excel $path -DisplayPropertySet
|
||||
|
||||
$Excel = Open-ExcelPackage -Path $path
|
||||
$ws = $Excel.Workbook.Worksheets[1]
|
||||
it "Created a new file with just the members of the Display Property Set " {
|
||||
$ws.Name | should be "sheet1"
|
||||
$ws.Dimension.Columns | should be $propertyNames.Count
|
||||
$ws.Dimension.Rows | should be ($rowcount + 1)
|
||||
}
|
||||
}
|
||||
|
||||
Context "#Example 2 # Exports a list of numbers and applies number format " {
|
||||
|
||||
$path = "$env:TEMP\Test.xlsx"
|
||||
Remove-item -Path $path -ErrorAction SilentlyContinue
|
||||
#testing -ReturnRange switch
|
||||
$returnedRange = Write-Output -1 668 34 777 860 -0.5 119 -0.1 234 788 | Export-Excel -NumberFormat '[Blue]$#,##0.00;[Red]-$#,##0.00' -Path $path -ReturnRange
|
||||
it "Created a new file and returned the expected range " {
|
||||
Test-Path -Path $path -ErrorAction SilentlyContinue | should be $true
|
||||
$returnedRange | should be "A1:A10"
|
||||
}
|
||||
|
||||
$Excel = Open-ExcelPackage -Path $path
|
||||
it "Created 1 worksheet " {
|
||||
$Excel.Workbook.Worksheets.count | should be 1
|
||||
}
|
||||
|
||||
$ws = $Excel.Workbook.Worksheets[1]
|
||||
it "Created the worksheet with the expected name, number of rows and number of columns " {
|
||||
$ws.Name | should be "sheet1"
|
||||
$ws.Dimension.Columns | should be 1
|
||||
$ws.Dimension.Rows | should be 10
|
||||
}
|
||||
|
||||
it "Set the default style for the sheet as expected " {
|
||||
$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 " {
|
||||
$ws.cells[1,1].Style.Numberformat.Format | should be '[Blue]$#,##0.00;[Red]-$#,##0.00'
|
||||
$ws.cells[1,1].Value | should be -1
|
||||
}
|
||||
}
|
||||
|
||||
Context "#Examples 3 & 4 # Setting cells for different data types Also added test for URI type" {
|
||||
|
||||
$path = "$env:TEMP\Test.xlsx"
|
||||
Remove-item -Path $path -ErrorAction SilentlyContinue
|
||||
[PSCustOmobject][Ordered]@{
|
||||
Date = Get-Date
|
||||
Formula1 = '=SUM(F2:G2)'
|
||||
String1 = 'My String'
|
||||
String2 = 'a'
|
||||
IPAddress = '10.10.25.5'
|
||||
Number1 = '07670'
|
||||
Number2 = '0,26'
|
||||
Number3 = '1.555,83'
|
||||
Number4 = '1.2'
|
||||
Number5 = '-31'
|
||||
PhoneNr1 = '+32 44'
|
||||
PhoneNr2 = '+32 4 4444 444'
|
||||
PhoneNr3 = '+3244444444'
|
||||
Link = [uri]"https://github.com/dfinke/ImportExcel"
|
||||
} | Export-Excel -NoNumberConversion IPAddress, Number1 -Path $path
|
||||
it "Created a new file " {
|
||||
Test-Path -Path $path -ErrorAction SilentlyContinue | should be $true
|
||||
}
|
||||
|
||||
$Excel = Open-ExcelPackage -Path $path
|
||||
it "Created 1 worksheet " {
|
||||
$Excel.Workbook.Worksheets.count | should be 1
|
||||
}
|
||||
|
||||
$ws = $Excel.Workbook.Worksheets[1]
|
||||
it "Created the worksheet with the expected name, number of rows and number of columns " {
|
||||
$ws.Name | should be "sheet1"
|
||||
$ws.Dimension.Columns | should be 14
|
||||
$ws.Dimension.Rows | should be 2
|
||||
}
|
||||
|
||||
it "Set a date in Cell A2 " {
|
||||
$ws.Cells[2,1].Value.Gettype().name | should be 'DateTime'
|
||||
}
|
||||
|
||||
it "Set a formula in Cell B2 " {
|
||||
$ws.Cells[2,2].Formula | should be '=SUM(F2:G2)'
|
||||
}
|
||||
|
||||
it "Set strings in Cells E2 and F2 " {
|
||||
$ws.Cells[2,5].Value.GetType().name | should be 'String'
|
||||
$ws.Cells[2,6].Value.GetType().name | should be 'String'
|
||||
}
|
||||
|
||||
it "Set a number in Cell I2 " {
|
||||
($ws.Cells[2,9].Value -is [valuetype] ) | should be $true
|
||||
}
|
||||
|
||||
it "Set a hyperlink in Cell N2 " {
|
||||
$ws.Cells[2,14].Hyperlink | should be "https://github.com/dfinke/ImportExcel"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Context "# # Setting cells for different data types with -noHeader" {
|
||||
|
||||
$path = "$env:TEMP\Test.xlsx"
|
||||
Remove-item -Path $path -ErrorAction SilentlyContinue
|
||||
[PSCustOmobject][Ordered]@{
|
||||
Date = Get-Date
|
||||
Formula1 = '=SUM(F1:G1)'
|
||||
String1 = 'My String'
|
||||
String2 = 'a'
|
||||
IPAddress = '10.10.25.5'
|
||||
Number1 = '07670'
|
||||
Number2 = '0,26'
|
||||
Number3 = '1.555,83'
|
||||
Number4 = '1.2'
|
||||
Number5 = '-31'
|
||||
PhoneNr1 = '+32 44'
|
||||
PhoneNr2 = '+32 4 4444 444'
|
||||
PhoneNr3 = '+3244444444'
|
||||
Link = [uri]"https://github.com/dfinke/ImportExcel"
|
||||
} | Export-Excel -NoNumberConversion IPAddress, Number1 -Path $path -NoHeader
|
||||
it "Created a new file " {
|
||||
Test-Path -Path $path -ErrorAction SilentlyContinue | should be $true
|
||||
}
|
||||
|
||||
$Excel = Open-ExcelPackage -Path $path
|
||||
it "Created 1 worksheet " {
|
||||
$Excel.Workbook.Worksheets.count | should be 1
|
||||
}
|
||||
|
||||
$ws = $Excel.Workbook.Worksheets[1]
|
||||
it "Created the worksheet with the expected name, number of rows and number of columns " {
|
||||
$ws.Name | should be "sheet1"
|
||||
$ws.Dimension.Columns | should be 14
|
||||
$ws.Dimension.Rows | should be 1
|
||||
}
|
||||
|
||||
it "Set a date in Cell A1 " {
|
||||
$ws.Cells[1,1].Value.Gettype().name | should be 'DateTime'
|
||||
}
|
||||
|
||||
it "Set a formula in Cell B1 " {
|
||||
$ws.Cells[1,2].Formula | should be '=SUM(F1:G1)'
|
||||
}
|
||||
|
||||
it "Set strings in Cells E1 and F1 " {
|
||||
$ws.Cells[1,5].Value.GetType().name | should be 'String'
|
||||
$ws.Cells[1,6].Value.GetType().name | should be 'String'
|
||||
}
|
||||
|
||||
it "Set a number in Cell I1 " {
|
||||
($ws.Cells[1,9].Value -is [valuetype] ) | should be $true
|
||||
}
|
||||
|
||||
it "Set a hyperlink in Cell N1 " {
|
||||
$ws.Cells[1,14].Hyperlink | should be "https://github.com/dfinke/ImportExcel"
|
||||
}
|
||||
}
|
||||
|
||||
Context "#Example 5 # Adding a single conditional format " {
|
||||
### TODO New-ConditionalText doesn't a lot of options in Add-ConditionalFormat.
|
||||
# It would be good to pull the logic out of Export-Excel and have EE call Add-ConditionalFormat.
|
||||
$ct = New-ConditionalText -ConditionalType GreaterThan 525 -ConditionalTextColor DarkRed -BackgroundColor LightPink
|
||||
it "Created a Conditional format description " {
|
||||
$ct.BackgroundColor -is [System.Drawing.Color] | should be $true
|
||||
$ct.ConditionalTextColor -is [System.Drawing.Color] | should be $true
|
||||
$ct.ConditionalType -in [enum]::GetNames( [OfficeOpenXml.ConditionalFormatting.eExcelConditionalFormattingRuleType] ) |
|
||||
should be $true
|
||||
}
|
||||
|
||||
$path = "$env:TEMP\Test.xlsx"
|
||||
Remove-item -Path $path -ErrorAction SilentlyContinue
|
||||
Write-Output 489 668 299 777 860 151 119 497 234 788 | Export-Excel -Path $path -ConditionalText $ct
|
||||
|
||||
it "Created a new file " {
|
||||
Test-Path -Path $path -ErrorAction SilentlyContinue | should be $true
|
||||
}
|
||||
|
||||
#ToDo need to test applying conitional formatting to a pre-existing worksheet
|
||||
$Excel = Open-ExcelPackage -Path $path
|
||||
$ws = $Excel.Workbook.Worksheets[1]
|
||||
|
||||
it "Added one block of conditional formating for the data range " {
|
||||
$ws.ConditionalFormatting.Count | should be 1
|
||||
$ws.ConditionalFormatting[0].Address | should be ($ws.Dimension.Address)
|
||||
}
|
||||
|
||||
$cf = $ws.ConditionalFormatting[0]
|
||||
it "Set the conditional formatting properties correctly " {
|
||||
$cf.Formula | should be $ct.Text
|
||||
$cf.Type.ToString() | should be $ct.ConditionalType
|
||||
#$cf.Style.Fill.BackgroundColor | should be $ct.BackgroundColor
|
||||
# $cf.Style.Font.Color | should be $ct.ConditionalTextColor - have to compare r.g.b
|
||||
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
Context "#Example 6 # Adding multiple conditional formats using short form syntax. " {
|
||||
#this is a test of adding more than one conditional block and using the minimal syntax for new-ConditionalText =
|
||||
$path = "$env:TEMP\Test.xlsx"
|
||||
Remove-item -Path $path -ErrorAction SilentlyContinue
|
||||
|
||||
#Testing -Passthrough
|
||||
$Excel = Get-Service | Select-Object Name, Status, DisplayName, ServiceName |
|
||||
Export-Excel $path -PassThru -ConditionalText $(
|
||||
New-ConditionalText Stop DarkRed LightPink
|
||||
New-ConditionalText Running Blue Cyan
|
||||
)
|
||||
$ws = $Excel.Workbook.Worksheets[1]
|
||||
it "Added two blocks of conditional formating for the data range " {
|
||||
$ws.ConditionalFormatting.Count | should be 2
|
||||
$ws.ConditionalFormatting[0].Address | should be ($ws.Dimension.Address)
|
||||
$ws.ConditionalFormatting[1].Address | should be ($ws.Dimension.Address)
|
||||
}
|
||||
it "Set the conditional formatting properties correctly " {
|
||||
$ws.ConditionalFormatting[0].Text | should be "Stop"
|
||||
$ws.ConditionalFormatting[1].Text | should be "Running"
|
||||
$ws.ConditionalFormatting[0].Type | should be "ContainsText"
|
||||
$ws.ConditionalFormatting[1].Type | should be "ContainsText"
|
||||
#Add RGB Comparison
|
||||
}
|
||||
Close-ExcelPackage -ExcelPackage $Excel
|
||||
}
|
||||
|
||||
context "#Example 7 # Update-FirstObjectProperties works "{
|
||||
$Array = @()
|
||||
|
||||
$Obj1 = [PSCustomObject]@{
|
||||
Member1 = 'First'
|
||||
Member2 = 'Second'
|
||||
}
|
||||
|
||||
$Obj2 = [PSCustomObject]@{
|
||||
Member1 = 'First'
|
||||
Member2 = 'Second'
|
||||
Member3 = 'Third'
|
||||
}
|
||||
|
||||
$Obj3 = [PSCustomObject]@{
|
||||
Member1 = 'First'
|
||||
Member2 = 'Second'
|
||||
Member3 = 'Third'
|
||||
Member4 = 'Fourth'
|
||||
}
|
||||
|
||||
$Array = $Obj1, $Obj2, $Obj3
|
||||
$newarray = $Array | Update-FirstObjectProperties
|
||||
it "Outputs as many objects as it input " {
|
||||
$newarray.Count | should be $Array.Count
|
||||
}
|
||||
it "Added properties to item 0 " {
|
||||
$newarray[0].psobject.Properties.name.Count | should be 4
|
||||
$newarray[0].Member1 | should be 'First'
|
||||
$newarray[0].Member2 | should be 'Second'
|
||||
$newarray[0].Member3 | should beNullOrEmpty
|
||||
$newarray[0].Member4 | should beNullOrEmpty
|
||||
}
|
||||
}
|
||||
|
||||
Context "#Examples 8 & 9 # Adding Pivot tables and charts from parameters" {
|
||||
$path = "$env:TEMP\Test.xlsx"
|
||||
#This time we are not deleting the XLSX file so this should create a new, named, sheet.
|
||||
$Excel = Get-Process | Select-Object -first 50 -Property Name,cpu,pm,handles,company | Export-Excel $path -WorkSheetname Processes -PassThru
|
||||
#Testing -passthru and adding the Pivot as a second step. Want to save and re-open it ...
|
||||
Export-Excel -ExcelPackage $Excel -WorkSheetname Processes -IncludePivotTable -PivotRows Company -PivotData PM
|
||||
|
||||
$Excel = Open-ExcelPackage $path
|
||||
$PTws = $Excel.Workbook.Worksheets["ProcessesPivotTable"]
|
||||
$wCount = $Excel.Workbook.Worksheets.Count
|
||||
it "Added the named sheet and pivot table to the workbook " {
|
||||
$PTws | should not beNullOrEmpty
|
||||
$PTws.PivotTables.Count | should be 1
|
||||
$Excel.Workbook.Worksheets["Processes"] | should not beNullOrEmpty
|
||||
$Excel.Workbook.Worksheets.Count | should beGreaterThan 2
|
||||
$excel.Workbook.Worksheets["Processes"].Dimension.rows | should be 51 #50 data + 1 header
|
||||
}
|
||||
$pt = $PTws.PivotTables[0]
|
||||
it "Built the expected Pivot table " {
|
||||
$pt.RowFields.Count | should be 1
|
||||
$pt.RowFields[0].Name | should be "Company"
|
||||
$pt.DataFields.Count | should be 1
|
||||
$pt.DataFields[0].Function | should be "Count"
|
||||
$pt.DataFields[0].Field.Name | should be "PM"
|
||||
$PTws.Drawings.Count | should be 0
|
||||
}
|
||||
#using the already open sheet add the pivot chart
|
||||
$warnvar = $null
|
||||
Export-Excel -ExcelPackage $Excel -WorkSheetname Processes -IncludePivotTable -PivotRows Company -PivotData PM -IncludePivotChart -ChartType PieExploded3D -WarningAction SilentlyContinue -WarningVariable warnvar
|
||||
$Excel = Open-ExcelPackage $path
|
||||
it "Added a chart to the pivot table without rebuilding " {
|
||||
$ws = $Excel.Workbook.Worksheets["ProcessesPivotTable"]
|
||||
$Excel.Workbook.Worksheets.Count | should be $wCount
|
||||
$ws.Drawings.count | should be 1
|
||||
$ws.Drawings[0].ChartType.ToString() | should be "PieExploded3D"
|
||||
}
|
||||
it "Generated a message on re-processing the Pivot table " {
|
||||
$warnVar | Should not beNullOrEmpty
|
||||
}
|
||||
$warnVar = $null
|
||||
Get-Process | Select-Object -Last 50 -Property Name,cpu,pm,handles,company | Export-Excel $path -WorkSheetname Processes -Append -IncludePivotTable -PivotRows Company -PivotData PM -IncludePivotChart -ChartType PieExploded3D -WarningAction SilentlyContinue -WarningVariable warnvar
|
||||
$Excel = Open-ExcelPackage $path
|
||||
$pt = $Excel.Workbook.Worksheets["ProcessesPivotTable"].PivotTables[0]
|
||||
it "Appended to the Worksheet and Extended the Pivot table " {
|
||||
$Excel.Workbook.Worksheets.Count | should be $wCount
|
||||
$excel.Workbook.Worksheets["Processes"].Dimension.rows | should be 101 #appended 50 rows to the previous total
|
||||
$pt.CacheDefinition.CacheDefinitionXml.pivotCacheDefinition.cacheSource.worksheetSource.ref |
|
||||
should be "A1:E101"
|
||||
}
|
||||
it "Generated a message on extending the Pivot table " {
|
||||
$warnVar | Should not beNullOrEmpty
|
||||
}
|
||||
}
|
||||
|
||||
Context " # Add-Worksheet inserted sheets, moved them correctly, and copied a sheet" {
|
||||
$path = "$env:TEMP\Test.xlsx"
|
||||
|
||||
$Excel = Open-ExcelPackage $path
|
||||
#At this point Sheets should be in the order Sheet1, Processes, ProcessesPivotTable
|
||||
$null = Add-WorkSheet -ExcelPackage $Excel -WorkSheetname "Processes" -MoveToEnd # order now 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 "*" # 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 "OneLast" -MoveBefore "ProcessesPivotTable" # Now its Another, NewSheet, Onelast, ProcessesPivotTable, Processes, Sheet1
|
||||
Close-ExcelPackage $Excel
|
||||
|
||||
$Excel = Open-ExcelPackage $path
|
||||
|
||||
it "Got the Sheets in the right order " {
|
||||
$excel.Workbook.Worksheets[1].Name | should be "Another"
|
||||
$excel.Workbook.Worksheets[2].Name | should be "NewSheet"
|
||||
$excel.Workbook.Worksheets[3].Name | should be "Onelast"
|
||||
$excel.Workbook.Worksheets[4].Name | should be "ProcessesPivotTable"
|
||||
$excel.Workbook.Worksheets[5].Name | should be "Processes"
|
||||
$excel.Workbook.Worksheets[6].Name | should be "Sheet1"
|
||||
}
|
||||
|
||||
it "Cloned 'Sheet1' to 'NewSheet' "{
|
||||
$newWs = $excel.Workbook.Worksheets["NewSheet"]
|
||||
$newWs.Dimension.Address | should be ($excel.Workbook.Worksheets["Sheet1"].Dimension.Address)
|
||||
$newWs.ConditionalFormatting.Count | should be ($excel.Workbook.Worksheets["Sheet1"].ConditionalFormatting.Count)
|
||||
$newWs.ConditionalFormatting[0].Address.Address | should be ($excel.Workbook.Worksheets["Sheet1"].ConditionalFormatting[0].Address.Address)
|
||||
$newWs.ConditionalFormatting[0].Formula | should be ($excel.Workbook.Worksheets["Sheet1"].ConditionalFormatting[0].Formula)
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
Context " # Create and append with Start row and Start Column, inc ranges and Pivot table" {
|
||||
$path = "$env:TEMP\Test.xlsx"
|
||||
#Catch warning
|
||||
$warnVar = $null
|
||||
#Test Append with no existing sheet.
|
||||
get-process | Select-Object -first 10 -Property Name,cpu,pm,handles,company | export-excel -StartRow 3 -StartColumn 3 -AutoFilter -AutoNameRange -BoldTopRow -IncludePivotTable -PivotRows Company -PivotData PM -Path $path -WorkSheetname withOffset -append
|
||||
get-process | Select-Object -last 10 -Property Name,cpu,pm,handles,company | export-excel -StartRow 3 -StartColumn 3 -AutoFilter -AutoNameRange -BoldTopRow -IncludePivotTable -PivotRows Company -PivotData PM -Path $path -WorkSheetname withOffset -append -WarningAction SilentlyContinue -WarningVariable warnvar
|
||||
$Excel = Open-ExcelPackage $path
|
||||
$dataWs = $Excel.Workbook.Worksheets["withOffset"]
|
||||
$pt = $Excel.Workbook.Worksheets["withOffsetPivotTable"].PivotTables[0]
|
||||
it "Created and appended to a sheet offset from the top left corner " {
|
||||
$dataWs.Cells[1,1].Value | Should beNullOrEmpty
|
||||
$dataWs.Cells[2,2].Value | Should beNullOrEmpty
|
||||
$dataWs.Cells[3,3].Value | Should not beNullOrEmpty
|
||||
$dataWs.Cells[3,3].Style.Font.Bold | Should be $true
|
||||
$dataWs.Dimension.End.Row | Should be 23
|
||||
$dataWs.names[0].end.row | Should be 23
|
||||
$dataWs.names[0].name | Should be 'Name'
|
||||
$dataWs.names.Count | Should be 6
|
||||
$dataWs.cells[$dataws.Dimension].AutoFilter | Should be true
|
||||
$pt.CacheDefinition.CacheDefinitionXml.pivotCacheDefinition.cacheSource.worksheetSource.ref |
|
||||
Should be "C3:G23"
|
||||
}
|
||||
it "Generated a message on extending the Pivot table " {
|
||||
$warnVar | Should not beNullOrEmpty
|
||||
}
|
||||
}
|
||||
|
||||
Context "#Example 11 # Create and append with title, inc ranges and Pivot table" {
|
||||
$path = "$env:TEMP\Test.xlsx"
|
||||
#Catch warning
|
||||
$ptDef = [ordered]@{}
|
||||
$ptDef += New-PivotTableDefinition -PivotTableName "PT1" -SourceWorkSheet 'Sheet1' -PivotRows "Status" -PivotData @{'Status' = 'Count'} -PivotFilter "StartType" -IncludePivotChart -ChartType BarClustered3D -ChartTitle "Services by status" -ChartHeight 512 -ChartWidth 768 -ChartRow 10 -ChartColumn 0 -NoLegend
|
||||
$ptDef += New-PivotTableDefinition -PivotTableName "PT2" -SourceWorkSheet 'Sheet2' -PivotRows "Company" -PivotData @{'Company' = 'Count'} -IncludePivotChart -ChartType PieExploded3D -ShowPercent -WarningAction SilentlyContinue
|
||||
|
||||
it "Built a pivot definition using New-PivotTableDefinition " {
|
||||
$ptDef.PT1.SourceWorkSheet | Should be 'Sheet1'
|
||||
$ptDef.PT1.PivotRows | Should be 'Status'
|
||||
$ptDef.PT1.PivotData.Status | Should be 'Count'
|
||||
$ptDef.PT1.PivotFilter | Should be 'StartType'
|
||||
$ptDef.PT1.IncludePivotChart | Should be $true
|
||||
$ptDef.PT1.ChartType.tostring() | Should be 'BarClustered3D'
|
||||
}
|
||||
Remove-Item -Path $path
|
||||
$warnvar = $null
|
||||
Get-Service | Select-Object -Property Status, Name, DisplayName, StartType | Export-Excel -Path $path -AutoSize -TableName "All Services" -TableStyle Medium1 -WarningAction SilentlyContinue -WarningVariable warnvar
|
||||
Get-Process | Select-Object -Property Name, Company, Handles, CPU, VM | Export-Excel -Path $path -AutoSize -WorkSheetname 'sheet2' -TableName "Processes" -TableStyle Light1 -Title "Processes" -TitleFillPattern Solid -TitleBackgroundColor AliceBlue -TitleBold -TitleSize 22 -PivotTableDefinition $ptDef
|
||||
$Excel = Open-ExcelPackage $path
|
||||
$ws1 = $Excel.Workbook.Worksheets["Sheet1"]
|
||||
$ws2 = $Excel.Workbook.Worksheets["Sheet2"]
|
||||
|
||||
|
||||
it "Set Column widths (with autosize) " {
|
||||
$ws1.Column(2).Width | Should not be $ws1.DefaultColWidth
|
||||
$ws2.Column(1).width | Should not be $ws2.DefaultColWidth
|
||||
}
|
||||
|
||||
it "Added tables to both sheets (handling illegal chars) and a title in sheet 2 " {
|
||||
$warnvar.count | Should be 1
|
||||
$ws1.tables.Count | Should be 1
|
||||
$ws2.tables.Count | Should be 1
|
||||
$ws1.Tables[0].Address.Start.Row | Should be 1
|
||||
$ws2.Tables[0].Address.Start.Row | Should be 2 #Title in row 1
|
||||
$ws1.Tables[0].Address.End.Address | Should be $ws1.Dimension.End.Address
|
||||
$ws2.Tables[0].Address.End.Address | Should be $ws2.Dimension.End.Address
|
||||
$ws2.Tables[0].Name | Should be "Processes"
|
||||
$ws2.Tables[0].StyleName | Should be "TableStyleLight1"
|
||||
$ws2.Cells["A1"].Value | Should be "Processes"
|
||||
$ws2.Cells["A1"].Style.Font.Bold | Should be $true
|
||||
$ws2.Cells["A1"].Style.Font.Size | Should be 22
|
||||
$ws2.Cells["A1"].Style.Fill.PatternType.tostring() | Should be "solid"
|
||||
$ws2.Cells["A1"].Style.Fill.BackgroundColor.Rgb | Should be "fff0f8ff"
|
||||
}
|
||||
|
||||
$ptsheet1 = $Excel.Workbook.Worksheets["Pt1"]
|
||||
$ptsheet2 = $Excel.Workbook.Worksheets["Pt2"]
|
||||
$PT1 = $ptsheet1.PivotTables[0]
|
||||
$PT2 = $ptsheet2.PivotTables[0]
|
||||
$PC1 = $ptsheet1.Drawings[0]
|
||||
$PC2 = $ptsheet2.Drawings[0]
|
||||
it "Created the correct pivot tables and charts from the definitions. " {
|
||||
|
||||
$PT1.CacheDefinition.CacheDefinitionXml.pivotCacheDefinition.cacheSource.worksheetSource.ref |
|
||||
Should be ("A1:" + $ws1.Dimension.End.Address)
|
||||
$PT2.CacheDefinition.CacheDefinitionXml.pivotCacheDefinition.cacheSource.worksheetSource.ref |
|
||||
Should be ("A2:" + $ws2.Dimension.End.Address) #Title in row 1
|
||||
|
||||
$pt1.PageFields[0].Name | Should be 'StartType'
|
||||
$pt1.RowFields[0].Name | Should be 'Status'
|
||||
$pt1.DataFields[0].Field.name | Should be 'Status'
|
||||
$pt1.DataFields[0].Function | Should be 'Count'
|
||||
$pc1.ChartType | Should be 'BarClustered3D'
|
||||
$pc1.From.Column | Should be 0 #chart 1 at 0,10 chart 2 at 4,0 (default)
|
||||
$pc2.From.Column | Should be 4
|
||||
$pc1.From.Row | Should be 10
|
||||
$pc2.From.Row | Should be 0
|
||||
$pc1.Legend.Font | should beNullOrEmpty #Best check for legend removed.
|
||||
$pc2.Legend.Font | should not beNullOrEmpty
|
||||
$pc1.Title.Text | Should be 'Services by status'
|
||||
$pc2.DataLabel.ShowPercent | should be $true
|
||||
}
|
||||
}
|
||||
|
||||
Context "#Example 13 # Formatting and another way to do a pivot. " {
|
||||
$path = "$env:TEMP\Test.xlsx"
|
||||
Remove-Item $path
|
||||
$excel = Get-Process | Select-Object -Property Name,Company,Handles,CPU,PM,NPM,WS | Export-Excel -Path $path -ClearSheet -WorkSheetname "Processes" -FreezeTopRowFirstColumn -PassThru
|
||||
$sheet = $excel.Workbook.Worksheets["Processes"]
|
||||
$sheet.Column(1) | Set-Format -Bold -AutoFit
|
||||
$sheet.Column(2) | Set-Format -Width 29 -WrapText
|
||||
$sheet.Column(3) | Set-Format -HorizontalAlignment Right -NFormat "#,###"
|
||||
Set-Format -Address $sheet.Cells["E1:H1048576"] -HorizontalAlignment Right -NFormat "#,###"
|
||||
Set-Format -Address $sheet.Column(4) -HorizontalAlignment Right -NFormat "#,##0.0" -Bold
|
||||
Set-Format -Address $sheet.Row(1) -Bold -HorizontalAlignment Center
|
||||
Add-ConditionalFormatting -WorkSheet $sheet -Range "D2:D1048576" -DataBarColor Red
|
||||
Add-ConditionalFormatting -WorkSheet $sheet -Range "G2:G1048576" -RuleType GreaterThan -ConditionValue "104857600" -ForeGroundColor Red
|
||||
foreach ($c in 5..9) {Set-Format $sheet.Column($c) -AutoFit }
|
||||
Add-PivotTable -PivotTableName "PT_Procs" -ExcelPackage $excel -SourceWorkSheet "Processes" -PivotRows Company -PivotData @{'Name'='Count'} -IncludePivotChart -ChartType ColumnClustered -NoLegend
|
||||
Close-ExcelPackage $excel
|
||||
|
||||
$excel = Open-ExcelPackage $path
|
||||
$sheet = $excel.Workbook.Worksheets["Processes"]
|
||||
|
||||
it "Applied the formating" {
|
||||
$sheet | should not beNullOrEmpty
|
||||
$sheet.Column(1).wdith | should not be $sheet.DefaultColWidth
|
||||
$sheet.Column(7).wdith | should not be $sheet.DefaultColWidth
|
||||
$sheet.Column(1).style.font.bold | should be $true
|
||||
$sheet.Column(2).style.wraptext | should be $true
|
||||
$sheet.Column(2).width | should be 29
|
||||
$sheet.Column(3).style.horizontalalignment | should be 'right'
|
||||
$sheet.Column(4).style.horizontalalignment | should be 'right'
|
||||
$sheet.Cells["A1"].Style.HorizontalAlignment | should be 'Center'
|
||||
$sheet.Cells['E2'].Style.HorizontalAlignment | should be 'right'
|
||||
$sheet.Cells['A1'].Style.Font.Bold | should be $true
|
||||
$sheet.Cells['D2'].Style.Font.Bold | should be $true
|
||||
$sheet.Cells['E2'].style.numberformat.format | should be '#,###'
|
||||
$sheet.Column(3).style.numberformat.format | should be '#,###'
|
||||
$sheet.Column(4).style.numberformat.format | should be '#,##0.0'
|
||||
$sheet.ConditionalFormatting.Count | should be 2
|
||||
$sheet.ConditionalFormatting[0].type | should be 'Databar'
|
||||
$sheet.ConditionalFormatting[0].Color.name | should be 'ffff0000'
|
||||
$sheet.ConditionalFormatting[0].Address.Address | should be 'D2:D1048576'
|
||||
$sheet.ConditionalFormatting[1].type | should be 'GreaterThan'
|
||||
$sheet.ConditionalFormatting[1].Formula | should be '104857600'
|
||||
$sheet.ConditionalFormatting[1].Style.Font.Color.Color.Name | should be 'ffff0000'
|
||||
}
|
||||
it "Froze the panes" {
|
||||
$sheet.view.Panes.Count | should be 3
|
||||
}
|
||||
$ptsheet1 = $Excel.Workbook.Worksheets["Pt_procs"]
|
||||
|
||||
it "Created the pivot table" {
|
||||
$ptsheet1 | should not beNullOrEmpty
|
||||
$ptsheet1.PivotTables[0].DataFields[0].Field.Name | should be "Name"
|
||||
$ptsheet1.PivotTables[0].DataFields[0].Function | should be "Count"
|
||||
$ptsheet1.PivotTables[0].RowFields[0].Name | should be "Company"
|
||||
$ptsheet1.PivotTables[0].CacheDefinition.CacheDefinitionXml.pivotCacheDefinition.cacheSource.worksheetSource.ref |
|
||||
Should be $sheet.Dimension.address
|
||||
}
|
||||
}
|
||||
|
||||
## To do
|
||||
## More pivot options & other FreezePanes settings ?
|
||||
## Charts
|
||||
## Style script block
|
||||
## Rezip ?
|
||||
|
||||
}
|
||||
848
Export-Excel.ps1
848
Export-Excel.ps1
File diff suppressed because it is too large
Load Diff
@@ -422,84 +422,6 @@ function Import-Excel {
|
||||
}
|
||||
}
|
||||
|
||||
function Add-WorkSheet {
|
||||
[cmdletBinding()]
|
||||
[OutputType([OfficeOpenXml.ExcelWorksheet])]
|
||||
param(
|
||||
#An object representing an Excel Package.
|
||||
[Parameter(Mandatory=$true, ValueFromPipeline=$true, ParameterSetName = "Package", Position=0)]
|
||||
[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.
|
||||
[Parameter(Mandatory=$true, ParameterSetName = "WorkBook")]
|
||||
[OfficeOpenXml.ExcelWorkbook]$ExcelWorkbook,
|
||||
#The name of the worksheet 'Sheet1' by default.
|
||||
[string]$WorkSheetname = 'Sheet1',
|
||||
#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,
|
||||
#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.
|
||||
[Switch]$MoveToStart,
|
||||
#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.)
|
||||
[Switch]$MoveToEnd,
|
||||
#If specified, the worksheet will be moved before the nominated one (which can be a postion starting from 1, or a name).
|
||||
#MoveBefore takes precedence over MoveAfter if both are specified.
|
||||
$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 * 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 ,
|
||||
#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,
|
||||
#Ignored but retained for backwards compatibility.
|
||||
[Switch] $NoClobber
|
||||
)
|
||||
|
||||
if ($ExcelPackage -and -not $ExcelWorkbook) {$ExcelWorkbook = $ExcelPackage.Workbook}
|
||||
|
||||
$ws = $ExcelWorkbook.Worksheets[$WorkSheetname]
|
||||
if( $ws -and $ClearSheet) { $ExcelWorkbook.Worksheets.Delete($WorkSheetname) ; $ws = $null }
|
||||
if(!$ws -and $CopySource) {
|
||||
Write-Verbose -Message "Copying into worksheet '$WorkSheetname'."
|
||||
$ws=$ExcelWorkbook.Worksheets.Add($WorkSheetname, $CopySource)
|
||||
}
|
||||
elseif(!$ws) {
|
||||
Write-Verbose -Message "Adding worksheet '$WorkSheetname'."
|
||||
$ws=$ExcelWorkbook.Worksheets.Add($WorkSheetname)
|
||||
}
|
||||
else {Write-Verbose -Message "Worksheet '$WorkSheetname' already existed."}
|
||||
if ($MoveToStart) {$ExcelWorkbook.Worksheets.MoveToStart($worksheetName) }
|
||||
elseif ($MoveToEnd ) {$ExcelWorkbook.Worksheets.MoveToEnd($worksheetName) }
|
||||
elseif ($MoveBefore ) {
|
||||
if ($ExcelWorkbook.Worksheets[$MoveBefore]) {
|
||||
if ($MoveBefore -is [int]) {
|
||||
$ExcelWorkbook.Worksheets.MoveBefore($ws.Index, $MoveBefore)
|
||||
}
|
||||
else {$ExcelWorkbook.Worksheets.MoveBefore($worksheetname, $MoveBefore)}
|
||||
}
|
||||
else {Write-Warning "Can't find worksheet '$MoveBefore'; worsheet '$WorkSheetname' will not be moved."}
|
||||
}
|
||||
elseif ($MoveAfter ) {
|
||||
if ($MoveAfter = "*") {
|
||||
if ($WorkSheetname -lt $ExcelWorkbook.Worksheets[1].Name) {$ExcelWorkbook.Worksheets.MoveToStart($worksheetName)}
|
||||
else {
|
||||
$i = 1
|
||||
While ($i -lt $ExcelWorkbook.Worksheets.Count -and $ExcelWorkbook.Worksheets[$i + 1].Name -lt $worksheetname ) { $i++}
|
||||
$ExcelWorkbook.Worksheets.MoveAfter($ws.Index, $i)
|
||||
}
|
||||
}
|
||||
elseif ($ExcelWorkbook.Worksheets[$MoveAfter]) {
|
||||
if ($MoveAfter -is [int]) {
|
||||
$ExcelWorkbook.Worksheets.MoveAfter($ws.Index, $MoveAfter)
|
||||
}
|
||||
else {
|
||||
$ExcelWorkbook.Worksheets.MoveAfter($worksheetname, $MoveAfter)
|
||||
}
|
||||
}
|
||||
else {Write-Warning "Can't find worksheet '$MoveAfter'; worsheet '$WorkSheetname' will not be moved."}
|
||||
}
|
||||
return $ws
|
||||
}
|
||||
|
||||
function ConvertFrom-ExcelSheet {
|
||||
<#
|
||||
.Synopsis
|
||||
|
||||
94
Old_Export-Excel.Tests.ps1
Normal file
94
Old_Export-Excel.Tests.ps1
Normal file
@@ -0,0 +1,94 @@
|
||||
#Requires -Modules Pester
|
||||
|
||||
|
||||
$here = Split-Path -Parent $MyInvocation.MyCommand.Path
|
||||
|
||||
|
||||
Import-Module $here -Force
|
||||
|
||||
$WarningPreference = 'SilentlyContinue'
|
||||
$ProgressPreference = 'SilentlyContinue'
|
||||
|
||||
Function Test-isNumeric {
|
||||
Param (
|
||||
[Parameter(ValueFromPipeline)]$x
|
||||
)
|
||||
|
||||
Return $x -is [byte] -or $x -is [int16] -or $x -is [int32] -or $x -is [int64] `
|
||||
-or $x -is [sbyte] -or $x -is [uint16] -or $x -is [uint32] -or $x -is [uint64] `
|
||||
-or $x -is [float] -or $x -is [double] -or $x -is [decimal]
|
||||
}
|
||||
|
||||
$fakeData = [PSCustOmobject]@{
|
||||
Property_1_Date = (Get-Date).ToString('d') # US '10/16/2017' BE '16/10/2107'
|
||||
Property_2_Formula = '=SUM(G2:H2)'
|
||||
Property_3_String = 'My String'
|
||||
Property_4_String = 'a'
|
||||
Property_5_IPAddress = '10.10.25.5'
|
||||
Property_6_Number = '0'
|
||||
Property_7_Number = '5'
|
||||
Property_8_Number = '007'
|
||||
Property_9_Number = (33).ToString('F2') # US '33.00' BE '33,00'
|
||||
Property_10_Number = (5/3).ToString('F2') # US '1.67' BE '1,67'
|
||||
Property_11_Number = (15999998/3).ToString('N2') # US '5,333,332.67' BE '5.333.332,67'
|
||||
Property_12_Number = '1.555,83'
|
||||
Property_13_PhoneNr = '+32 44'
|
||||
Property_14_PhoneNr = '+32 4 4444 444'
|
||||
Property_15_PhoneNr = '+3244444444'
|
||||
}
|
||||
|
||||
$Path = 'Test.xlsx'
|
||||
|
||||
Describe 'Export-Excel' {
|
||||
in $TestDrive {
|
||||
Describe 'Number conversion' {
|
||||
Context 'numerical values expected' {
|
||||
#region Create test file
|
||||
$fakeData | Export-Excel -Path $Path
|
||||
|
||||
$Path = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
|
||||
$Excel = New-Object OfficeOpenXml.ExcelPackage $Path
|
||||
$Worksheet = $Excel.Workbook.WorkSheets[1]
|
||||
#endregion
|
||||
|
||||
it 'zero' {
|
||||
$fakeData.Property_6_Number | Should -BeExactly '0'
|
||||
$Worksheet.Cells[2, 6].Text | Should -BeExactly $fakeData.Property_6_Number
|
||||
$Worksheet.Cells[2, 6].Value | Test-isNumeric | Should -Be $true
|
||||
}
|
||||
|
||||
It 'regular number' {
|
||||
$fakeData.Property_7_Number | Should -BeExactly '5'
|
||||
$Worksheet.Cells[2, 7].Text | Should -BeExactly $fakeData.Property_7_Number
|
||||
$Worksheet.Cells[2, 7].Value | Test-isNumeric | Should -Be $true
|
||||
}
|
||||
|
||||
It 'number starting with zero' {
|
||||
$fakeData.Property_8_Number | Should -BeExactly '007'
|
||||
$Worksheet.Cells[2, 8].Text | Should -BeExactly '7'
|
||||
$Worksheet.Cells[2, 8].Value | Test-isNumeric | Should -Be $true
|
||||
}
|
||||
|
||||
It 'decimal number' {
|
||||
# US '33.00' BE '33,00'
|
||||
$fakeData.Property_9_Number | Should -BeExactly (33).ToString('F2')
|
||||
$Worksheet.Cells[2, 9].Text | Should -BeExactly '33'
|
||||
$Worksheet.Cells[2, 9].Value | Test-isNumeric | Should -Be $true
|
||||
|
||||
# US '1.67' BE '1,67'
|
||||
$fakeData.Property_10_Number | Should -BeExactly (5/3).ToString('F2')
|
||||
$Worksheet.Cells[2, 10].Text | Should -BeExactly $fakeData.Property_10_Number
|
||||
$Worksheet.Cells[2, 10].Value | Test-isNumeric | Should -Be $true
|
||||
}
|
||||
|
||||
It 'thousand seperator and decimal number' {
|
||||
# US '5,333,332.67' BE '5.333.332,67'
|
||||
# Excel BE '5333332,67'
|
||||
$fakeData.Property_11_Number | Should -BeExactly (15999998/3).ToString('N2')
|
||||
$Worksheet.Cells[2, 11].Text | Should -BeExactly $fakeData.Property_11_Number
|
||||
$Worksheet.Cells[2, 11].Value | Test-isNumeric | Should -Be $true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
37
README.md
37
README.md
@@ -33,6 +33,43 @@ iex (new-object System.Net.WebClient).DownloadString('https://raw.github.com/dfi
|
||||
|
||||
# What's new
|
||||
|
||||
- New commands - Diff , Merge and Join
|
||||
- `Compare-Worksheet` (introduced in 5.0) uses the built in `Compare-object` command, to output a command-line DIFF and/or colour the worksheet to show differences. For example, if my sheets are Windows services the *extra* rows or rows where the startup status has changed get highlighted
|
||||
- `Merge-Worksheet` (also introduced in 5.0) joins two lumps, side by highlighting the differences. So now I can have server A's services and Server Bs Services on the same page. I figured out a way to do multiple sheets. So I can have Server A,B,C,D on one page :-) that is `Merge-MultpleSheets`
|
||||
For this release I've fixed heaven only knows how many typos and proof reading errors in the help for these two, but the code is unchanged - although correcting the spelling of Merge-MultipleSheets is potentially a breaking change (and it is still plural!)
|
||||
- `Join-Worksheet` is **new** for ths release. At it's simplest it copies all the data in Worksheet A to the end of Worksheet B
|
||||
- Add-Worksheet
|
||||
- I have moved this from ImportExcel.psm1 to ExportExcel.ps1 and it now can move a new worksheet to the right place, and can copy an existing worksheet (from the same or a different workbook) to a new one, and I set the Set return-type to aid intellisense
|
||||
- New-PivotTableDefinition
|
||||
- Now Supports `-PivotFilter` and `-PivotDataToColumn`, `-ChartHeight/width` `-ChartRow/Column`, `-ChartRow/ColumnPixelOffset` parameters
|
||||
- Set-Format
|
||||
- Fixed a bug where the `-address` parameter had to be named, although the examples in `export-excel` help showed it working by position (which works now. )
|
||||
- Export-Excel
|
||||
- I've done some re-factoring
|
||||
1. I "flattened out" small "called-once" functions , add-title, convert-toNumber and Stop-ExcelProcess.
|
||||
2. It now uses Add-Worksheet, Open-ExcelPackage and Add-ConditionalFormat instead of duplicating their functionality.
|
||||
3. I've moved the PivotTable functionality (which was doubled up) out to a new function "Add-PivotTable" which supports some extra parameters PivotFilter and PivotDataToColumn, ChartHeight/width ChartRow/Column, ChartRow/ColumnPixelOffsets.
|
||||
4. I've made the try{} catch{} blocks cover smaller blocks of code to give a better idea where a failure happend, some of these now Warn instead of throwing - I'd rather save the data with warnings than throw it away because we can't add a chart. Along with this I've added some extra write-verbose messages
|
||||
- Bad column-names specified for Pivots now generate warnings instead of throwing.
|
||||
- Fixed issues when pivottables / charts already exist and an export tries to create them again.
|
||||
- Fixed issue where AutoNamedRange, NamedRange, and TableName do not work when appending to a sheet which already contains the range(s) / table
|
||||
- Fixed issue where AutoNamedRange may try to create ranges with an illegal name.
|
||||
- Added check for illegal characters in RangeName or Table Name (replace them with "_"), changed tablename validation to allow spaces and applied same validation to RangeName
|
||||
- Fixed a bug where BoldTopRow is always bolds row 1 even if the export is told to start at a lower row.
|
||||
- Fixed a bug where titles throw pivot table creation out of alignment.
|
||||
- Fixed a bug where Append can overwrite the last rows of data if the initial export had blank rows at the top of the sheet.
|
||||
- Removed the need to specify a fill type when specifying a title background color
|
||||
- Added MoveToStart, MoveToEnd, MoveBefore and MoveAfter Parameters - these go straight through to Add worksheet
|
||||
- Added "NoScriptOrAliasProperties" "DisplayPropertySet" switches (names subject to change) - combined with ExcludeProperty these are a quick way to reduce the data exported (and speed things up)
|
||||
- Add-CellValue now understands URI item properties. If a property is of type URI it is created as a hyperlink to speed up Add-CellValue
|
||||
- Commented out the write verbose statements even if verbose is silenced they cause a significiant performance impact and if it's on they will cause a flood of messages.
|
||||
- Re-ordered the choices in the switch and added an option to say "If it is numeric already post it as is"
|
||||
- Added an option to only set the number format if doesn't match the default for the sheet.
|
||||
-Export-Excel Pester Tests
|
||||
- I have converted examples 1-9, 11 and 13 from Export-Excel help into tests and have added some additional tests, and extra parameters to the example command to ge better test coverage. The test so far has 184 "should" conditions grouped as 58 "IT" statements; but is still a work in progress.
|
||||
---
|
||||
|
||||
|
||||
- [James O'Neill](https://twitter.com/jamesoneill) added `Compare-Worksheet`
|
||||
- Compares two worksheets with the same name in different files.
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
#>
|
||||
Param (
|
||||
#One or more row(s), Column(s) and/or block(s) of cells to format
|
||||
[Parameter(ValueFromPipeline = $true,ParameterSetName="Address",Mandatory=$True)]
|
||||
[Parameter(ValueFromPipeline = $true,ParameterSetName="Address",Mandatory=$True,Position=0)]
|
||||
$Address ,
|
||||
#The worksheet where the format is to be applied
|
||||
[Parameter(ParameterSetName="SheetAndRange",Mandatory=$True)]
|
||||
|
||||
Reference in New Issue
Block a user