【转】2.1 SharePoint服务器端对象模型 之 访问网站和列表数据(Part 1)

 

本节将会介绍SharePoint中最为常用的一些对象模型,以及如何使用这些对象模型来访问和操作网站中的数据。几乎所有的SharePoint服务器端开发都会涉及到这些内容,因此应着重掌握本节中所介绍的基本对象模型的使用方法。由于篇幅所限,在介绍每种对象的时候只能阐述一些最为常用和重要的属性及方法,以及一些容易混淆或出错的内容。更加完整的属性、方法的定义、介绍和代码示例片段,请参考SDK中类库索引中相关章节。

网站中一些常用对象的结构大概如下图所示(从SharePoint 2003起,这部分内容在结构上未曾发生根本性的变动):

  

(一)网站集(SPSite)和网站(SPWeb)

网站是SharePoint基本对象模型之一,由于SharePoint的数据基本上全部都容纳在网站中,因此绝大多数的SharePoint程序都要先从获取网站开始。

SPSite 对应的是站点集 (sitecollection),站点集只能总管理中心创建, 从某种程度上来说,也可以理解为根站点;
SPWeb对应的是站点(Site), 站点是从当前站点创建的,站点下面还可以包括站点;
如果你是学习开发,那么这段代码是你常用的:
using(SPSite oSiteCollection = new SPSite("http://Server_Name"))
{
    using(SPWeb oWebsite = oSiteCollection.OpenWeb("Website_URL"))
    {
        SPList list=oWebsite.Lists["mylist"];
  ...
    }
}
更多的内容请参考 SDK:http://msdn.microsoft.com/zh-cn/library/microsoft.sharepoint.spsite.aspx

1、网站集和网站的关系

网站集(Site Collection)顾名思义,是网站的集合,每个网站集中必须有一个顶级网站(或称为首要网站),而每个网站可以有0至多个子网站,从而构成一棵网站结构树,在这棵树上的所有网站构成了整个网站集。在SharePoint中,网站集几乎只是一个被架空的概念,其作用只是将一个相对完整的整体性应用集中组织起来,控制应用中的母版页、Web部件、网站集功能等配置。网站集这个本身不储存任何数据,诸如Web部件、母版页、列表模板、网站模板、网站集解决方案等均存储在网站集的顶级网站中。在SharePoint对象模型中,网站集使用SPSite对象表示,SPSiteCollection(SPSiteCollection包含在Microsoft.SharePoint.Administration这个命名空间中,而本节涉及到的其他类均包含在Microsoft.SharePoint命名空间中)表示网站集的集合。

网站是SharePoint中最经常使用到的对象模型之一,网站中包含的列表、文档库、文件等内容都是在SharePoint开发过程中最经常涉及到的对象。网站使用SPWeb对象表示,SPWebCollection表示网站的集合。请注意在对象模型中“网站的集合”(SPWebCollection)与“网站集”(SPSite)这几个概念的关系和区别。

 

2、网站集的获取

在控制台程序等运行在服务器上的客户端程序中,由于没有IIS的上下文(Context)环境,必须要通过绝对路径获取网站集对象,再获得其中的网站对象。

