Project

PSWriteOffice

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

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-OfficeExcelData

Module: PSWriteOffice
Inputs: OfficeIMO.Excel.ExcelDocument
Source: GetOfficeExcelDataCommand.cs:20 Edit on GitHub

Reads worksheet data as dictionaries or PSCustomObjects.

Syntax

Get-OfficeExcelData
[-AsHashtable]
[-Document <ExcelDocument>]
[-NumericAsDecimal]
[[-Path] <String>]
[-Range <String>]
[-Sheet <String>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Description

Uses the first row as headers and streams rows through the OfficeIMO Excel data reader.

Examples

Read the used range as PSCustomObjects.

Get-OfficeExcelData -Path .\report.xlsx -Sheet 'Summary' | Format-Table

Returns each row as a PSCustomObject with properties mapped from the header row.

Parameters

-AsHashtable SwitchParameter optional: Emit each row as a dictionary instead of PSCustomObjects.
-Document ExcelDocument optionalpipeline: True (ByValue): Workbook to read when it is already open.
-NumericAsDecimal SwitchParameter optional: Prefer decimals (instead of doubles) for numeric cells.
-Path String optionalposition: 0: Path to the workbook when no Document is supplied.
-Range String optional: Optional A1 range (e.g. A1:D10). When omitted, the sheet's used range is read.
-Sheet String optional: Worksheet name to read; defaults to the first sheet.

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.