API Reference
Get-OfficeExcelUsedRange
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
Example 1: Read the used range and produce a quick status count.
PS>
$rows = Get-OfficeExcelUsedRange -Path .\report.xlsx -Sheet Data
$rows |
Group-Object -Property Status |
Select-Object -Property Name, Count
Reads the sheet's used range, treats the first row as headers, and summarizes a status column.
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>]PathParameters
- AsDataTable SwitchParameter
- Emit the raw DataTable instead of row objects.
- AsHashtable SwitchParameter
- Emit rows as hashtables instead of PSCustomObjects.
- HeadersInFirstRow Boolean
- Use the first row as column headers.
- InputPath String
- Path to the workbook.
- NumericAsDecimal SwitchParameter
- Prefer decimals instead of doubles for numeric values.
- Sheet String
- Worksheet name to read; defaults to the first sheet.
- SheetIndex Nullable`1
- Zero-based worksheet index to read; defaults to the first sheet.
Outputs
System.Collections.Hashtable, System.Data.DataTable, System.Management.Automation.PSObject
Get-OfficeExcelUsedRange [-AllowHttp] [-AsDataTable] [-AsHashtable] [-HeadersInFirstRow <Boolean>] [-NumericAsDecimal] [-Sheet <String>] [-SheetIndex <Nullable`1>] -Uri <Uri> [<CommonParameters>]UriParameters
- AllowHttp SwitchParameter
- Allow HTTP workbook downloads in addition to HTTPS.
- AsDataTable SwitchParameter
- Emit the raw DataTable instead of row objects.
- AsHashtable SwitchParameter
- Emit rows as hashtables instead of PSCustomObjects.
- HeadersInFirstRow Boolean
- Use the first row as column headers.
- NumericAsDecimal SwitchParameter
- Prefer decimals instead of doubles for numeric values.
- Sheet String
- Worksheet name to read; defaults to the first sheet.
- SheetIndex Nullable`1
- Zero-based worksheet index to read; defaults to the first sheet.
- Uri Uri
- Remote workbook URI to read.
Outputs
System.Collections.Hashtable, System.Data.DataTable, System.Management.Automation.PSObject
Get-OfficeExcelUsedRange [-AsDataTable] [-AsHashtable] -Document <ExcelDocument> [-HeadersInFirstRow <Boolean>] [-NumericAsDecimal] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]DocumentParameters
- AsDataTable SwitchParameter
- Emit the raw DataTable instead of row objects.
- AsHashtable SwitchParameter
- Emit rows as hashtables instead of PSCustomObjects.
- Document ExcelDocument
- Workbook to inspect.
- HeadersInFirstRow Boolean
- Use the first row as column headers.
- NumericAsDecimal SwitchParameter
- Prefer decimals instead of doubles for numeric values.
- Sheet String
- Worksheet name to read; defaults to the first sheet.
- SheetIndex Nullable`1
- Zero-based worksheet index to read; defaults to the first sheet.
Outputs
System.Collections.Hashtable, System.Data.DataTable, System.Management.Automation.PSObject