Add/Remove Custom Ribbon Items on SharePoint List Using CSOM PowerShell

In this post, you will learn how to add or remove custom ribbon items (user actions) on SharePoint list using CSOM Powershell on SharePoint 2013 / SharePoint 2016 / SharePoint online sites.

Steps Involved:

The following prerequisites need to be executed before going for any operations using CSOM PowerShell on SharePoint sites.

1. Add the references using the Add-Type command with the necessary reference paths. The necessary references are Client.dll, Client.Runtime.dll and publishing.dll.
   
   Add-Type -Path
   
   "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll"
   
   Add-Type -Path
   
   "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll"
   
   Add-Type -Path
   
   "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Publishing.dll"
2. Initialize client context object with the site URL.
   
   1. $siteURL = ""  
   2. $ctx = New-Object Microsoft.SharePoint.Client.ClientContext($siteURL)  
3. If you are trying to access SharePoint Online site then you need to setup the site credentials with credentials parameter and load it to the client context. 
   
   1. #Not required for on premise site - Start  
   2. $userId = ""  
   3. $pwd = Read-Host -Prompt "Enter password" -AsSecureString  
   4. $creds = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($userId, $pwd)  
   5. $ctx.credentials = $creds  
   6. #Not required for on premise site - End  
4. If you are trying to access the SharePoint on premise site then the credentials parameter is not required to be set to the context but you need to run the code on the respective SharePoint Server or you need to pass the network credentials and set the context.
   
   1. #Credentials for on premise site - Start  
   2. $pwd = Read-Host -Prompt "Enter password" -AsSecureString  
   3. $creds = New-Object System.Net.NetworkCredential("domain\userid", $pwd)  
   4. $ctx.Credentials = $creds  
   5. #Credentials for on premise site - End  

Add Custom Ribbon Items (User Actions) to List:

We will see how we can add the custom ribbon items (actions) to the SharePoint list.

• Get the existing user action collection. Access the web and get the existing user actions using UserCustomActions property. Load and execute the property.
  
  1. $web = $ctx.Site.RootWeb  
  2. $userActions = $web.UserCustomActions  
  3. $ctx.Load($userActions)   
  4. $ctx.ExecuteQuery()   
• Then to the user actions collection, add new custom action. The necessary parameters for new action are registration id, title, registration type and location.
• Registration Id - Corresponding List template id to add the user action. For example, here 100 denotes the custom list templates.
• Registration Type -  Denotes association type.
• location - Custom Action location.
  
  1. $newRibbonItem = $userActions.Add()  
  2. $newRibbonItem.RegistrationId = "100"  
  3. $newRibbonItem.Title = "Custom Ribbon"  
  4. $newRibbonItem.RegistrationType = [Microsoft.SharePoint.Client.UserCustomActionRegistrationType]::List  
  5. $newRibbonItem.Location = "CommandUI.Ribbon"  
• Build the xml for the new definition with correspoding handler. In this case, I have considered button as a custom action and associated alert box to the action. You can build your own logic on command action parameter. Location in the xml denotes the place where item will be placed.
• Update and execute the query.
  
  1. $ribbonUI = '<CommandUIExtension>  
  2.                     <CommandUIDefinitions>  
  3.                         <CommandUIDefinition Location="Ribbon.List.Actions.Controls._children">  
  4.                             <Button Id="Ribbon.List.Actions.ShowAlert" Alt="Show Alert" Sequence="100"  
  5.                                  Command="ShowRibbonAlert"  
  6.                                  LabelText="Custom Alert"  
  7.                                  TemplateAlias="o1"  
  8.                                  Image32by32="_layouts/15/images/alertme.png"  
  9.                                  Image16by16="_layouts/15/images/alertme.png" />  
  10.                        </CommandUIDefinition>  
  11.                     </CommandUIDefinitions>  
  12.                     <CommandUIHandlers>  
  13.                         <CommandUIHandler Command="ShowRibbonAlert"  
  14.                              CommandAction="javascript:alert(''hi'');"/>  
  15.                     </CommandUIHandlers>  
  16.                 </CommandUIExtension >'  
  17.   
  18. $newRibbonItem.CommandUIExtension = $ribbonUI  
  19. $newRibbonItem.Update()  
  20. $ctx.Load($newRibbonItem)  
  21. $ctx.ExecuteQuery()  

