Cmdlet

Remove-OfficeExcelNamedRange

Aliases: ExcelNamedRangeRemove

Module PSWriteOffice

Aliases

ExcelNamedRangeRemove

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Boolean

Source

RemoveOfficeExcelNamedRangeCommand.cs:20 Edit on GitHub

Removes a workbook or sheet-scoped Excel named range.

Syntax

Remove-OfficeExcelNamedRange [-Global] [-Name] <String> [-PassThru] [-Save] [<CommonParameters>]

Parameter set: Context

Remove-OfficeExcelNamedRange -Document <ExcelDocument> [-Name] <String> [-PassThru] [-Save] [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Remove a stale sheet-scoped named range from a workbook.

$workbook = Get-OfficeExcel -Path .\Report.xlsx
$removed = $workbook | Remove-OfficeExcelNamedRange -Sheet Data -Name OldCriteria -PassThru
Save-OfficeExcel -Document $workbook

Uses the thin PowerShell surface over OfficeIMO named-range removal and saves the updated workbook.

Parameters

-Global SwitchParameter optionalsets: Context: Use workbook-global scope from inside the DSL.
-Name String requiredposition: 0: Named range name.
-PassThru SwitchParameter optional: Emit a result object.
-Save SwitchParameter optional: Save the workbook immediately after removing the name.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document: Workbook document.
-Sheet String optionalsets: Document: Worksheet name for a sheet-scoped operation.
-SheetIndex Int32 optionalsets: Document: Zero-based worksheet index for a sheet-scoped operation.

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.