zoukankan      html  css  js  c++  java
  • sharepoint对象模型及相关属性

    首先介绍关于SharePoint对象模型的开发简单的入门
    SharePoint对象模型概述


    一些基本对象
    Farm, Service, Web Application, Site, Web
    List, View, Field, Item


    几个主要功能
    文件结构
    权限系统
    查询

    集合(Collection)
    很多对象都有集合
    SPWeb–SPWebCollection
    SPList - SPListCollection


    操作
    Get:xxCollection[idx], xxCollection.GetxxxByxxx
    Add: xxCollection.Add
    Del: xxCollection.Delete, xx.Delete, xx.Recycle
    Update: xx.Update

    集合(Collection)
    向下访问
    site.AllWebs
    web.Lists
    list.Views


    向上访问
    web.Site
    list.ParentWeb
    view.ParentList


    四种Url
    absolute url
    [moss]
    server-relative url
    /sites/myweb/doc/folder/file.doc
    xx.ServerRelativeUrl
    site-relative url
    doc/folder/file.doc
    xx.Url
    relative url
    file.doc (base = folder)


    服务器场
    SPFarm
    SPFarm.Local 当前服务器场


    内容服务
    SPWebService
    SPWebService.ContentService 当前内容服务
    webService.WebApplications


    Web应用程序
    SPWebApplication
    webApp.Sites

    网站的获取
    通过SPSite的构造函数获取网站集


    使用absolute url
    site.AllWebs[idx]
    site.RootWeb
    site.OpenWeb()


    顶级站点与子站点
    SPContext.Current
    在Context环境下使用
    最经常用到的容器
    列表:web.Lists
    文件:web.Files
    文件夹:web.Folders
    用户:web.Users
    组:web.Groups
    回收站:web.RecycleBin

    SPList
    SharePoint中最主要的数据容器
    内容
    list.Items
    list.Views
    list.Fields
    list.Folders(*)

    SPList
    几个属性
    BaseType和BaseTemplate
    RootFolder


    列表的获取
    web.Lists[idx]
    web.GetList()
    server-relative url
    web.GetListFromUrl()
    web.GetListFromWebPartPageUrl()
    site-relative url
    web.GetListsOfType()

    SPView


    显示的渠道
    视图包含
    Query:筛选和排序
    ViewFields:显示的字段
    SchemaXml:基本设置
    ViewBody等:显示样式
    Url:视图的地址

    SPView
    获取
    list.Views[idx]
    Guid, index, name
    list.GetView()
    Guid
    web.GetViewFromUrl()
    server-relative url


    SPField
    SPField (Base Class)
    SPFieldText
    SPFieldComputed
    SPFieldMultiChoice
    SPFieldChoice
    SPFieldLookup
    SPFieldUser

    SPField
    几个属性
    Title(显示名称)和InternalName(内部名称)
    Type:类型
    SchemaXml:基本设置


    获取
    fields[idx]
    index, display name
    fields.GetField()
    fields.GetFieldByInternalName()


    SPListItem
    获取
    items[idx]
    items.GetItemById(), list.GetItemById()
    list.GetItemByUniqueId()
    list.GetItems()


    新建
    items.Add() -> modify -> item.Update()

    SPFile和SPFolder
    获取
    web.GetFile(), web.GetFolder()
    web.RootFolder, list.RootFolder(*)
    folder.Files, folder.SubFolders
    foreach遍历需要“浏览目录”权限

    特殊的列表SPDocumentLibrary
    继承自SPList
    属性
    IsCatalog:默认的一些模版库、Web部件库、母版库
    下面介绍一个简单的Demo
    访问文档库遍历里面所有的文件和文件夹

                    SPWeb web = (new SPSite("http://moss/sites/hello")).OpenWeb();
                    SPDocumentLibrary doclib = (SPDocumentLibrary)web.Lists["共享文档"];
                    doclib.Lists.IncludeRootFolder = true;
                    GoThroughDocLib(doclib, doclib.RootFolder, 0);

           static void GoThroughDocLib(SPDocumentLibrary doclib, SPFolder folder, int level)
            {
                SPListItemCollection items = doclib.GetItemsInFolder(doclib.DefaultView, folder);
                if (items.Count == 0)
                    return;

                for (int i = 0; i < level; i++)
                    Console.Write(" ");
                foreach (SPListItem item in items)
                {
                    if (item.FileSystemObjectType == SPFileSystemObjectType.Folder)
                    {
                        Console.WriteLine("[{0}]", item.Name);
                        GoThroughDocLib(doclib, item.Folder, level + 1);
                    }
                    else
                        Console.WriteLine(item.Name);
                }
            }


    Moss类库说明:

    Windows SharePoint Services类库说 命名空间:Microsoft.SharePoint SPSite 功能: Represents a collection of sites on a virtual server, including a top-level site and all its subsites. 代表一个虚拟服务器的网站集合,包含一个顶集网站和他的所有子站点Windows SharePoint Services类库说
    命名空间:Microsoft.SharePoint


    SPSite
    功能:
    Represents a collection of sites on a virtual server, including a top-level site and all its subsites.
    代表一个虚拟服务器的网站集合,包含一个顶集网站和他的所有子站点
    AllWebs:属性表示上面意义的网站集合
    Quota:网站给定某用户的限额
    IISAllowsAnonymous:IIS是否允许匿名登录
    PortalUrl:网站所在的门户网站的URL对于WSS网站,此项是空值
    URL:网站所在的网址


    SPWeb
    功能:
    Represents a SharePoint site.
    代表SharePoint的一个网站
    Alerts:所有通知的集合
    AllUsers:代表所有用户对象的集合,这个用户可以是网站的用户,也可以是经过认证的域用户
    Configuration:用来建立站点的配置ID,
    DocTemplates:此网站所用的文档模板
    EmailInsertsEnabled:取得值,表明此网站的文档库是否接收Excahnge的公共文件邮件中的附件
    EventHandlersEnabled:读取此网站的文档库是否接收事件处理
    Files:取得此网站根目录下所有的文件
    Folders:取得此站点所有第一级文件夹
    Groups:取得此站点交差站点的组
    IncludeSupportingFolders:取得或设置在此站点中的文件夹或文件夹中的文件是否支持枚举
    IsADAccountCreationMode:取得访问站点的用户是否自动在活动目录里建立帐户
    IsRootWeb:取得此站点是否为站点集中的第一级站点
    Lists:取得在此站点中所有列表的集合
    Modules:取得在此站点中使用的模块
    PortalMember:是否与Portal相关联
    PortalSubscriptionUrl:一直URL供Portal 中的Alerts
    PresenceEnabled:取得或设置是否为记录用户在线信息
    Properties:属性集合,此集合中包含WSS的版本或地域信息
    PublicFolderRootUrl:取得文档库接收公共文件夹中邮件附件的URL
    Roles:取得站点的用户组
    SiteGroups:取得网站集合的交差网站组
    SiteUsers:取得站点集合的所有用户
    Users:取得此站点的用户集合
    Microsoft.SharePoint.SPWeb.ViewStyles:取得站点的视图样式
    Webs:取得在此站点以下所有子站点的集合


    SPAlert
    功能:
    Represents an alert, which generates periodic e-mail notifications sent to a user about the list, list item, document, or document library to which the alert applies.
    代表一个通知,它产生一个定期的e-mail通知发送到用户那里,发更新与此通知关联的列表,列表项,文档,文档库等的消息
    SPAlertFrequency:通知发生的频率,分别为每天一次,每周一次,立即发送
    SPEventType:事件类型:全部,删除,增加,讨论,修改
    Item:此通知属于的列表项或文档
    List:此通知所属的列表或文档库
    User:得到通知的人


    SPList
    Represents a list on a SharePoint Web site.
    代表SharePoint 网站中的一个列表
    AllowDeletion:此列表是否允许删除
    AllowMultiResponses:指定调查是否允许多次答复,由此可见,调查属于列表的一种
    AnonymousPermMask:是否允许匿名用户访问
    BaseTemplate:说明列表基于的模板类型,模板类型有通知、联系人、自定义表格、数据源、讨论板、文档库、事件、自定义列表、不合法列表、问题跟踪、链接、列表模板库、图片库、调查、任务、Web部件库、网站模板库、Xml表格库
    BaseType:列表的基本类型,类型有:讨论板、文档库、自定义列表、问题跟踪、调查、无类型、没有使用的
    DefaultView:默认视图
    Direction:阅读的方向
    EnableAttachments:是否允许添加附件
    EnableModeration:是否需要审批
    EnableVersioning:是否支持版本
    EventSinkAssembly:支持事件通知程序集的强名称
    EventSinkClass:支持事件通知类名称
    EventSinkData:文档库的事件通知中定义的任意字符串
    ExcludeFromTemplate:当列表被存成模板时,是否包含内容
    Fields:列表中字段的集合
    Forms:在列表中用来显示、编辑、增加列表项的表格集合
    Hidden:此列表是否隐藏
    ImageUrl:列表的图标的服务器相对地址
    ItemCount:列表项的数目
    Items:列表项集合
    Lists:该列表所在的列表集合
    MultipleDataList:指定这个在会议工作区中的列表,是否包含多个会议的实例
    OnQuickLaunch:是否有首页的快速启动中显示
    Ordered:是否允许用户重新对列表项排序
    ParentWeb:列表属于的父网站
    Permissions:权限集合
    PropertiesXml:协作应用标记语言,代表列表的属性值
    ReadSecurity:阅读权限设置
    RootFolder:取得在列表中包含所有文件的文件夹
    SchemaXml:取得此列表的Xml样式
    ShowUser:是否在调查中是否显示用户名称
    Views:此列表所有视图集合
    WriteSecurity:指定写入设置


    SPListEvent
    Represents an event that occurs within a document library.
    功能:代表文档库内发生的事件
    ListID:事件发生的文档库的GUID
    PropertiesAfter:事件发生后文档库状态属性
    Type:事件类型:签入、签出、复制、删除、插入、不合法、剪切、撤消签出、更新
    UrlAfter:返回文档或文件夹的网站相对地址,在任何事件发生时,除了删除事件
    UserDisplayName:引发事件的用户的显示名称
    UserID:引发事件的用户ID
    UserLoginName:引发事件的用户登录名称
    WebUrl:事件发生的网站的绝对URL


    SPListItem
    功能:
    Represents an item, or row, in a list.
    代表列表中的一个列表项或者一行
    Attachments:与列表项关联的附件
    Fields:列表项所在的列表字段集合
    File:由列表所代表的文档库中的文件
    ListItems:所在的父列表
    ModerationInformation:审批信息,包含状态和描述
    ParentList:所在父列表
    Xml:列表中的数据的Xml格式


    SPIssueList
    此类从SPList继承
    功能:表示一个问题列表
    EnableAssignedToEmail:当列表项与用户关联时,是否发送e-mail通知


    SPField
    功能:
    Represents a field in a list on a SharePoint Web site.
    代表SharePoint网站中列表的一个字段
    CanToggleHidden:取得此字段是否可以通过用户界面隐藏
    DefaultFormula:计划字段的默认公式
    Direction:阅读顺序
    DisplaySize:显示大小
    FieldReferences:一个字符数组,表示字段引用计算机中的字段名称
    Filterable:表明此字段是否可以过滤
    FilterableNoRecurrence:取得是否可以在视图中的字段建立过滤,却不引发重复的事件
    FromBaseType:是否从基本字段产生
    Hidden:是否在视图中显示
    InternalName:内部名称
    ParentList:包含字段的列表
    ReadOnlyField:此字段是否可以修改
    Reorderable:在字段中的值是否可以重排序
    Required:决定此字段是否为必须的
    Sealed:此字段是否可以被其它字段继承
    Sortable:是否可以被排序
    Type:字段类型:
    TypeAsString:字段的名称的字符

  • 相关阅读:
    如何使用sendEmail发送邮件
    Linux curl命令详解
    linux比较两个文件是否一样(linux命令md5sum使用方法)
    strace命令用法详解
    strace用法说明
    ORA-12154 TNS无法解析指定的连接标识符
    VNC远程连接阿里云Linux服务器 图形界面
    pycharm配置Git 代码管理
    FireFox浏览器-xpath快速定位插件:Xpath Checker
    odoo 前端模板引擎 Qweb
  • 原文地址:https://www.cnblogs.com/ericgisser/p/moss_classlibrary.html
Copyright © 2011-2022 走看看