Get Started

API Reference

Cmdlet

Get-OfficeExcelSummary

Aliases: ExcelSummary
Namespace PSWriteOffice
Aliases
ExcelSummary
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Management.Automation.PSObject
Source
Sources/PSWriteOffice/Cmdlets/Excel/GetOfficeExcelSummaryCommand.cs:27 Edit on GitHub

Gets a compact structural summary of an Excel workbook.

Remarks

Gets a compact structural summary of an Excel workbook.

Examples

Authored help example

Summarize workbook contents before release.

PS>


$summary = Get-OfficeExcelSummary -Path .\report.xlsx -IncludeSheets
            $summary |
                Select-Object -Property SheetCount, TableCount, ChartCount, PivotTableCount
            $summary.Sheets |
                Select-Object -Property Name, State, UsedRange

Returns workbook-level counts plus per-sheet tables, charts, pivots, links, comments, and used ranges.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-OfficeExcelSummary [-IncludeSchema] [-IncludeSheets] -InputPath <String> [<CommonParameters>]
#
Parameter set: Path

Parameters

IncludeSchema SwitchParameter optionalposition: namedpipeline: False
Include OfficeIMO inspection snapshot details for schema discovery.
IncludeSheets SwitchParameter optionalposition: namedpipeline: False
Include per-sheet details in the returned object.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path
Path to the workbook.

Outputs

System.Management.Automation.PSObject

Get-OfficeExcelSummary -Document <ExcelDocument> [-IncludeSchema] [-IncludeSheets] [<CommonParameters>]
#
Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook to inspect.
IncludeSchema SwitchParameter optionalposition: namedpipeline: False
Include OfficeIMO inspection snapshot details for schema discovery.
IncludeSheets SwitchParameter optionalposition: namedpipeline: False
Include per-sheet details in the returned object.

Outputs

System.Management.Automation.PSObject