Cmdlet

Update-OfficeExcelText

Aliases: Replace-OfficeExcelText

Module: PSWriteOffice
Aliases: Replace-OfficeExcelText
Inputs: OfficeIMO.Excel.ExcelDocument
Outputs: System.Int32
Source: UpdateOfficeExcelTextCommand.cs:24 Edit on GitHub

Replaces text in worksheet values.

Syntax

Update-OfficeExcelText
[-CaseSensitive]
-NewValue <String>
-OldValue <String>
[-Open]
[-PassThru]
[-Path] <String>
[-Range <String>]
[-Regex]
[-Sheet <String>]
[-SheetIndex <Int32>]
[<CommonParameters>]

Parameter set: Path

Update-OfficeExcelText
[-CaseSensitive]
-Document <ExcelDocument>
-NewValue <String>
-OldValue <String>
[-PassThru]
[-Range <String>]
[-Regex]
[-Sheet <String>]
[-SheetIndex <Int32>]
[<CommonParameters>]

Parameter set: Document

Examples

Replace status text and verify the update count.

$count = Update-OfficeExcelText -Path .\Report.xlsx -Sheet Summary -OldValue Draft -NewValue Ready -PassThru
[pscustomobject]@{
    Path = '.\Report.xlsx'
    Replacements = $count
}

Updates matching text cells on a sheet, saves the workbook, and returns the replacement count.

Parameters

-CaseSensitive SwitchParameter optional: Use case-sensitive matching.
-NewValue String required: Replacement text.
-OldValue String required: Text or pattern to replace.
-Open SwitchParameter optionalaliases: Showsets: Path: Open the file after saving when using -Path.
-PassThru SwitchParameter optional: Emit the object created or changed by the command.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Workbook path to update.
-Range String optional: A1 range to update. Defaults to each selected worksheet's used range.
-Regex SwitchParameter optional: Treat -OldValue as a regular expression.
-Sheet String optionalaliases: WorksheetName: Worksheet name. Defaults to all sheets for path/document use and current sheet inside an ExcelSheet block.
-SheetIndex Int32 optional: Worksheet index when using a workbook object or path.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document: Workbook to update outside the DSL context.

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.