Get Started

API Reference

Cmdlet

Update-OfficeExcelText

Aliases: Replace-OfficeExcelText
Namespace PSWriteOffice
Aliases
Replace-OfficeExcelText
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Int32
Source
Sources/PSWriteOffice/Cmdlets/Excel/UpdateOfficeExcelTextCommand.cs:21 Edit on GitHub

Replaces text in worksheet values.

Remarks

Replaces text in worksheet values.

Examples

Authored help example

Replace status text and verify the update count.

PS>


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

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

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

Update-OfficeExcelText [-CaseSensitive] -InputPath <String> -NewValue <String> -OldValue <String> [-Range <String>] [-Regex] [-Sheet <String>] [-SheetIndex <Nullable`1>] [-Show] [<CommonParameters>]
#
Parameter set: Path

Parameters

CaseSensitive SwitchParameter optionalposition: namedpipeline: False
Use case-sensitive matching.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path
Workbook path to update.
NewValue String requiredposition: namedpipeline: False
Replacement text.
OldValue String requiredposition: namedpipeline: False
Text or pattern to replace.
Range String optionalposition: namedpipeline: False
A1 range to update. Defaults to each selected worksheet's used range.
Regex SwitchParameter optionalposition: namedpipeline: False
Treat -OldValue as a regular expression.
Sheet String optionalposition: namedpipeline: Falsealiases: WorksheetName
Worksheet name. Defaults to all sheets for path/document use and current sheet inside an ExcelSheet block.
SheetIndex Nullable`1 optionalposition: namedpipeline: False
Worksheet index when using a workbook object or path.
Show SwitchParameter optionalposition: namedpipeline: False
Open the file after saving when using -Path.

Outputs

System.Int32

Update-OfficeExcelText [-CaseSensitive] -Document <ExcelDocument> -NewValue <String> -OldValue <String> [-Range <String>] [-Regex] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]
#
Parameter set: Document

Parameters

CaseSensitive SwitchParameter optionalposition: namedpipeline: False
Use case-sensitive matching.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook to update outside the DSL context.
NewValue String requiredposition: namedpipeline: False
Replacement text.
OldValue String requiredposition: namedpipeline: False
Text or pattern to replace.
Range String optionalposition: namedpipeline: False
A1 range to update. Defaults to each selected worksheet's used range.
Regex SwitchParameter optionalposition: namedpipeline: False
Treat -OldValue as a regular expression.
Sheet String optionalposition: namedpipeline: Falsealiases: WorksheetName
Worksheet name. Defaults to all sheets for path/document use and current sheet inside an ExcelSheet block.
SheetIndex Nullable`1 optionalposition: namedpipeline: False
Worksheet index when using a workbook object or path.

Outputs

System.Int32