After executing the above steps you can find the new ribbon item on the sharepoint custom list (list tab). The following snapshot depicts the custom ribbon action.

Remove Custom Ribbon Items (User Actions) from List:

We will see how we can remove the custom ribbon items (actions) from the SharePoint list.

• Get the existing user action collection. Access the web and get the existing user actions using UserCustomActions property. Load and execute the property.
  
  1. $web = $ctx.Site.RootWeb  
  2. $userActions = $web.UserCustomActions  
  3. $ctx.Load($userActions)   
  4. $ctx.ExecuteQuery()   
• Delete items
• If items exists, use filter conditions and filter the ribbon items and assign items in to an array to delete. (Multiple items can not be deleted from the result variable, since the items are present in the enumeration variable. So we are assigning it to array and deleting the items or actions)
• From the array, delete the items and finally execute the query.
  
  1. $itemsToDelete = @()  
  2. if($userActions.Count -le 0){  
  3.     Write-Host "No Ribbon Items found to delete"  
  4. }  
  5. else{  
  6.     foreach($userAction in $userActions){  
  7.         $itemsToDelete += $userAction                  
  8.     }  
  9.     foreach($item in $itemsToDelete){  
  10.         Write-Host "Deleting Ribbon Item : " $item.Title  
  11.         $item.DeleteObject()  
  12.     }  
  13.     $ctx.ExecuteQuery()  
  14. }  

The above operation deletes all the custom ribbon items from the site. You can filter out to the exact ribbon item from the for each loop and delete the item(s).

Upload And Set Custom Master Page To Site Using CSOM PowerShell On SharePoint

In this article post, you will learn how to upload custom master page to master page gallery and apply custom master pages to the site using CSOM Powershell on SharePoint 2013 / SharePoint 2016 / SharePoint online sites.

Steps Involved:

The following prerequisites need to be executed before going for any operations using CSOM PowerShell on SharePoint sites.

1. Add the references using the Add-Type command with the necessary reference paths. The necessary references are Microsoft.SharePoint.Client.dll, Microsoft.SharePoint.Client.Runtime.dll.
   
   1. Add-Type -Path "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll"  
   2. Add-Type -Path "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll"  
2. Initialize client context object with the site URL.
   
   1. $siteURL = ""  
   2. $ctx = New-Object Microsoft.SharePoint.Client.ClientContext($siteURL)  
3. If you are trying to access SharePoint Online site then you need to setup the site credentials with credentials parameter and load it to the client context. 
   
   1. #Not required for on premise site - Start  
   2. $userId = "abc@abc.onmicrosoft.com"  
   3. $pwd = Read-Host -Prompt "Enter password" -AsSecureString  
   4. $creds = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($userId, $pwd)  
   5. $ctx.credentials = $creds  
   6. #Not required for on premise site - End  
4. If you are trying to access the SharePoint on premise site then the credentials parameter is not required to be set to the context but you need to run the code on the respective SharePoint Server or you need to pass the network credentials and set the context.
   
   1. #Credentials for on premise site - Start  
   2. $pwd = Read-Host -Prompt "Enter password" -AsSecureString  
   3. $creds = New-Object System.Net.NetworkCredential("domain\userid", $pwd)  
   4. $ctx.Credentials = $creds  
   5. #Credentials for on premise site - End  

Upload and Apply Master Page:

We will see how we can upload the master page file from local system to master page gallery and apply the uploaded master page to the site.

