As part of my upgrade I needed to be able to delete some web parts (closed or open) and close and open some web parts. In many respects this command, gl-setwebpartstate, is basically the twin to the gl-movewebpart command which I recently posted about. In fact, I created that command as a template for this command – the only difference from a code standpoint is that instead of calling MoveWebPart I’m calling either DeleteWebPart, CloseWebPart, or OpenWebPart (based on a user provided parameter). Everything else is exactly the same so once I had the gl-movewebpart command done creating this command took me less than 5 minutes. Below is the bit of code that differs from the gl-movewebpart code (I won’t show the rest as it’s identical to the gl-movewebpart command):
1if (Params["delete"].UserTypedIn)
2 manager.DeleteWebPart(wp);
3else if (Params["close"].UserTypedIn)
4 manager.CloseWebPart(wp);
5else if (Params["open"].UserTypedIn)
6 manager.OpenWebPart(wp);
7
8if (!Params["delete"].UserTypedIn)
9 manager.SaveChanges(wp);
The syntax of the command I created can be seen below.
C:\>stsadm -help gl-setwebpartstate
stsadm -o gl-setwebpartstate
Opens, Closes, Adds, or Deletes a web part on a page.
Parameters:
-url <web part page URL>
{-id <web part ID> | -title <web part title>}
{-delete | -open | -close | -add}
{[-assembly <assembly name>] | [-typename <type name>] | [-webpartfile <web part file if adding>]}
[-zone <zone ID>]
[-zoneindex <zone index>]
{[-properties <comma separated list of key value pairs: "Prop1=Val1,Prop2=Val2">] |
[-propertiesfile <path to a file with xml property settings (<Properties><Property Name="Name1">Value1</Property><Property Name="Name2">Value2</Property></Properties>)>]}
[-publish]
Here’s an example of how to close a web part on a given page:
stsadm -o gl-setwebpartstate -url "http://intranet/hr/pages/default.aspx" -title "Grouped Listings" -close -publish
Update 12/10/2007: I’ve updated this command to now support the adding of web parts to a page. In doing this I also added the ability to set the zone and zone ID of a web part (thus encapsulating the gl-movewebpart command – I needed this in order to know where to add the part to so I figured I’d just allow the user to provide the same information for any other changes). I also added the ability to set properties of the web part. This is done using a comma separated list of key value pairs for simple data or an XML file with any encoded data. Note that only primitive data types are supported so if you try to set a property that requires a complex data type it will error out. Also – if you only wish to set the properties of an existing web part then simply pass in a command that matches the current state of the web part (so if the web part is open already then use the -open parameter and then pass in any desired properties).
Here’s an example of how to add a web part to a page using simple properties:
stsadm -o gl-setwebpartstate -url "http://intranet/testweb1/default.aspx" -title "Table of Contents" -add -assembly "Microsoft.SharePoint.Publishing, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" -typename "Microsoft.SharePoint.Publishing.WebControls.TableOfContentsWebPart" -zone "Left" -zoneindex 0 -properties "ShowPages=false,LevelsToShow=3" -publish
Here’s an example of how to add a web part to a page using an XML file containing properties:
stsadm -o gl-setwebpartstate -url "http://teamsites/pages/default.aspx" -title "I need to…" -add -assembly "Microsoft.SharePoint.Portal, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" -typename "Microsoft.SharePoint.Portal.WebControls.TasksAndToolsWebPart" -zone "MiddleRightZone" -zoneindex 0 -propertiesfile "c:\webpartprops.xml" -publish
The webpartprops.xml file will look like this:
1<Properties>
2 <Property Name="TasksAndToolsWebUrl">/SiteDirectory</Property>
3 <Property Name="FilterFieldValue">Top Tasks</Property>
4 <Property Name="FilterCategory">TasksAndTools</Property>
5 <Property Name="TasksAndToolsListName">Sites</Property>
6 <Property Name="Xsl"><xsl:stylesheet xmlns:x="http://www.w3.org/2001/XMLSchema" version="1.0" exclude-result-prefixes="xsl ddwrt slwrt msxsl" xmlns:ddwrt="http://schemas.microsoft.com/WebParts/v2/DataView/runtime" xmlns:slwrt="http://schemas.microsoft.com/WebParts/v3/SummaryLink/runtime" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:msxsl="urn:schemas-microsoft-com:xslt" xmlns:tnt="urn:schemas-microsoft-com:sharepoint:TasksAndToolsWebPart" > <xsl:param name="tasksAndtools_IsRTL" /> <xsl:param name="tasksAndTools_Width" /> <xsl:template match="/"> <xsl:call-template name="MainTemplate"/> </xsl:template> <xsl:template name="MainTemplate" xmlns:ddwrt="http://schemas.microsoft.com/WebParts/v2/DataView/runtime" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:msxsl="urn:schemas-microsoft-com:xslt"> <xsl:variable name="Rows" select="/dsQueryResponse/NewDataSet/Row"/> <xsl:variable name="RowCount" select="count($Rows)"/> <table border="0" cellpadding="0" cellspacing="0" style="border-collapse:collapse; margin:0px;"> <tr style="margin-top:3px;margin-bottom:1px;height:28px;border:0px;"> <td style="padding-left:4px; white-space:nowrap ;"> <xsl:if test="string-length($tasksAndTools_Width) != 0"> <select id="TasksAndToolsDDID" class="ms-selwidth" style="width:{$tasksAndTools_Width}" size="1" title="Choose a task that you need to perform" > <option selected="true" value="0">Choose task</option> <xsl:call-template name="MainTemplate.body"> <xsl:with-param name="Rows" select="$Rows"/> </xsl:call-template> </select> </xsl:if> <xsl:if test="string-length($tasksAndTools_Width) = 0"> <select id="TasksAndToolsDDID" class="ms-selwidth" size="1" title="Choose a task that you need to perform"> <option selected="true" value="0">Choose task</option> <xsl:call-template name="MainTemplate.body"> <xsl:with-param name="Rows" select="$Rows"/> </xsl:call-template> </select> </xsl:if> </td> <xsl:if test="$tasksAndtools_IsRTL = true()"> <td style="padding-right:5px; padding-left: 14px;white-space:nowrap ;"> <a id="TasksAndToolsGo" accesskey="G" title="Go" href="javascript:TATWP_jumpMenu()"> <img title="Go" alt="Go" border="0" src="/_layouts/images/icongo01RTL.gif" style="border-width:0px;" onmouseover="this.src='/_layouts/images/icongo02RTL.gif'" onmouseout="this.src='/_layouts/images/icongo01RTL.gif'"/> </a> </td> </xsl:if> <xsl:if test="$tasksAndtools_IsRTL = false()"> <td style="padding-right:14px; padding-left: 5px;white-space:nowrap ;"> <a id="TasksAndToolsGo" accesskey="G" title="Go" href="javascript:TATWP_jumpMenu()"> <img title="Go" alt="Go" border="0" src="/_layouts/images/icongo01.gif" style="border-width:0px;" onmouseover="this.src='/_layouts/images/icongo02.gif'" onmouseout="this.src='/_layouts/images/icongo01.gif'" /> </a> </td> </xsl:if> </tr> </table> </xsl:template> <xsl:template name="MainTemplate.body" xmlns:ddwrt="http://schemas.microsoft.com/WebParts/v2/DataView/runtime" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:msxsl="urn:schemas-microsoft-com:xslt"> <xsl:param name="Rows"/> <xsl:for-each select="$Rows"> <xsl:variable name="GroupStyle" select="'auto'"/> <option style="display:{$GroupStyle}" value="{ddwrt:EnsureAllowedProtocol(substring-before(@URL, ‘, ‘))}" > <xsl:value-of select="@Title"/> </option> </xsl:for-each> </xsl:template> </xsl:stylesheet></Property>
7</Properties>
Update 7/8/2008: I’ve added a new parameter, -webpartfile, which can be used to effectively import an exported web part file. Just use it in conjunction with the -add option (do not use the -assembly or -typename parameters). I also adjusted the code so that if it fails to add the web part using the object model it will revert to the web service – this is to account for some web parts (like the KPI web part) that require a valid SPContext object.