SPServices - JQuery Libraries for SharePoint Web Services是一个基于JQuery的开源库,可以到CodePlex上下载:点击打开链接。
这个库可以使开发者更方便的调用SharePoint提供的Web Services,并且全都是客户端代码,不需要在服务端安装,轻巧快捷,同时减少了服务端部署的时间。目前支持SharePoint 2007/2010/2013,是SharePoint开发者的一个不错的选择。
将SPServices集成到SharePoint项目中的方法很简单,在需要使用这个库的页面上引入JQuery和SPServices文件即可。首先到JQuery网站上下载JQuery,这里使用的版本是1.11.1,下载地址:点击打开链接。下载之后我们得到“jquery-1.11.1.min.js”文件。然后下载SPServices文件,下载地址:点击打开链接,这是一个压缩包,其中包含三个文件:license.txt, jquery.SPServices-2014.01.js和jquery.SPServices-2014.01.min.js,我们使用“jquery.SPServices-2014.01.min.js”这个文件。
有了这两个文件,就可以把它们集成到SharePoint项目中,这里使用一个比较常用的方法作为例子(VS2012 + SharePoint2013)。
首先将这两个文件Copy到layouts文件夹下对应的项目文件夹中:
然后在添加一个Applicaiton页面“SPServicesTestPage.aspx”:
在页面中引用这两个文件(如果是SharePoint 2007或者2010环境,需要去掉15):
- <asp:Content ID="PageHead" ContentPlaceHolderID="PlaceHolderAdditionalPageHead" runat="server">
- <script src="/_layouts/15/SharePoint.TestLab.SPServices/jquery-1.11.1.min.js" type="text/javascript"></script>
- <script src="/_layouts/15/SharePoint.TestLab.SPServices/jquery.SPServices-2014.01.min.js" type="text/javascript"></script>
- <script type="text/javascript">
- $(document).ready(function(){
- alert("JQuery is loaded!");
- alert($().SPServices.SPGetCurrentSite());
- });
- </script>
- </asp:Content>
本例中因为js文件和页面文件在同一个文件夹中,所以引用js的方式可以简化为:
- <script src="jquery-1.11.1.min.js" type="text/javascript"></script>
- <script src="jquery.SPServices-2014.01.min.js" type="text/javascript"></script>
引用之后又添加了一段代码来测试是否加载成功。如果成功加载,那么在部署之后,访问这个页面,会弹出两个对话框:
和
第二个对话框中的内容是通过“$().SPServices.SPGetCurrentSite()”方法获取的,这个方法是SPServices提供的。
其实如果不想下载文件,也可以使用CDN的方式,在页面中引用,方法是:
- <asp:Content ID="PageHead" ContentPlaceHolderID="PlaceHolderAdditionalPageHead" runat="server">
- <script src="//code.jquery.com/jquery-1.11.1.min.js" type="text/javascript"></script>
- <script src="//cdnjs.cloudflare.com/ajax/libs/jquery.SPServices/2014.01/jquery.SPServices.min.js" type="text/javascript"></script>
- <script type="text/javascript">
- $(document).ready(function(){
- alert("JQuery is loaded!");
- alert($().SPServices.SPGetCurrentSite());
- });
- </script>
- </asp:Content>
当然还有其他的方法比如把文件放到文档库中然后引用等等就不举例了,将SPServices集成之后就可以开始使用它的提供的强大的功能了,这些功能会在后面陆续介绍。