Cmdlet

Get-OfficeExcelNamedRange

Module: PSWriteOffice
Inputs: OfficeIMO.Excel.ExcelDocument System.String[]
Source: GetOfficeExcelNamedRangeCommand.cs:27 Edit on GitHub

Gets defined names from a workbook.

Syntax

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

Parameter set: Document

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

Parameter set: Path

Get-OfficeExcelNamedRange
-LiteralPath <String[]>
[-Name <String>]
[-Sheet <OfficeSheetSelector>]
[<CommonParameters>]

Parameter set: LiteralPath

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

Parameter set: Uri

Examples

List defined names

Get-OfficeExcelNamedRange -Path .\Finance\Pricing-Model.xlsx

Shows every defined name and what it refers to.

Find broken names

Get-OfficeExcelNamedRange -Path .\Finance\Budget-2027.xlsx |
                Where-Object Reference -like '*#REF!*' |
                Select-Object Name, SheetName, Reference

Lists the defined names that refer to #REF! after sheets were deleted, so they can be repaired or removed.

Parameters

-Document ExcelDocument optionalpipeline: True (ByValue)sets: Document: Caller-owned workbook; omission uses the enclosing Excel content block.
-Name String optional: Optional named range to retrieve.
-Sheet OfficeSheetSelector optionalaliases: WorksheetName: Worksheet name, one-based position or native worksheet object. Multi-sheet commands also accept wildcard names.
-Path String[] requiredposition: 0pipeline: True (ByValue)aliases: FilePathsets: Path: Workbook paths resolved with filesystem wildcard support.
-LiteralPath String[] requiredpipeline: True (ByPropertyName)aliases: FullName, PSPathsets: LiteralPath: Literal workbook paths, including FileInfo.FullName and provider PSPath.
-AllowHttp SwitchParameter optionalsets: Uri: Allow HTTP workbook downloads in addition to HTTPS.
-Uri Uri requiredposition: 0sets: Uri: Remote workbook URI 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.