网站集的获取使用SPSite的构造函数进行,一般来说,经常使用的一个重载如下(假设我们的网站地址为:http://sp2010/book,一个子网站):

   1: SPSite site = new SPSite("http://sp2010/book");

在该构造函数中,必须要使用完整的绝对Url路径,但该Url不一定要限制为网站的根路径,可以为该网站下的任何一个路径(甚至是不存在的文件地址),例如使用Url:“http://sp2010/book/chapters/part1/ch02.docx”作为参数,同样可以返回同一个网站集,即使后面的文档库、文件夹或文件都不存在也没有关系(但并不建议这样使用)。

 

3、网站的获取

当获取到一个网站集的SPSite对象之后,有三种方式获取到其中的网站:(1)RootWeb属性;(2)AllWebs属性;(3)OpenWeb方法。

(1)RootWeb属性返回网站集中的根网站,即顶级网站。

(2)AllWebs属性是SPWebCollection类型,返回网站集中的所有网站。当要获取到其中某一个网站的时候,可以使用3种索引器:

  • AllWebs[idx]:int型索引器,根据下标顺序获取,几乎很少使用这种方式;
  • AllWebs[id]:Guid型索引器,根据网站Guid获取;
  • AllWebs[url]:string型索引器,根据网站的相对路径(相对根网站的路径)获取。

(3)OpenWeb方法按照参数类型不同的重载,也有如下的使用方式:

  • OpenWeb():无参数。返回构造SPSite时所使用的Url所对应的网站,这是一种比较常用的方法,如果使用的是顶级网站的Url构造SPSite,则该方法返回的就是顶级网站;如果使用的是子网站的Url构造SPSite,则该方法返回的就是相应的子网站。
  • OpenWeb(Guid id):使用网站的Guid返回网站。
  • OpenWeb(string url):使用网站的相对路径(相对服务器路径或相对顶级网站的路径)返回网站。

例如,可以使用如下的方法来获取网站:

   1: SPSite site1 = new SPSite("http://sp2010/book");
   2: SPWeb web1 = site1.OpenWeb(),
   3:       theSameAsWeb1 = site1.AllWebs["book"];
   4:  
   5: SPSite site2 = new SPSite("http://sp2010");
   6: SPWeb web2 = site2.OpenWeb(),
   7:       theSameAsWeb2 = site1.RootWeb,
   8:       anotherWeb1 = site2.OpenWeb("book");

(这部分代码并不完整,详见后面的说明)

 

4、特殊的网站和网站集获取方法

之前所介绍的一些获取方法可以随时使用,但是当程序运行在IIS进程中时(比如Web页面、Web部件、一些类型的事件处理程序、工作流等),由于有上下文(Context)的存在,可以很方便的获取到程序所在的当前网站集和当前网站:

   1: SPSite currentSite = SPContext.Current.Site;
   2: SPWeb currentWeb = SPContext.Current.Web;

 

 

5、网站集和网站的常用属性

SPSite的常用属性:

名称

类型

说明

AllWebs

SPWebCollection

网站集中的所有网站

RootWeb

SPWeb

网站集的根网站(顶级网站)

Url

string

网站集的绝对路径(实际上就是顶级网站的绝对路径)

 

SPWeb的常用属性:

名称

类型

说明

RootFolder

SPFolder

网站的根目录

Site

SPSite

网站所在的网站

Title

string

网站标题

Name

string

相对父网站的Url(不是网站名称,不要被这个属性的名字迷惑)

Url

string

网站的绝对路径

Webs

SPWebCollection

网站的子网站(不包含孙网站)

 

由于几乎所有常用的对象模型都是依附于网站的,这些对象的访问也基本都以SPWeb作为起点,因此涉及到SPWeb中包含的其他对象操作访问的属性和方法,将在后文具体介绍到相应对象的时候再做详细说明。

 

6、网站集和网站的释放

由于SPSite和SPWeb的一些内部属性中,使用到了非托管资源,而这些非托管资源不受.NET的垃圾回收机制控制,因此在使用完SPSite和SPWeb对象之后,一个良好的习惯是手动将其释放掉,释放的方法是调用其Dispose方法。例如:

   1: SPSite site = new SPSite("http://sp2010/book");
   2: SPWeb web = site.OpenWeb();
   3: // use the web and site
   4: web.Dispose(); 
   5: site.Dispose();

当然,更方便的一种方式是使用C#中的using关键字,从而在使用完之后自动调用其Dispose方法。因此,一般而言,常用的写法是下面这种形式:

   1: using(SPSite site = new SPSite("http://sp2010/book"))
   2: {
   3:   using(SPWeb web = site.OpenWeb())
   4:   {
   5:     // use the web and site
   6:   }
   7: }

在SharePoint应用中,几乎所有返回的SPSite和SPWeb对象都需要上述释放过程。但是使用SPContext.Current方式获取的SPSite和SPWeb不可以释放!否则会触发一些意外情况,SharePoint运行时会自动控制这两个对象的生命周期。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/439299.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

SharePoint安全 - SharePoint网站常用页面URL索引

一. 主要网站内容 首页 /default.aspx /Pages/default.aspx 网站设置 /_layouts/settings.aspx 所有网站内容 /_layouts/viewlsts.aspx 移动端所有网站内容 /_layouts/mobile/mbllists.aspx 共享文档 /shared documents/forms/allitems.aspx 管理网站内容结构 /_l…

docker安装与学习

安装Docker 系统环境:macOS Catalina 10.15.7 通过brew安装docker brew install --cask --appdir/Applications docker 直接brew install docker装上的好像不是,好像是当成了formula了。如下图 brew cask install docker直接提示命令不对&#xff0c…

集群、分布式、负载均衡区别与联系

1、Linux集群主要分成三大类( 高可用集群, 负载均衡集群,科学计算集群) 集群是一个统称,他分为好几种,如:高性能科学群集、负载均衡群集、高可用性群集等。 科学群集 、高性能集群(High performance clus…

Mac下使用brew的常用步骤

以docker为例: 第一步: 先 brew search 软件名 然后发现在Formulae和Casks中都有docker包。 第二步: 分别查看info brew info dockerbrew info homebrew/cask/docker 从详情中可以看出,cask下的才是Docker Desktop for Mac&a…

【机器学习】 - keras中的模型可视化plot_model模块(含依赖包pydot和graphviz的详细安装过程与注意事项)

运行环境: win10 anaconda3-spyder python3.7.4 tensorflow2.0.0 首先需要安装两个包pydot和graphviz,不然会报错: Failed to import pydot. You must install pydot and graphviz for pydotprint to work. 然后去anaconda prompt 里去…

【git学习】统计git项目某user的代码量

查看自己的代码量:(直接awk编程) git log --author"username" --prettytformat: --numstat | awk { add $1; subs $2; loc $1 - $2 } END { printf "added lines: %s, removed lines: %s, total lines: %s\n", add, …

一步步编写操作系统 79 在c代码中内联汇编

基本内联汇编是最简单的内联形式,其格式为: asm [volatile] (“assembly code”) 各关键字之间可以用空格或制表符分隔也可以紧凑挨在一起不分隔,各部分意义如下: 关键字asm用于声明内联汇编表达式,这是内联汇编固定…

LeetCode 237. 删除链表中的节点(思维)

请编写一个函数,用于 删除单链表中某个特定节点 。在设计函数时需要注意,你无法访问链表的头节点 head ,只能直接访问 要被删除的节点 。 题目数据保证需要删除的节点 不是末尾节点 。 https://leetcode-cn.com/problems/delete-node-in-a-…

LeetCode 397. 整数替换

题目大意: 给定一个正整数 n ,你可以做如下操作: 如果 n 是偶数,则用 n / 2替换 n 。 如果 n 是奇数,则可以用 n 1或n - 1替换 n 。 n 变为 1 所需的最小替换次数是多少? 链接:https://leet…

LeetCode 375. 猜数字大小 II

题目大意: https://leetcode-cn.com/problems/guess-number-higher-or-lower-ii 我们正在玩一个猜数游戏,游戏规则如下: 我从 1 到 n 之间选择一个数字。 你来猜我选了哪个数字。 如果你猜到正确的数字,就会 赢得游戏 。 如果你…

【转】2.3SharePoint服务器端对象模型 之 访问网站和列表数据(Part 3)

(三)视图 与传统意义上的数据视图类似,SharePoint中的列表视图指定了列表中数据的筛选条件、排序条件、分组条件、显示栏/字段、显示条目数、显示样式等内容。在SharePoint中,使用SPView表示列表视图,使用SPViewColle…

【转】2.4SharePoint服务器端对象模型 之 访问网站和列表数据(Part 4)

(四)栏/字段 SharePoint中的字段(中文版中叫做“栏”)与传统的数据栏类似,也有不同类型的区别,不过SharePoint中内置的栏类型除了按照数据类型(如数字、日期和时间等)进行区分之外&…

【转】2.5SharePoint服务器端对象模型 之 访问网站和列表数据(Part 5)

(五)列表条目(SPListItem) SharePoint中数据的存储基本上都是通过列表条目来完成(文档库中的文档也是一种特殊的列表条目),因此在SharePoint应用开发中,最终是要和列表条目打交道的…

【转】3.3SharePoint服务器端对象模型 之 访问文件和文件夹(Part 3)

(三)遍历 文件系统的遍历是指按照文件夹的层级结构遍历文档库、列表的文件夹和列表条目。遍历主要有三种方式:(1)直接使用文件系统对象模型进行遍历;(2)使用SPDocumentLibrary进行遍…

【LeetCode240、剑指offer04】二维数组中的查找(线性做法)

在一个 n * m 的二维数组中,每一行都按照从左到右递增的顺序排序,每一列都按照从上到下递增的顺序排序。请完成一个高效的函数,输入这样的一个二维数组和一个整数,判断数组中是否含有该整数。 示例: 现有矩阵 matrix 如下&#x…

【转】4.2SharePoint服务器端对象模型 之 使用CAML进行数据查询(Part 2)

(三)使用SPQuery进行列表查询 1、概述 列表查询主要是指在一个指定的列表(或文档库)中按照某些筛选、排序条件进行查询。列表查询主要使用SPQuery对象,以及SPList的GetItems方法,将SPQuery作为参数传递&a…

【转】理解SQL Server的安全对象和权限

理解安全对象(Securable) 安全对象,是SQL Server 数据库引擎授权系统控制对其进行访问的资源。通俗点说,就是在SQL Server权限体系下控制的对象,因为所有的对象(从服务器,到表,到视图触发器等)都在SQL Server的权限体系…

【NC14 按之字形顺序打印二叉树】

描述 给定一个二叉树&#xff0c;返回该二叉树的之字形层序遍历&#xff0c;&#xff08;第一层从左向右&#xff0c;下一层从右向左&#xff0c;一直这样交替&#xff09; 数据范围&#xff1a;0 \le n \le 15000≤n≤1500,树上每个节点的val满足 |val| < 100∣val∣<1…

SharePoint 2010文档库批量下载文档的实现

在SharePoint 2010文档库中&#xff0c;结合单选框&#xff0c;在Ribbon中提供了批量处理文档的功能&#xff0c;比如&#xff0c;批量删除、批量签出、批量签入等&#xff0c;但是&#xff0c;很遗憾&#xff0c;没有提供批量下载&#xff0c;如图: 若选中多个文档后&#xff…

【LeetCode - 42. 接雨水】

42. 接雨水 难度困难3164 给定 n 个非负整数表示每个宽度为 1 的柱子的高度图&#xff0c;计算按此排列的柱子&#xff0c;下雨之后能接多少雨水。 示例 1&#xff1a; 输入&#xff1a;height [0,1,0,2,1,0,1,3,2,1,2,1] 输出&#xff1a;6 解释&#xff1a;上面是由数组 […