Set-SPWebPart

Sets the state of the web part including adding, moving, opening, closing, deleting, or updating web part properties.

Set-SPWebPart -WebPartId <String> -File <SPFilePipeBind> [-Properties [<PropertiesPipeBind>]] -Action <SetWebPartStateAction> [-Zone [<String>]] [-ZoneIndex [<Nullable`1>]] [-Publish [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Set-SPWebPart -WebPartTitle <String> -File <SPFilePipeBind> [-Properties [<PropertiesPipeBind>]] -Action <SetWebPartStateAction> [-Zone [<String>]] [-ZoneIndex [<Nullable`1>]] [-Publish [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Parameters

1

ParameterRequiredTypeDescription
WebPartIdTrueString

The ID of the Web Part to update.

FileTrueSPFilePipeBind

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

PropertiesFalsePropertiesPipeBind

A hash table where each key represents the name of a property whose value should be set to the corresponding key value. Alternatively, provide the path to a file with XML property settings (<Properties><Property Name="Name1">Value1</Property><Property Name="Name2">Value2</Property></Properties>).

ActionTrueSetWebPartStateAction

Specify whether to add, close, open, delete, or update the web part.

ZoneFalseString

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

ZoneIndexFalseNullable`1

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

PublishFalseSwitchParameter

If specified the page will be published after adjusting the Web Part.

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

FileTrueSPFilePipeBind

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

PropertiesFalsePropertiesPipeBind

A hash table where each key represents the name of a property whose value should be set to the corresponding key value. Alternatively, provide the path to a file with XML property settings (<Properties><Property Name="Name1">Value1</Property><Property Name="Name2">Value2</Property></Properties>).

ActionTrueSetWebPartStateAction

Specify whether to add, close, open, delete, or update the web part.

ZoneFalseString

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

ZoneIndexFalseNullable`1

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

PublishFalseSwitchParameter

If specified the page will be published after adjusting the Web Part.

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

Sets the state of the web part including adding, moving, opening, closing, deleting, or updating web part properties.

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:\> Set-SPWebPart -File "http://server_name/pages/default.aspx" -WebPartTitle "My CQWP" -Action Update -Properties @{"ItemXslLink"="/Style Library/MyXsl/ItemStyle.xsl"} -Publish

This sets the ItemXslLink property of a content query web part to point to a custom XSL file.