• Get the master page from local.
• Get the master page file local system URL and access the properties of master page file using Get-ChildItem method.
• Then read the master page content using ReadAllBytes method and initialize the content to variable ($fileBytes).
  
  1. $pageFilePath = "D:\custom.master"  
  2. $pageFilePath = Get-ChildItem $pageFilePath  
  3. $fileBytes = [System.IO.File]::ReadAllBytes($pageFilePath.FullName)  
• Set the master page file details.
• Initialize file creation information object to set the master page file properties to be uploaded. 
• To the object created, set the necessary parameters like URL, content. Overwrite parameter can be used to force write the file to the server.
  
  1.   
  2. $newFileInfo = New-Object Microsoft.SharePoint.Client.FileCreationInformation  
  3. $newFileInfo.Url = $pageFilePath.Name  
  4. $newFileInfo.Content = $fileBytes  
  5. $newFileInfo.Overwrite = $true  
• Access the folder and add the master page.
• Using the context, access the web. It should be root web since master page gallery is present at the top level site.
• Then access the master page gallery folder using web and GetByTitle method.
• From the web, get the source list and destination list using the list names. Then access the appropriate folder and the files method to add our new master page. Add new file creation information object created above. Load and execute the query.
  
  1. $web = $ctx.Site.RootWeb  
  2. $folder = $web.Lists.GetByTitle("Master Page Gallery")  
  3. $masterPage = $folder.RootFolder.Files.Add($newFileInfo)  
  4. $ctx.Load($web)  
  5. $ctx.Load($masterPage)  
  6. $ctx.ExecuteQuery()  
• Publish as major version.
• Then to publish the master page, we need to check out the file. Check out is required since the master page is neither checked out nor checked in as major version when the master page is uploaded. Load and execute the query for check out operation.
•  Then check in the master page with comments and check in type. Check in type should be major version.
  1. #Check Out  
  2. $masterPage.CheckOut()  
  3. $ctx.Load($masterPage)  
  4. $ctx.ExecuteQuery()  
  5. #Check In and Publish  
  6. $masterPage.CheckIn("Majorversion checkin",[Microsoft.SharePoint.Client.CheckinType]::MajorCheckIn)  
  7. $ctx.Load($masterPage)  
  8. $ctx.ExecuteQuery()  
• We have successfully uploaded the master page. No we will apply the master page to the site. 
• From the web object, access the custom master url property and set the master page relative url. 
• To set master page for custom pages, use CustomMasterUrl property. 
• To set master page for system master pages, use MasterUrl property. 
• After setting the properties, update the web object. Then load and execute the web object with the context.
  
  1. $web.CustomMasterUrl = $masterPage.ServerRelativeUrl  
  2. $web.MasterUrl = $masterPage.ServerRelativeUrl  
  3. $web.Update()  
  4. $ctx.Load($web)  
  5. $ctx.ExecuteQuery()  

The above steps will help us in uploading and setting the master page. The article focused on setting master pages for root level sites. If the master page needs to be set for subsite, then corresponding web object needs to be created before applying master page.

Retrieve File Version Properties And Version Author Details On SharePoint Using CSOM PowerShell

In this article, you will learn how to retrieve version properties and version author details of files present on SharePoint folders programmatically using CSOM with PowerShell on SharePoint 2013 / SharePoint 2016 / SharePoint online.

Steps Involved:

The following prerequisites need to be executed before going for any operations using CSOM PowerShell on SharePoint sites.

1. Add the references using the Add-Type command with the necessary reference paths. The necessary references are Microsoft.SharePoint.Client.dll, Microsoft.SharePoint.Client.Runtime.dll.
   
   Add-Type –
   
   Path "C:\Program Files\SharePoint Online Management Shell\Microsoft.Online.SharePoint.PowerShell\Microsoft.SharePoint.Client.dll" 
   
   Add-Type –
   
   Path "C:\Program Files\SharePoint Online Management Shell\Microsoft.Online.SharePoint.PowerShell\Microsoft.SharePoint.Client.Runtime.dll" 
