Set-OfficeExcelSheetVisibility.md

external help file	PSWriteOffice-help.xml
Module Name	PSWriteOffice
online version	https://github.com/EvotecIT/PSWriteOffice
schema	2.0.0

Set-OfficeExcelSheetVisibility

SYNOPSIS

Shows or hides a worksheet.

SYNTAX

Context (Default)

Set-OfficeExcelSheetVisibility [-Show] [-Hide] [-PassThru] [<CommonParameters>]

Document

Set-OfficeExcelSheetVisibility -Document <ExcelDocument> [-Sheet <string>] [-SheetIndex <int>] [-Show] [-Hide] [-PassThru] [<CommonParameters>]

DESCRIPTION

Shows or hides a worksheet.

EXAMPLES

EXAMPLE 1

PS>ExcelSheet 'Data' { Set-OfficeExcelSheetVisibility -Hide }

Marks the sheet as hidden.

PARAMETERS

-Document

Workbook to operate on outside the DSL context.

Type: ExcelDocument
Parameter Sets: Document
Aliases: None
Possible values: 

Required: True
Position: named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-Hide

Hide the worksheet.

Type: SwitchParameter
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PassThru

Emit the worksheet after applying visibility.

Type: SwitchParameter
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Sheet

Worksheet name when using Document.

Type: String
Parameter Sets: Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SheetIndex

Worksheet index (0-based) when using Document.

Type: Nullable`1
Parameter Sets: Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Show

Show the worksheet.

Type: SwitchParameter
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

• OfficeIMO.Excel.ExcelDocument

OUTPUTS

• System.Object

RELATED LINKS

• None