Add-PnPWebPartToWebPartPage

Adds a web part to a web part page in a specified zone

Syntax

Add-PnPWebPartToWebPartPage
   -Xml <String>
                              -ServerRelativePageUrl <String>
                              -ZoneId <String>
                              -ZoneIndex <Int>
                              [-Web <WebPipeBind>]
                              [-Connection <SPOnlineConnection>]
Add-PnPWebPartToWebPartPage
   -Path <String>
                              -ServerRelativePageUrl <String>
                              -ZoneId <String>
                              -ZoneIndex <Int>
                              [-Web <WebPipeBind>]
                              [-Connection <SPOnlineConnection>]

Examples

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

Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Path "c:\myfiles\listview.webpart" -ZoneId "Header" -ZoneIndex 1

This will add the web part as defined by the XML in the listview.webpart file to the specified page in the specified zone and with the order index of 1

------------------EXAMPLE 2------------------

Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -XML $webpart -ZoneId "Header" -ZoneIndex 1

This will add the web part as defined by the XML in the $webpart variable to the specified page in the specified zone and with the order index of 1

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
-Path

A path to a web part file on a the file system.

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

Server Relative Url of the page to add the web part to.

Type:String
Aliases:PageUrl
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
-Xml

A string containing the XML for the web part.

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

The Zone Id where the web part must be placed

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

The Zone Index where the web part must be placed

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