Cmdlet

Get-OfficeExcelNamedRange

Module: PSWriteOffice
Inputs: OfficeIMO.Excel.ExcelDocument
Outputs: System.Management.Automation.PSObject
Source: GetOfficeExcelNamedRangeCommand.cs:24 Edit on GitHub

Gets defined names (named ranges) from an Excel workbook.

Syntax

Get-OfficeExcelNamedRange
[-Name <String>]
[-Path] <String>
[-Sheet <String>]
[-SheetIndex <Int32>]
[<CommonParameters>]

Parameter set: Path

Get-OfficeExcelNamedRange
[-AllowHttp]
[-Name <String>]
[-Sheet <String>]
[-SheetIndex <Int32>]
[-Uri] <Uri>
[<CommonParameters>]

Parameter set: Uri

Get-OfficeExcelNamedRange
-Document <ExcelDocument>
[-Name <String>]
[-Sheet <String>]
[-SheetIndex <Int32>]
[<CommonParameters>]

Parameter set: Document

Examples

List workbook and sheet-scoped names.

$ranges = Get-OfficeExcelNamedRange -Path .\report.xlsx
$ranges |
    Select-Object -Property Name, Scope, Range |
    Format-Table -AutoSize

Returns named ranges so workbook navigation and formulas can be reviewed.

Parameters

-Name String optional: Optional named range to retrieve.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Path to the workbook.
-Sheet String optional: Optional sheet name for sheet-scoped names.
-SheetIndex Int32 optional: Optional sheet index (0-based) for sheet-scoped names.
-AllowHttp SwitchParameter optionalsets: Uri: Allow HTTP workbook downloads in addition to HTTPS.
-Uri Uri requiredposition: 0aliases: Urlsets: Uri: Remote workbook URI to inspect.
-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.