Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

View on GitHub Releases Get package
Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
Cmdlet

Get-OfficeExcelSummary

Aliases: ExcelSummary
Module
PSWriteOffice
Aliases
ExcelSummary
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Management.Automation.PSObject
Source
GetOfficeExcelSummaryCommand.cs:30 Edit on GitHub

Gets a compact structural summary of an Excel workbook.

Syntax

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

Examples

Summarize workbook contents before release.

$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.

Parameters

-IncludeSchema SwitchParameter optional
Include OfficeIMO inspection snapshot details for schema discovery.
-IncludeSheets SwitchParameter optional
Include per-sheet details in the returned object.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path
Path to the workbook.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document
Workbook to inspect.

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.