SharePoint 2010开发实例精选——通过客户端对象模型删除页面上的Web部件
下面的例子是在控制台应用程序中使用客户端对象模型,为了在控制台程序中使用ClientContext,我们需要添加两个dll引用到我们的项目中。Microsoft.SharePoint.Client.dll和Microsoft.SharePoint.Client.Runtime.dll。:
public static void DeleteWP() { ClientContext ctx = new ClientContext("http://sp2010u/it"); Web oWeb = ctx.Web; File oFile = oWeb.GetFileByServerRelativeUrl("/it/SitePages/Home.aspx"); LimitedWebPartManager limitedWebPartManager = oFile.GetLimitedWebPartManager(PersonalizationScope.Shared); ctx.Load(limitedWebPartManager.WebParts); ctx.ExecuteQuery(); if (limitedWebPartManager.WebParts.Count == 0) throw new Exception("未找到 web 部件");
//获取添加到该页面上的第二个Web部件 WebPartDefinition oWebPartDef = limitedWebPartManager.WebParts[1]; //删除该webPart oWebPartDef.DeleteWebPart(); ctx.ExecuteQuery(); Console.WriteLine("完成!"); }
如果是用javascript实现的话,你需要两个函数:一个用于在页面上查询该Web部件,另一个用于删除一个Web部件。下面的代码可以放在一个HTML表单Web部件中运行(直接贴在WebPart属性->源编辑器中)
<script type="text/ecmascript" language="ecmascript"> var targetWeb; var clientContext; function runCode() { clientContext = new SP.ClientContext("/it"); targetWeb = clientContext.get_web(); var oFile = targetWeb.getFileByServerRelativeUrl("/it/SitePages/Home.aspx"); this.limitedWebPartManager = oFile.getLimitedWebPartManager(SP.WebParts.PersonalizationScope.shared); this.clientContext.load(this.limitedWebPartManager.get_webParts()); clientContext.executeQueryAsync(Function.createDelegate(this, this.deleteWebPart), Function.createDelegate(this, this.onFailedCallback)); } function deleteWebPart() { if (this.limitedWebPartManager.get_webParts().get_count() == 0) { alert("未找到 web 部件"); return; } //获取添加到该页面上的第二个WebPart var oWebPartDef = this.limitedWebPartManager.get_webParts().get_item(1); oWebPartDef.deleteWebPart(); this.clientContext.executeQueryAsync(Function.createDelegate(this, this.onSucceededCallback),Function.createDelegate(this, this.onFailedCallback)); } function onSucceededCallback(sender, args) { alert("完成!"); } function onFailedCallback(sender, args) { alert('请求失败. \nError: ' + args.get_message() + '\nStackTrace: ' + args.get_stackTrace()); } </script> <input id="Button1" type="button" value="运行代码" onclick="runCode()" />
看一下网页中的运行效果:
原始页面:
在“每日一句”WebPart左侧再添加一个产品信息业务数据列表WebPart:
在根网站的某个页面上,添加了包含删除WebPart代码的HTML表单WebPart,用于删除上面页面上刚刚加的产品信息WebPart:
点击“运行代码”按钮,弹出成功消息框:
再回到原先的页面上,发现WebPart已经被删除了。
参考资料
Delete WebPart from Page Client object model SharePoint 2010