Copy Webparts From One Page To Another Page

Summary

This sample read Site Url, Source page and destination page from user and then we will copy webparts from source page to destination page

Implementation

• Open Windows PowerShell ISE
• Create a new file
• Write a script as below,
• First, we will read site URL from user and connect to Site.
  • Then we will read source page and destination page from user.
  • And then we will get all the webparts from source page.
  • If webparts will be found then we will add these webparts to destination page.

• PnP PowerShell

$username = "user@domain.onmicrosoft.com"
$password = "********"
$secureStringPwd = $password | ConvertTo-SecureString -AsPlainText -Force 
$Creds = New-Object System.Management.Automation.PSCredential -ArgumentList $username, $secureStringPwd

#Login to SharePoint Site
Function ConnectToSPSite() {
    try {
        $SourceSiteUrl = Read-Host "Please enter source Site URL"
        if ($SourceSiteUrl) {
            Write-Host "Connecting to Site :'$($SourceSiteUrl)'..." -ForegroundColor Yellow  
            Connect-PnPOnline -Url $SourceSiteUrl -Credentials $Creds
            Write-Host "Connection Successfull to site: '$($SourceSiteUrl)'" -ForegroundColor Green              
            GetWebparts
        }
        else {
            Write-Host "Source Site URL is empty" -ForegroundColor Red
        }
    }
    catch {
        Write-Host "Error in connecting to Site:'$($SiteUrl)'" $_.Exception.Message -ForegroundColor Red               
    } 
}

Function GetWebparts {
    try {        
        $PageName = Read-Host "Please enter page name from where you want to copy webparts like 'Home.aspx'"
        if ($PageName) {
            Write-Host "Getting webparts from source page" -ForegroundColor Yellow  
            $page = Get-PnPClientSidePage -Identity $PageName          
            $webParts = $page.Controls  
            $WebpartsCount = $page.Controls.Count
            Write-Host "Found no. of webparts: " $WebpartsCount -ForegroundColor Gray  
            $DestinationPage = Read-Host "Please enter page name where you want to copy webparts like 'Home'"
            if ($WebpartsCount -gt 0) {
                Write-Host "Adding webparts to the page: " $DestinationPage -ForegroundColor Yellow  
                foreach ($wp in $webParts) {
                    try {                        
                        Add-PnPClientSideWebPart -Page $DestinationPage -Component $wp.Title -WebPartProperties $wp.PropertiesJson -Section $wp.Section.Order -Column $wp.Column.LayoutIndex -Order $wp.Order
                    }
                    catch {
                        Write-Host "Error in adding webparts'" $_.Exception.Message -ForegroundColor Red               
                    }
                }
                Write-Host "Added all the webparts" -ForegroundColor Green  
            }
            else {
                Write-Host "No webparts found'"-ForegroundColor Gray               
            }
        }
        else {
            Write-Host "Page name is empty" -ForegroundColor Red
        }
    }
    catch {
        Write-Host "Error in getting webparts from:'$($PageName)'" $_.Exception.Message -ForegroundColor Red               
    } 
}

Function StartProcessing { 
    ConnectToSPSite 
}

StartProcessing

Check out the PnP PowerShell to learn more at: https://aka.ms/pnp/powershell

The way you login into PnP PowerShell has changed please read PnP Management Shell EntraID app is deleted : what should I do ?

Contributors

Author(s)
Chandani Prajapati

Disclaimer

THESE SAMPLES ARE PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.