PSWriteOffice

PSWriteOffice is an open-source PowerShell and .NET project with packages, release history, and technical documentation.

Stars 144

Forks 12

Open issues 16

PowerShell Gallery downloads 150,904

Release v0.2.0

Language: C# Updated: 2026-04-06

API Reference

Cmdlet

Get-OfficeExcelUsedRange

Namespace PSWriteOffice

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject
System.Collections.Hashtable
System.Data.DataTable

Source

Sources/PSWriteOffice/Cmdlets/Excel/GetOfficeExcelUsedRangeCommand.cs:19 Edit on GitHub

Reads the used range from an Excel workbook.

Remarks

Returns rows as PSCustomObjects by default, with optional hashtable or DataTable output for scripting and interoperability.

Examples

Authored help example

Read the used range from a sheet.

PS>


Get-OfficeExcelUsedRange -Path .\report.xlsx -Sheet 'Data'

Reads the sheet's used range, treating the first row as headers.

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-OfficeExcelUsedRange [-AsDataTable] [-AsHashtable] [-HeadersInFirstRow <Boolean>] -InputPath <String> [-NumericAsDecimal] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]

Parameter set: Path

Parameters

AsDataTable SwitchParameter optionalposition: namedpipeline: False: Emit the raw DataTable instead of row objects.
AsHashtable SwitchParameter optionalposition: namedpipeline: False: Emit rows as hashtables instead of PSCustomObjects.
HeadersInFirstRow Boolean optionalposition: namedpipeline: False: Use the first row as column headers.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Path to the workbook.
NumericAsDecimal SwitchParameter optionalposition: namedpipeline: False: Prefer decimals instead of doubles for numeric values.
Sheet String optionalposition: namedpipeline: False: Worksheet name to read; defaults to the first sheet.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Zero-based worksheet index to read; defaults to the first sheet.

Outputs

System.Management.Automation.PSObject System.Collections.Hashtable System.Data.DataTable

Get-OfficeExcelUsedRange [-AsDataTable] [-AsHashtable] -Document <ExcelDocument> [-HeadersInFirstRow <Boolean>] [-NumericAsDecimal] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]

Parameter set: Document

Parameters

AsDataTable SwitchParameter optionalposition: namedpipeline: False: Emit the raw DataTable instead of row objects.
AsHashtable SwitchParameter optionalposition: namedpipeline: False: Emit rows as hashtables instead of PSCustomObjects.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook to inspect.
HeadersInFirstRow Boolean optionalposition: namedpipeline: False: Use the first row as column headers.
NumericAsDecimal SwitchParameter optionalposition: namedpipeline: False: Prefer decimals instead of doubles for numeric values.
Sheet String optionalposition: namedpipeline: False: Worksheet name to read; defaults to the first sheet.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Zero-based worksheet index to read; defaults to the first sheet.

Outputs

System.Management.Automation.PSObject System.Collections.Hashtable System.Data.DataTable