Set-PnPWebPartProperty

Sets a web part property

Syntax

Set-PnPWebPartProperty
   -ServerRelativePageUrl <String>
                         -Identity <GuidPipeBind>
                         -Key <String>
                         -Value <PSObject>
                         [-Web <WebPipeBind>]
                         [-Connection <SPOnlineConnection>]

Examples

------------------EXAMPLE 1------------------

Set-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914 -Key "Title" -Value "New Title"

Sets the title property of the web part.

Parameters

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Identity

The Guid of the web part

Type:GuidPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Key

Name of a single property to be set

Type:String
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-ServerRelativePageUrl

Full server relative url of the web part page, e.g. /sites/demo/sitepages/home.aspx

Type:String
Aliases:PageUrl
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Value

Value of the property to be set

Type:PSObject
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type:WebPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False