Project

PSWriteOffice

PSWriteOffice is an open-source PowerShell and .NET project with packages, release history, and technical documentation.

View on GitHub Releases Get package

Stars 144

Forks 12

Open issues 16

PowerShell Gallery downloads 150,904

Release v0.2.0

Language: C# Updated: 2026-04-06

API Reference

Cmdlet

Add-OfficeExcelSheet

Namespace PSWriteOffice

Inputs

None

Outputs

System.Object

Source

Sources/PSWriteOffice/Cmdlets/Excel/AddOfficeExcelSheetCommand.cs:17 Edit on GitHub

Adds or reuses a worksheet within the current Excel DSL scope.

Remarks

Creates the sheet when missing, pushes it onto the DSL stack, and executes the nested script block.

Examples

Authored help example

Create a sheet named Data.

PS>


New-OfficeExcel -Path .\report.xlsx { Add-OfficeExcelSheet -Name 'Data' { ExcelCell -Address 'A1' -Value 'Region' } }

Creates a workbook with a worksheet named Data and writes the header “Region”.

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

Add-OfficeExcelSheet [-Content <ScriptBlock>] [-Name <String>] [-PassThru] [-ValidationMode <Sanitize|Strict>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Content ScriptBlock optionalposition: 1pipeline: False: Code to execute inside the worksheet context.
Name String optionalposition: 0pipeline: False: Name of the worksheet to create or reuse. When omitted the last sheet is reused or a default sheet is created.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the ExcelSheet object after execution.
ValidationMode SheetNameValidationMode optionalposition: namedpipeline: Falsevalues: 2: Controls how invalid sheet names are handled.; Possible values: Sanitize, Strict

Outputs

System.Object