Updated

Style and read only

AddConditionalFormatting.ps1

@@ -1,4 +1,9 @@
-Function Add-ConditionalFormatting {
+try   {
+    #ensure that color and font lookups are available
+    [void] [System.Reflection.Assembly]::LoadWithPartialName("System.Drawing")
+}
+catch {}
+Function Add-ConditionalFormatting {
     <#
       .Synopsis
         Adds conditional formatting to all or part of a worksheet.
@@ -105,7 +110,7 @@
         [OfficeOpenXml.ConditionalFormatting.eExcelConditionalFormattingRuleType]$RuleType ,
         #Text color for matching objects
         [Parameter(ParameterSetName = "NamedRule")]
-        [Alias("ForegroundColour")]
+        [Alias("ForegroundColour","FontColor")]
         $ForegroundColor,
         #Color for databar type charts
         [Parameter(Mandatory = $true, ParameterSetName = "DataBar")]

ColorCompletion.ps1

@@ -27,6 +27,10 @@ if (Get-Command -Name register-argumentCompleter -ErrorAction SilentlyContinue)
     Register-ArgumentCompleter -CommandName New-ConditionalText        -ParameterName PatternColor           -ScriptBlock $Function:ColorCompletion
     Register-ArgumentCompleter -CommandName New-ConditionalText        -ParameterName BackgroundColor        -ScriptBlock $Function:ColorCompletion
     Register-ArgumentCompleter -CommandName New-ConditionalText        -ParameterName ConditionalTextColor   -ScriptBlock $Function:ColorCompletion
+    Register-ArgumentCompleter -CommandName New-ExcelStyle             -ParameterName BackgroundColor        -ScriptBlock $Function:ColorCompletion
+    Register-ArgumentCompleter -CommandName New-ExcelStyle             -ParameterName FontColor              -ScriptBlock $Function:ColorCompletion
+    Register-ArgumentCompleter -CommandName New-ExcelStyle             -ParameterName BorderColor            -ScriptBlock $Function:ColorCompletion
+    Register-ArgumentCompleter -CommandName New-ExcelStyle             -ParameterName PatternColor           -ScriptBlock $Function:ColorCompletion
     Register-ArgumentCompleter -CommandName Set-ExcelRange             -ParameterName BackgroundColor        -ScriptBlock $Function:ColorCompletion
     Register-ArgumentCompleter -CommandName Set-ExcelRange             -ParameterName FontColor              -ScriptBlock $Function:ColorCompletion
     Register-ArgumentCompleter -CommandName Set-ExcelRange             -ParameterName BorderColor            -ScriptBlock $Function:ColorCompletion
@@ -37,5 +41,4 @@ if (Get-Command -Name register-argumentCompleter -ErrorAction SilentlyContinue)
     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 PatternColor           -ScriptBlock $Function:ColorCompletion
-
 }

Examples/CustomReporting/CustomReport.ps1

@@ -1,6 +1,6 @@
 try {. $PSScriptRoot\..\..\LoadPSD1.ps1} catch {}
 
-$f = ".\dashboard.xlsx"
+$f = "$env:temp\dashboard.xlsx"
 Remove-Item $f -ErrorAction Ignore
 
 $data = @"
@@ -69,4 +69,4 @@ Set-Format -Address $sheet1.Cells["I10"] -Formula "=Sum(I3:I8)" -Bold
 Set-Format -Address $sheet1.Cells["M10"] -Formula "=Sum(M3:M8)" -Bold
 Set-Format -Address $sheet1.Cells["O10"] -Formula "=Sum(O3:O8)" -Bold
 
-Close-ExcelPackage $excel -Show
+Close-ExcelPackage $excel -Show

Examples/Styles/MultipleStyles.ps1

@@ -0,0 +1,35 @@
+try { . $PSScriptRoot\..\..\LoadPSD1.ps1 } catch { }
+
+$xlfile = "$env:TEMP\test.xlsx"
+Remove-Item $xlfile -ErrorAction SilentlyContinue
+
+$data = ConvertFrom-Csv @"
+Region,Item,TotalSold
+North,melon,38
+South,screwdriver,21
+South,peach,33
+South,saw,81
+South,kiwi,70
+North,orange,59
+North,avocado,25
+South,lime,48
+South,nail,83
+North,apple,2
+"@
+
+$styleParams = @{
+    FontSize = 13
+    Bold     = $true
+}
+
+$styles = $(
+    New-ExcelStyle -BackgroundColor LightBlue -FontSize 14 -Bold -Range "A1:H1" -HorizontalAlignment Center -Merge
+
+    New-ExcelStyle -BackgroundColor LimeGreen -Range "B10" @styleParams
+    New-ExcelStyle -BackgroundColor PeachPuff -Range "B5" @styleParams
+    New-ExcelStyle -BackgroundColor Orange -Range "B8" @styleParams
+    New-ExcelStyle -BackgroundColor Red -Range "B12" @styleParams
+)
+
+$reportTitle = "This is a report Title"
+$data | Export-Excel $xlfile -Show -AutoSize -AutoFilter -Title $reportTitle -Style $styles

Examples/Styles/NewExcelStyle.ps1

@@ -0,0 +1,23 @@
+# https://raw.githubusercontent.com/dfinke/ImportExcel/master/images/NewExcelStyle.png
+try { . $PSScriptRoot\..\..\LoadPSD1.ps1 } catch { }
+
+$xlfile = "$env:TEMP\test.xlsx"
+Remove-Item $xlfile -ErrorAction SilentlyContinue
+
+$data = ConvertFrom-Csv @"
+Region,Item,TotalSold
+North,melon,38
+South,screwdriver,21
+South,peach,33
+South,saw,81
+South,kiwi,70
+North,orange,59
+North,avocado,25
+South,lime,48
+South,nail,83
+North,apple,2
+"@
+
+$reportTitle = "This is a report Title"
+$style = New-ExcelStyle -BackgroundColor LightBlue -FontSize 14 -Bold -Range "A1:H1" -HorizontalAlignment Center -Merge
+$data | Export-Excel $xlfile -Show -AutoSize -AutoFilter -Title $reportTitle -Style $style

Examples/VBA/HelloWorldVBA.ps1

@@ -0,0 +1,38 @@
+$xlfile = "$env:temp\test.xlsm"
+Remove-Item $xlfile -ErrorAction SilentlyContinue
+
+$Excel = ConvertFrom-Csv @"
+Region,Item,TotalSold
+West,screwdriver,98
+West,kiwi,19
+North,kiwi,47
+West,screws,48
+West,avocado,52
+East,avocado,40
+South,drill,61
+North,orange,92
+South,drill,29
+South,saw,36
+"@ | Export-Excel $xlfile -PassThru -AutoSize
+
+$wb = $Excel.Workbook
+$sheet = $wb.Worksheets["Sheet1"]
+$wb.CreateVBAProject()
+
+$code = @"
+Public Function HelloWorld() As String
+    HelloWorld = "Hello World"
+End Function
+
+Public Function DoSum() As Integer
+    DoSum = Application.Sum(Range("C:C"))
+End Function
+"@
+
+$module = $wb.VbaProject.Modules.AddModule("PSExcelModule")
+$module.Code = $code
+
+Set-Format -WorkSheet $sheet -Range "h7" -Formula "HelloWorld()" -AutoSize
+Set-Format -WorkSheet $sheet -Range "h8" -Formula "DoSum()" -AutoSize
+
+Close-ExcelPackage $Excel -Show

Export-Excel.ps1

@@ -499,6 +499,7 @@
         [Switch]$AutoNameRange,
         [Int]$StartRow = 1,
         [Int]$StartColumn = 1,
+        [alias('PT')]
         [Switch]$PassThru,
         [String]$Numberformat = 'General',
         [string[]]$ExcludeProperty,
@@ -507,6 +508,7 @@
         [String[]]$NoNumberConversion,
         [Object[]]$ConditionalFormat,
         [Object[]]$ConditionalText,
+        [Object[]]$Style,
         [ScriptBlock]$CellStyleSB,
         #If there is already content in the workbook the sheet with the PivotTable will not be active UNLESS Activate is specified
         [switch]$Activate,
@@ -1022,7 +1024,10 @@
             }
             catch {throw "Error applying conditional formatting to worksheet $_"}
         }