2. Initialize client context object with the site URL.
   
   1. $siteURL = ""  
   2. $ctx = New-Object Microsoft.SharePoint.Client.ClientContext($siteURL)  
3. If you are trying to access a SharePoint Online site then you need to set up the site credentials with the credentials parameter and load it to the client context. 
   
   1. #Not required for on premise site - Start  
   2. $userId = ""  
   3. $pwd = Read-Host -Prompt "Enter password" -AsSecureString  
   4. $creds = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($userId, $pwd)  
   5. $ctx.credentials = $creds  
   6. #Not required for on premise site - End  
4. If you are trying to access the SharePoint on premise site then the credentials parameter is not required to be set to the context but you need to run the code on the respective SharePoint Server or you need to pass the network credentials and set the context.
   
   1. #Credentials for on premise site - Start    
   2. $pwd = Read-Host -Prompt "Enter password" -AsSecureString    
   3. $creds = New-Object System.Net.NetworkCredential("domain\userid", $pwd)    
   4. $ctx.Credentials = $creds    
   5. #Credentials for on premise site - End  

Retrieve File Versions:

• Initialize the web object using the context and url.
• Retrieve the folder using the web object and folder title.
• Create caml query object and assign query xml to get the necessary file from the folder.
• Get items with GetItems method using the above query.
  
  1. web = $ctx.Site.OpenWeb("/")  
  2. $folder = $web.Lists.GetByTitle("Documents")  
  3. $query = "<View><Query><Where><Eq><FieldRef Name='Title'/><Value Type='Text'>filename</Value></Eq></Where></Query></View>"  
  4. $camlQuery = New-Object Microsoft.SharePoint.Client.CamlQuery  
  5. $camlQuery.ViewXml = $query  
  6. $items = $folder.GetItems($camlQuery)  
  7. #$items = $folder.GetItems([Microsoft.SharePoint.Client.CamlQuery]::CreateAllItemsQuery())  
  8. $ctx.Load($items)  
  9. $ctx.ExecuteQuery()  
• From the items collections, take the first item and get the necessary details. You can also use foreach loop to see information about multiple files.
• Access the file, and then file versions. Load the file and version objects, and execute the query.
  
  1. $item = $items[0]  
  2. $file = $item.File  
  3. $versions = $file.Versions  
  4. $ctx.Load($file)  
  5. $ctx.Load($versions)  
  6. $ctx.ExecuteQuery()  
  7.   
  8. Write-Host $item["Title"] "Version Details"  
• Then using foreach loop, get each and every version information. The properties which can be accessed are version label, file URL, created time, version id, current version flag, version file size, version comment, and author details.
• To get the version author details, load the author object and execute with context to get information about author. The author details which can be accessed are name, email id, and login id.
  
  1. foreach($version in $versions){  
  2.     $ctx.Load($version)  
  3.     $ctx.ExecuteQuery()  
  4.     Write-Host "--------------------------------------------------------"              
  5.     Write-Host "Version Label      : " $version.VersionLabel              
  6.     Write-Host "Version File URL   : " $version.Url  
  7.     Write-Host "Version Created On : " $version.Created       
  8.       
  9.     Write-Host "Version ID         : " $version.ID  
  10.     Write-Host "Current Version?   : " $version.IsCurrentVersion  
  11.     Write-Host "Version File Size  : " $version.Size  
  12.     Write-Host "Version Comment    : " $version.CheckInComment  
  13.     $modifiedBy = $version.CreatedBy  
  14.     $ctx.Load($modifiedBy)  
  15.     $ctx.ExecuteQuery()  
  16.     Write-Host "File Modified By : "   
  17.     Write-Host $modifiedBy.Title  
  18.     Write-Host $modifiedBy.Email  
  19.     Write-Host $modifiedBy.LoginName  
  20.     Write-Host "--------------------------------------------------------"  
  21. }