Cmdlet

Set-OfficeExcelActiveSheet

Aliases: ExcelActiveSheet

Module PSWriteOffice

Aliases

ExcelActiveSheet

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

OfficeIMO.Excel.ExcelSheet System.Management.Automation.PSObject

Source

SetOfficeExcelActiveSheetCommand.cs:20 Edit on GitHub

Sets the worksheet that opens as the active sheet.

Syntax

Set-OfficeExcelActiveSheet [-PassThru] [<CommonParameters>]

Parameter set: Context

Set-OfficeExcelActiveSheet [-PassThru] [-Path] <String> [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]

Parameter set: Path

Set-OfficeExcelActiveSheet -Document <ExcelDocument> [-PassThru] [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Open the workbook on the Summary sheet.

$sheet = Set-OfficeExcelActiveSheet -Path .\Report.xlsx -Sheet Summary -PassThru
Get-OfficeExcelWorksheetView -Path .\Report.xlsx -Sheet $sheet.Name |
    Select-Object SheetName, View, TopLeftCell

Updates workbook view state so spreadsheet applications open on Summary.

Parameters

-PassThru SwitchParameter optional: Emit the activated worksheet.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Workbook path to update.
-Sheet String optionalaliases: WorksheetNamesets: Path, Document: Worksheet name to activate. Defaults to the current sheet inside an ExcelSheet block.
-SheetIndex Int32 optionalsets: Path, Document: Zero-based worksheet index to activate.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document: Workbook to operate on 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.