Copy-OfficeExcelWorkbook

Aliases: ExcelPackageCopy, ExcelWorkbookCopy

Namespace PSWriteOffice

Aliases

ExcelPackageCopy ExcelWorkbookCopy

Inputs

None

Outputs

System.IO.FileInfo

Source

Sources/PSWriteOffice/Cmdlets/Excel/CopyOfficeExcelWorkbookCommand.cs:16 Edit on GitHub

Copies a workbook package while preserving package parts.

Remarks

Copies a workbook package while preserving package parts.

Examples

Authored help example

Copy a workbook package and return the copied file.

PS>


$copy = Copy-OfficeExcelWorkbook -Path .\Template.xlsx -DestinationPath .\Report.xlsx -Force -PassThru
            Test-OfficeExcelWorkbook -Path $copy.FullName -SkipOpenXmlValidation |
                Select-Object Passed, WorksheetCount

Copies the workbook package and normalizes the workbook content type for the destination extension.

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

Copy-OfficeExcelWorkbook -DestinationPath <String> -FilePath <String> [-Force] [-PassThru] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

DestinationPath String requiredposition: 1pipeline: Falsealiases: Destination, OutputPath, TargetPath: Destination workbook path.
FilePath String requiredposition: 0pipeline: Falsealiases: InputPath, Path, SourcePath: Source workbook or template package path.
Force SwitchParameter optionalposition: namedpipeline: False: Replace an existing destination workbook.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit a FileInfo for the copied workbook.

Outputs

System.IO.FileInfo