Copy-SPWebPart

Copies a web part from one file to another file.

Copy-SPWebPart -WebPartId <String> -SourceFile <SPFilePipeBind> -TargetFile <SPFilePipeBind> [-Publish [<SwitchParameter>]] [-Zone [<String>]] [-ZoneIndex [<Nullable`1>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Copy-SPWebPart -WebPartTitle <String> -SourceFile <SPFilePipeBind> -TargetFile <SPFilePipeBind> [-Publish [<SwitchParameter>]] [-Zone [<String>]] [-ZoneIndex [<Nullable`1>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Parameters

1

ParameterRequiredTypeDescription
WebPartIdTrueString

The ID of the Web Part to copy.

SourceFileTrueSPFilePipeBind

The URL to a web part page or an instance of an SPFile object.

TargetFileTrueSPFilePipeBind

The URL to a web part page or an instance of an SPFile object.

PublishFalseSwitchParameter

If specified the target page will be published after copying the Web Part.

ZoneFalseString

The name of the web part zone to copy the web part to.

ZoneIndexFalseNullable`1

The index within the web part zone to copy the web part to.

AssignmentCollectionFalseSPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

2

ParameterRequiredTypeDescription
WebPartTitleTrueString

The title of the Web Part to copy.

SourceFileTrueSPFilePipeBind

The URL to a web part page or an instance of an SPFile object.

TargetFileTrueSPFilePipeBind

The URL to a web part page or an instance of an SPFile object.

PublishFalseSwitchParameter

If specified the target page will be published after copying the Web Part.

ZoneFalseString

The name of the web part zone to copy the web part to.

ZoneIndexFalseNullable`1

The index within the web part zone to copy the web part to.

AssignmentCollectionFalseSPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Detailed Description

Copies a web part from one file to another file.

Copyright 2016 Falchion Consulting, LLC

> For more information on this cmdlet and others:

> http://blog.falchionconsulting.com/

> Use of this cmdlet is at your own risk.

> Gary Lapointe assumes no liability.

Examples

------------------EXAMPLE------------------

PS C:\> Copy-SPWebPart -SourceFile "http://server_name/pages/default.aspx" -TargetFile "http://server_name/pages/test.aspx" -WebPartTitle "My Web Part" -Publish

This example replaces all instances of the web part who's class name is ContentByQueryWebPart with the web part who's class name is MyContentByQueryWebPart.