-
+        foreach ($s in $Style) {
+            if (-not $s.Range) {$s["Range"] = $ws.Dimension.Address }
+            Set-ExcelRange -WorkSheet $ws @s
+        }
         if ($CellStyleSB) {
             try {
                 $TotalRows = $ws.Dimension.Rows

ImportExcel.psd1

@@ -4,7 +4,7 @@
     RootModule        = 'ImportExcel.psm1'
 
     # Version number of this module.
-    ModuleVersion     = '6.1.0'
+    ModuleVersion     = '6.2.0'
 
     # ID used to uniquely identify this module
     GUID              = '60dd4136-feff-401a-ba27-a84458c57ede'
@@ -103,6 +103,7 @@ Check out the How To Videos https://www.youtube.com/watch?v=U3Ne_yX4tYo&list=PL5
         'New-ConditionalFormattingIconSet',
         'New-ConditionalText',
         'New-ExcelChartDefinition',
+        'New-ExcelStyle',
         'New-PivotTableDefinition',
         'New-Plot',
         'New-PSItem',

ImportExcel.psm1

@@ -345,8 +345,11 @@ function Import-Excel {
     }
 
     process {
-        if      ($Path -and  $Password)  {$ExcelPackage = Open-ExcelPackage -Path $Path -Password $Password}
-        elseif ($Path)                   {$ExcelPackage = Open-ExcelPackage -Path $Path}
+        if ($path) {
+            $stream = New-Object -TypeName System.IO.FileStream -ArgumentList $Path, 'Open', 'Read', 'ReadWrite'
+            if     ($Password)  {$ExcelPackage = New-Object -TypeName OfficeOpenXml.ExcelPackage -ArgumentList $stream , $Password }
+            else                {$ExcelPackage = New-Object -TypeName OfficeOpenXml.ExcelPackage -ArgumentList $stream}
+        }
         try {
             #Select worksheet
             if (-not  $WorksheetName) { $Worksheet = $ExcelPackage.Workbook.Worksheets[1] }
@@ -414,7 +417,7 @@ function Import-Excel {
         }
         catch { throw "Failed importing the Excel workbook '$Path' with worksheet '$Worksheetname': $_"; return }
         finally {
-            if ($Path) {Close-ExcelPackage -ExcelPackage $ExcelPackage -NoSave }
+            if ($Path) {$stream.close(); $ExcelPackage.Dispose() }
         }
     }
 }
@@ -513,7 +516,7 @@ Function WorksheetArgumentCompleter {
     param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
     $xlPath = $fakeBoundParameter['Path']
     if (Test-Path -Path $xlPath) {
-        $xlpkg = Open-ExcelPackage -Path $xlPath
+        $xlpkg = Open-ExcelPackage -ReadOnly -Path $xlPath
         $WorksheetNames = $xlPkg.Workbook.Worksheets.Name
         Close-ExcelPackage -nosave -ExcelPackage $xlpkg
         $WorksheetNames.where( {$_ -like "*$wordToComplete*"}) | foreach-object {

New-ConditionalText.ps1

@@ -39,7 +39,7 @@ function New-ConditionalText {
         "Finish Position". The range could be written -Range "C:C" to specify a
         named column, or -Range "C2:C102" to specify certain cells in the column.
       .Link
-        Add-Add-ConditionalFormatting
+        Add-ConditionalFormatting
         New-ConditionalFormattingIconSet
     #>
     [cmdletbinding()]

README.md

@@ -53,6 +53,15 @@ Install-Module ImportExcel -scope CurrentUser
 Install-Module ImportExcel
 ```
 
+# What's new 6.2.0
+Thank you to [James O'Neill](https://github.com/jhoneill)
+
+- Fixed, Import-Excel can read xlsx files even if already open in Excel
+- Added `New-ExcelStyle`, plus `-Style` to `Export-Excel` and `-Merge` to `Set-ExcelRange`
+- Added [Style Examples](https://github.com/dfinke/ImportExcel/tree/master/Examples/Styles)
+
+![](https://raw.githubusercontent.com/dfinke/ImportExcel/master/images/NewExcelStyle.png)
+
 # What's new 6.1.0
 
 Thank you to [James O'Neill](https://github.com/jhoneill)

SetFormat.ps1

@@ -1,4 +1,4 @@
-Function Set-ExcelRange {
+function Set-ExcelRange {
     <#
       .SYNOPSIS
         Applies number, font, alignment and/or color formatting, values or formulas to a range of Excel cells.
@@ -56,6 +56,7 @@
         #Style for the right border.
         [OfficeOpenXml.Style.ExcelBorderStyle]$BorderRight,
         #Colour for the text - if none is specified it will be left as it is.
+        [Alias('ForegroundColor')]
         $FontColor,
         #Value for the cell.
         $Value,
@@ -107,7 +108,9 @@
         #Hide a row or column  (not a range); use -Hidden:$false to unhide.
         [Switch]$Hidden,
         #Locks cells. Cells are locked by default use -locked:$false on the whole sheet and then lock specific ones, and enable protection on the sheet.
-        [Switch]$Locked
+        [Switch]$Locked,
+        #Merges cells - it is recommended that you explicitly set -HorizontalAlignment
+        [Switch]$Merge
     )
     process {
         if  ($Range -is [Array])  {
@@ -168,6 +171,9 @@
             if ($PSBoundParameters.ContainsKey('VerticalAlignment')) {
                 $Range.Style.VerticalAlignment   = $VerticalAlignment
             }
+            if ($PSBoundParameters.ContainsKey('Merge')) {
+                $Range.Merge   = [boolean]$Merge
+            }
             if ($PSBoundParameters.ContainsKey('Value')) {
                 if ($Value -match '^=')      {$PSBoundParameters["Formula"] = $Value -replace '^=','' }
                 else {
@@ -251,7 +257,7 @@
     }
 }
 
-Function NumberFormatCompletion {
+function NumberFormatCompletion {
     param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
     $numformats = [ordered]@{
         "General"       = "General"      # format ID  0
@@ -294,6 +300,7 @@ Function NumberFormatCompletion {
 if (Get-Command -ErrorAction SilentlyContinue -name Register-ArgumentCompleter) {
     Register-ArgumentCompleter -CommandName Add-ConditionalFormatting  -ParameterName NumberFormat        -ScriptBlock $Function:NumberFormatCompletion
     Register-ArgumentCompleter -CommandName Export-Excel               -ParameterName NumberFormat        -ScriptBlock $Function:NumberFormatCompletion
+    Register-ArgumentCompleter -CommandName New-ExcelStyle             -ParameterName NumberFormat        -ScriptBlock $Function:NumberFormatCompletion
     Register-ArgumentCompleter -CommandName Set-ExcelRange             -ParameterName NumberFormat        -ScriptBlock $Function:NumberFormatCompletion
     Register-ArgumentCompleter -CommandName Set-ExcelColumn            -ParameterName NumberFormat        -ScriptBlock $Function:NumberFormatCompletion
     Register-ArgumentCompleter -CommandName Set-ExcelRow               -ParameterName NumberFormat        -ScriptBlock $Function:NumberFormatCompletion
@@ -305,7 +312,27 @@ if (Get-Command -ErrorAction SilentlyContinue -name Register-ArgumentCompleter)
     Register-ArgumentCompleter -CommandName Add-ExcelChart             -ParameterName YAxisNumberformat   -ScriptBlock $Function:NumberFormatCompletion
 }
 
-Function Expand-NumberFormat {
+function ListFonts {
+    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
+    if (-not $script:FontFamilies) {
+        $script:FontFamilies = @("","")
+        try {
+            $script:FontFamilies = (New-Object System.Drawing.Text.InstalledFontCollection).Families.Name
+        }
+        catch {}
+    }
+    $script:FontFamilies.where({$_ -Gt "" -and $_ -like "$wordToComplete*"} ) | ForEach-Object {
+        New-Object -TypeName System.Management.Automation.CompletionResult -ArgumentList "'$_'" , $_ ,
+        ([System.Management.Automation.CompletionResultType]::ParameterValue) , $_
+    }
+}
+if (Get-Command -ErrorAction SilentlyContinue -name Register-ArgumentCompleter) {
+    Register-ArgumentCompleter -CommandName New-ExcelStyle   -ParameterName FontName        -ScriptBlock $Function:ListFonts
+    Register-ArgumentCompleter -CommandName Set-ExcelColumn  -ParameterName FontName        -ScriptBlock $Function:ListFonts
+    Register-ArgumentCompleter -CommandName Set-ExcelRange   -ParameterName FontName        -ScriptBlock $Function:ListFonts
+    Register-ArgumentCompleter -CommandName Set-ExcelRow     -ParameterName FontName        -ScriptBlock $Function:ListFonts
+}
+function Expand-NumberFormat {
     <#
       .SYNOPSIS
         Converts short names for number formats to the formatting strings used in Excel
@@ -381,3 +408,81 @@ Function Expand-NumberFormat {
         Default         {return  $NumberFormat}
     }
 }
+
+function New-ExcelStyle {
+    param (
+        [Alias("Address")]
+        $Range ,
+        #Number format to apply to cells e.g. "dd/MM/yyyy HH:mm", "£#,##0.00;[Red]-£#,##0.00", "0.00%" , "##/##" , "0.0E+0" etc.
+        [Alias("NFormat")]
+        $NumberFormat,
+        #Style of border to draw around the range.
+        [OfficeOpenXml.Style.ExcelBorderStyle]$BorderAround,
+        #Color of the border.
+        $BorderColor=[System.Drawing.Color]::Black,
+        #Style for the bottom border.
+        [OfficeOpenXml.Style.ExcelBorderStyle]$BorderBottom,
+        #Style for the top border.
+        [OfficeOpenXml.Style.ExcelBorderStyle]$BorderTop,
+        #Style for the left border.
+        [OfficeOpenXml.Style.ExcelBorderStyle]$BorderLeft,
+        #Style for the right border.
+        [OfficeOpenXml.Style.ExcelBorderStyle]$BorderRight,
+        #Colour for the text - if none is specified it will be left as it is.
+        [Alias('ForegroundColor')]
+        $FontColor,
+        #Value for the cell.
+        $Value,
+        #Formula for the cell.
+        $Formula,
+        #Specifies formula should be an array formula (a.k.a CSE [ctrl-shift-enter] formula).
+        [Switch]$ArrayFormula,
+        #Clear Bold, Italic, StrikeThrough and Underline and set color to Black.
+        [Switch]$ResetFont,
+        #Make text bold; use -Bold:$false to remove bold.
+        [Switch]$Bold,
+        #Make text italic;  use -Italic:$false to remove italic.
+        [Switch]$Italic,
+        #Underline the text using the underline style in -UnderlineType;  use -Underline:$false to remove underlining.
+        [Switch]$Underline,
+         #Specifies whether underlining should be single or double, normal or accounting mode. The default is "Single".
+        [OfficeOpenXml.Style.ExcelUnderLineType]$UnderLineType = [OfficeOpenXml.Style.ExcelUnderLineType]::Single,
+        #Strike through text; use -Strikethru:$false to remove Strike through
+        [Switch]$StrikeThru,
+        #Subscript or Superscript (or none).
+        [OfficeOpenXml.Style.ExcelVerticalAlignmentFont]$FontShift,
+        #Font to use - Excel defaults to Calibri.
+        [String]$FontName,
+        #Point size for the text.
+        [float]$FontSize,
+        #Change background color.
+        $BackgroundColor,
+        #Background pattern - Solid by default.
+        [OfficeOpenXml.Style.ExcelFillStyle]$BackgroundPattern = [OfficeOpenXml.Style.ExcelFillStyle]::Solid ,
+        #Secondary color for background pattern.
+        [Alias("PatternColour")]
+        $PatternColor,
+        #Turn on Text-Wrapping; use -WrapText:$false to turn off wrapping.
+        [Switch]$WrapText,
+        #Position cell contents to Left, Right, Center etc. default is 'General'.
+        [OfficeOpenXml.Style.ExcelHorizontalAlignment]$HorizontalAlignment,
+        #Position cell contents to Top, Bottom or Center.
+        [OfficeOpenXml.Style.ExcelVerticalAlignment]$VerticalAlignment,
+        #Degrees to rotate text. Up to +90 for anti-clockwise ("upwards"), or to -90 for clockwise.
+        [ValidateRange(-90, 90)]
+        [int]$TextRotation ,
+        #Autofit cells to width  (columns or ranges only).
+        [Alias("AutoFit")]
+        [Switch]$AutoSize,
+        #Set cells to a fixed width (columns or ranges only), ignored if Autosize is specified.
+        [float]$Width,
+        #Set cells to a fixed height  (rows or ranges only).
+        [float]$Height,
+        #Hide a row or column  (not a range); use -Hidden:$false to unhide.
+        [Switch]$Hidden,
+        #Locks cells. Cells are locked by default use -locked:$false on the whole sheet and then lock specific ones, and enable protection on the sheet.
+        [Switch]$Locked,
+        [Switch]$Merge
+    )
+    $PSBoundParameters
+}

__tests__/ConvertFromExcelToSQLInsert.tests.ps1

@@ -1,6 +1,6 @@
 Import-Module $PSScriptRoot\..\ImportExcel.psd1 -Force
 
-$xlFile = ".\testSQL.xlsx"
+$xlFile = "$env:TEMP\testSQL.xlsx"
 
 Describe "ConvertFrom-ExcelToSQLInsert" {
 

azure-pipelines.yml

@@ -12,4 +12,4 @@ steps:
 trigger:
   paths:
     exclude:
-    - README.md
+      - README.md