Cmdlet

Add-OfficeExcelSheet

Aliases: ExcelSheet

Module: PSWriteOffice
Aliases: ExcelSheet
Inputs: OfficeIMO.Excel.ExcelDocument
Outputs: OfficeIMO.Excel.ExcelSheet
Source: AddOfficeExcelSheetCommand.cs:26 Edit on GitHub

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

Syntax

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

Parameter set: Context

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

Parameter set: Document

Description

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

Examples

Create a sheet named Data.

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”.

Add a worksheet through the workbook pipeline.

$sheet = $workbook | Add-OfficeExcelSheet -Name 'Data' -PassThru
$sheet | Set-OfficeExcelCell -Address A1 -Value 'Region'

Returns the worksheet so subsequent commands can target it directly.

Parameters

-Content ScriptBlock optionalposition: 1: Code to execute inside the worksheet context.
-Name String optionalposition: 0: Name of the worksheet to create or reuse. When omitted the last sheet is reused or a default sheet is created.
-PassThru SwitchParameter optional: Emit the ExcelSheet object after execution.
-ValidationMode ExcelSheetNameValidationMode optional: Controls how invalid sheet names are handled.; Possible values: Sanitize, Strict
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document: Workbook that will receive the worksheet.

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.