jgaunt/ImportExcel
1
0
Fork 0
mirror of https://github.com/dfinke/ImportExcel.git synced 2026-02-08 20:50:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improved ' Get-ExcelSheetInfo '

Browse Source 
Added options to retrieve information about the sheet or about the whole
workbook. Usefull in case you want to know who last saved the file or
other information.
This commit is contained in:
DarkLite1
2017-02-08 09:58:01 +01:00
parent 9790cb958c
commit d830278cbc
1 changed files with 47 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
Get-ExcelSheetInfo.ps1
View File

@@ -1,16 +1,19 @@
Function Get-ExcelSheetInfo {
<#
.SYNOPSIS
<#
.SYNOPSIS
Get worksheet names and their indices of an Excel workbook.
.DESCRIPTION
.DESCRIPTION
The Get-ExcelSheetInfo cmdlet gets worksheet names and their indices of an Excel workbook.
.PARAMETER Path
Specifies the path to the Excel file. This parameter is required.
.PARAMETER Type
Specifies which information to get, the one from the workbook or the one from the sheets.
.EXAMPLE
Get-ExcelSheetInfo .\Test.xlsx
Get-ExcelSheetInfo .\Test.xlsx
.NOTES
CHANGELOG
@@ -18,27 +21,48 @@ Function Get-ExcelSheetInfo {
.LINK
https://github.com/dfinke/ImportExcel
#>
#>
[CmdletBinding()]
param(
Param (
[Alias("FullName")]
[Parameter(ValueFromPipelineByPropertyName=$true, ValueFromPipeline=$true, Mandatory=$true)]
$Path
[Parameter(ValueFromPipelineByPropertyName, ValueFromPipeline, Mandatory)]
[String]$Path,
[ValidateSet('Sheets', 'Workbook')]
[String]$Type = 'Workbook'
)
process {
$Path = (Resolve-Path $Path).ProviderPath
write-debug "target excel file $Path"
$stream = New-Object -TypeName System.IO.FileStream -ArgumentList $Path,"Open","Read","ReadWrite"
$xl = New-Object -TypeName OfficeOpenXml.ExcelPackage -ArgumentList $stream
$workbook = $xl.Workbook
if($workbook -and $workbook.Worksheets) {
$workbook.Worksheets |
Select-Object -Property name,index,hidden,@{
Label = "Path"
Expression = {$Path}
Process {
Try {
$Path = (Resolve-Path $Path).ProviderPath
Write-Debug "target excel file $Path"
$stream = New-Object -TypeName System.IO.FileStream -ArgumentList $Path,"Open","Read","ReadWrite"
$xl = New-Object -TypeName OfficeOpenXml.ExcelPackage -ArgumentList $stream
$workbook = $xl.Workbook
Switch ($Type) {
'Workbook' {
if ($workbook) {
$workbook.Properties
}
}
'Sheets' {
if ($workbook -and $workbook.Worksheets) {
$workbook.Worksheets |
Select-Object -Property name,index,hidden,@{
Label = "Path"
Expression = {$Path}
}
}
}
Default {
Write-Error 'Unrecogrnized type'
}
}
}
Catch {
throw "Failed retrieving Excel sheet information for '$Path': $_"
}
}
}