Get Started

API Reference

Cmdlet

Set-OfficeExcelActiveSheet

Aliases: ExcelActiveSheet
Namespace PSWriteOffice
Aliases
ExcelActiveSheet
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
OfficeIMO.Excel.ExcelSheet System.Management.Automation.PSObject
Source
Sources/PSWriteOffice/Cmdlets/Excel/SetOfficeExcelActiveSheetCommand.cs:17 Edit on GitHub

Sets the worksheet that opens as the active sheet.

Remarks

Sets the worksheet that opens as the active sheet.

Examples

Authored help example

Open the workbook on the Summary sheet.

PS>


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

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

Set-OfficeExcelActiveSheet [-PassThru] [<CommonParameters>]
#
Parameter set: Context

Parameters

PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the activated worksheet.

Outputs

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

Set-OfficeExcelActiveSheet -InputPath <String> [-PassThru] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]
#
Parameter set: Path

Parameters

InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path
Workbook path to update.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the activated worksheet.
Sheet String optionalposition: namedpipeline: Falsealiases: WorksheetName
Worksheet name to activate. Defaults to the current sheet inside an ExcelSheet block.
SheetIndex Nullable`1 optionalposition: namedpipeline: False
Zero-based worksheet index to activate.

Outputs

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

Set-OfficeExcelActiveSheet -Document <ExcelDocument> [-PassThru] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]
#
Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook to operate on outside the DSL context.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the activated worksheet.
Sheet String optionalposition: namedpipeline: Falsealiases: WorksheetName
Worksheet name to activate. Defaults to the current sheet inside an ExcelSheet block.
SheetIndex Nullable`1 optionalposition: namedpipeline: False
Zero-based worksheet index to activate.

Outputs

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