SharePoint Pals
 | Sign In
How to Add Script Editor WebParts to SharePoint 2013 Publishing Pages using PowerShell.
by Sathish Nadarajan 29 Aug 2015
Author
SharePoint MVP
Visits   
Today  :   7     Total  :    8312

Sometime back, we saw how to create the pages using powershell and how to Add some of the custom web parts to the Created Pages. Recently I met with another interesting requirement like, we need to add some script editor webpart to the publishing pages using PowerShell and the Script editor webpart should be inserted with some scripts as well.

Let us see how to do that. Here I am using a CSV File to Add the Script Editor WebParts in to the Page.

First let us see the CSV File Inputs.

PageURL

Script

Page1.aspx

<script>
//Any Script Here
</script>

Page2.aspx

<script>
//Any Script Here
</script>

And the Script would be

 ##================================================================================================
 ## Description	: Add the Script Editor WebParts to the Newly Created Pages based onthe Input from the CSV
 ## Author		: Sathish Nadarajan
 ## Date			: 13-Aug-2015
 ##================================================================================================
 
 # ============================================ Setup Input Paths ===========================================================
 
  
 $Host.UI.RawUI.WindowTitle = "-- Add Script Editor WebParts --"
 
 $StartDate = Get-Date
 Write-Host -ForegroundColor White "------------------------------------"
 Write-Host -ForegroundColor White "| Add Script Editor WebParts |"
 Write-Host -ForegroundColor White "| Started on: $StartDate |"
 Write-Host -ForegroundColor White "------------------------------------"
 
 $LogTime = Get-Date -Format yyyy-MM-dd_hh-mm
 $LogFile = ".\AddWebParts-$LogTime.rtf"
 
 #start-transcript $logfile
 
 $scriptBase = split-path $SCRIPT:MyInvocation.MyCommand.Path -parent
 Set-Location $scriptBase
 
 $ErrorActionPreference = "Stop"
 
 function AddPowerShellSnapin()
 {
     try
     {
         Write-Host "Adding PowerShell Snap-in" -ForegroundColor Green
         # Try to get the PowerShell Snappin.  If not, then adding the PowerShell snappin on the Catch Block
         Get-PSSnapin "Microsoft.SharePoint.PowerShell" 
     }
     catch
     {
         if($Error[0].Exception.Message.Contains("No Windows PowerShell snap-ins matching the pattern 'Microsoft.SharePoint.PowerShell' were found"))
         {
             Add-PSSnapin "Microsoft.SharePoint.PowerShell"
         }
     }
     Write-Host "Finished Adding PowerShell Snap-in" -ForegroundColor Green
 
 }
 
 function AddScriptEditorWebPart($webURL, $pageUrl, $script)
 {  
     $webPartProperty_Visible = $true  
     $web = get-spweb $webURL  
     $defaultPage = $web.GetFile("Pages/" + $pageUrl)  
   
     if($defaultPage.ListItem.File.CheckedOutByUser -eq $null)
     {           
         $defaultPage.CheckOut()
         # Get the LimitedWebPartManager  
         $webpartmanager=$defaultPage.GetLimitedWebPartManager([System.Web.UI.WebControls.WebParts.PersonalizationScope]::Shared)  
   
         #Create fancy GUID  
         $lvwpGuid1 = [System.Guid]::NewGuid().ToString()  
         $lvwpKey = "g_" + $lvwpGuid1.Replace("-","_")  
   
         # Instantiate wp  
         $lvwp =New-Object Microsoft.SharePoint.WebPartPages.ScriptEditorWebPart   
         $lvwp.ID = $lvwpKey  
         $code = "$"  
         $lvwp.Content =  $script
   
         $lvwp.Title = "Script Editor WebPart"   
         $lvwp.Visible = $webPartProperty_Visible   
         $lvwp.ChromeType = "None"  
         $lvwp.HorizontalAlign = "Center"   
         # Add the web part  
         $webpartmanager.AddWebPart($lvwp, "Main", 0);  
 
 
     # Check in the Page with Comments
                 $defaultPage.CheckIn("Checkin by PowerShell")
         
                 # Publish the Page With Comments
                 $defaultPage.Publish("Published by PowerShell")
                 }
 
 
   
     # Update the web  
     $web.Update();  
    
     write-host "success"  
     $web.Dispose()    
     write-host "Done"  
 }  
 
  
 try
 {
 
     AddPowerShellSnapin
     
     $ScriptEditorWebPartDetailsCSV = $scriptBase + "\data\Excel Data\" + "ScriptEditorWebPartDetails.csv"
 
     import-csv $ScriptEditorWebPartDetailsCSV | where {
         AddScriptEditorWebPart "https://MySiteCollection" $_.PageURL $_.Script
  
     }
 
     
 
      
 
     Write-Host "Script Execution Completed Successfully" -ForegroundColor Green 
 }
 catch
 {
     Write-Host "Custom Exception Happened on Main : " + $Error[0].Exception.Message -ForegroundColor Red  
 }
 

Make sure that the pages were not Checked Out by any other persons. If It is checked out, then the script will not consider that page. The webparts will not be added.

Apart from that, the script is very straight forward and nothing much to explain on it.

Download the CSV And the SCRIPT HERE

Happy Coding,

Sathish Nadarajan.

blog comments powered by Disqus

SharePoint Pals

Pals
SharePoint Pals, a community portal for SharePoint developers, Administrators and End Users. Let's join hands and share the point together.
Read this on mobile

Training

Angular Js Training In Chennai
Advanced Angular Js training with real world developer scenarios
Angular Js, Web Api and Ionic for .Net Developers
All in one client side application development for .Net developers
Angular Js For SharePoint Developers
Get ready for the future. Its no more just C#

Get Connected

SharePoint Resources

SharePoint 2013 and 2010 Web Parts
Free Web Parts with Source Code for SharePoint Community




SharePoint 2013 Books and Tutorials
Collection of free SharePoint 2013 books and tutorials (eBooks, pdfs)

Supported By

Contribute your article and be eligible for a one month Free Subscription for Plural Sight. The Author of the most popular New Article (published in the previous month) will be awarded with a Free One month Plural Sight Subscription. Article can be sent to articles@sharepointpals.com in a word document.

Related Resources

Recent Tweets

Twitter January 15, 00:25
How To Enable Target Value And Actual Value In #D3 Gauge Chart https://t.co/VxSi4QnNrC

Twitter January 15, 00:24
How To Open #SharePoint List Hyperlink Column In Modal #Popup Window https://t.co/EQ7HkoZDkX

Twitter January 15, 00:24
Quick Introduction To #Asp.NetCore And It’s Features https://t.co/zAXObHCFpH

Twitter January 15, 00:22
How To Configure #PerformancePoint Services To Use Secure Store In #SharePoint 2013 https://t.co/LEwnUoI7EY

Twitter January 15, 00:21
How To Block Or Disable #Office365 Services https://t.co/Yvp2VPFIRP

Follow us @SharePointPals
Note: For Customization and Configuration, CheckOutRecent Tweets Documentation