Rename-SLWorkSheet


Synopsis

Renames a worksheet.

Syntax

Description

Renames a worksheet..Only one worksheet can be renamed at a time.
If you want to rename multiple worksheets use a looping construct.

Parameters

-WorkBookInstance

Instance of an excel document that can be used for editing.

Required? True
Position? 0
Default value  
Accept pipeline input? true (ByValue)
Accept wildcard characters? False

-WorkSheetName

Name of the Worksheet to be renamed.

Required? True
Position? 1
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-NeWworkSheetName

New worksheetname.

Required? True
Position? 2
Default value  
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? False

This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

Inputs

String

SpreadsheetLight.SLDocument

Outputs

SpreadsheetLight.SLDocument

Notes

Examples

Example 1

MyfirstDoc is piped to Rename-SLWorkSheet with sheet2 being renamed as Sheet2_renamed.

Related links