List 元素 (List)

适用于: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint Online |SharePoint Server 2013

包含列表定义的顶级元素。

<List
  BaseType = "Integer" | "Text"
  Default = "TRUE" | "FALSE"
  DefaultItemOpen = "Integer"
  Description = "Text"
  Direction = "Text"
  DisableAttachments = "TRUE" | "FALSE"
  DraftVersionVisibility = "Integer"
  EnableContentTypes = "TRUE" | "FALSE"  EnableMinorVersions = "TRUE" | "FALSE"  EnableThumbnails = "TRUE" | "FALSE"
  EventSinkAssembly = "Text"
  EventSinkClass = "Text"
  EventSinkData = "Text"
  FolderCreation = "TRUE" | "FALSE"
  Id = "GUID"
  ModeratedList = "TRUE" | "FALSE"
  ModerationType = "TRUE" | "FALSE"
  Name = "Text"
  OrderedList = "TRUE" | "FALSE"
  PrivateList = "TRUE" | "FALSE"
  QuickLaunchUrl = "URL"
  RootWebOnly = "TRUE" | "FALSE"
  ThumbnailSize = "Integer"
  Title = "Text"
  Type = "Integer"
  Url = "URL"
  URLEncode = "TRUE" | "FALSE"
  VersioningEnabled = "TRUE" | "FALSE"
  WebImageHeight = "Integer"
  WebImageWidth = "Integer">
</List>

元素和属性

下面各部分介绍了属性、子元素和父元素。

Attributes

属性 说明
BaseType
可选 文本BaseType 属性可设置为 Integer(将值以整数形式存储)或 Text(默认,将值以文本形式存储)。 请注意,无法创建整数基类型选择字段。
默认
可选属性,类型为 Boolean。 若要指定在创建网站时也创建在 Onet.xml 文件中引用的列表,则为 TRUE。 否则将不会在创建网站时创建该列表,但可在后面的实例化中使用该列表。
DefaultItemOpen
可选属性,类型为 Boolean。 若要指定在列表中生成项目的服务器转换的应用程序在浏览器(而不是在单独的客户端应用程序中)中打开项目,则为 1;否则为 0
说明
可选属性,类型为 Text。 提供列表的说明。 向网站定义中添加自定义列表定义时,必须在 Onet.xml 文件的配置中指定此属性。 此属性的值覆盖与 Schema.xml 文件的 DefaultDescription 元素包含在一起的值。
方向
必需属性,类型为 Text。 指定列表的阅读顺序的方向。 可能的值包括 RTL(从右至左)、LTR(从左至右)或 none
DisableAttachments
可选属性,类型为 Boolean。 如果为 TRUE,则在列表中禁用附件。
DraftVersionVisibility
可选属性,类型为 Integer。 指定查看草稿所需的权限。

以下是可能的值:
- 1 编辑权限
- 2 审批权限
- 所有其他值 读取权限
EnableContentTypes
可选属性,类型为 Boolean。 如果为 TRUE,则在通过列表定义创建的列表中启用内容类型管理。
EnableMinorVersions
可选属性,类型为 Boolean
EnableThumbnails
可选属性,类型为 Boolean。 如果为 TRUE,则指定此列表中的文档分析程序生成缩略图文件,这些文件与保存到此列表的文档相对应。 此属性仅适用于文档库。
EventSinkAssembly
可选 文本。 此选项仅针对从 Windows SharePoint Services 2.0 升级的架构指定。 指定为文档库事件提供事件处理程序的全局程序集缓存 (GAC) 中的文件的强名称。

例如,Microsoft.SharePoint, Version=11.0.0.0, Culture=Neutral, PublicKeyToken=71e9bce111e9429c

此属性已在 SharePoint Foundation 中弃用。
EventSinkClass
可选 文本。 以 Namespace_Name.Class_Name 格式指定类的区分大小写的完全限定名称,该类为文档库事件定义事件处理程序。 此属性已在 SharePoint Foundation 中弃用。
EventSinkData
可选属性,类型为 Text。 包括文档库事件的事件处理程序使用的任意字符串。 此属性已在 SharePoint Foundation 中弃用。
FolderCreation
可选属性,类型为 Boolean。 若要在“新建”菜单上显示“新建文件夹”命令,则为 TRUE
Id
可选属性,类型为 GUID。 指定列表的 GUID。
ModeratedList
可选属性,类型为 Boolean。 如果为 TRUE,则要求对提交的项目进行内容审批。
ModerationType
可选属性,类型为 Boolean。 如果为 TRUE,则指定列表启用裁决,在创建或修改内容时需要审批过程。
名称
必需属性,类型为 Text。 列表的内部名称。
OrderedList
可选属性,类型为 Boolean。 如果为 TRUE,则指定可在列表的“编辑视图”页使用允许用户在列表中重新排列项目的选项。
PrivateList
可选属性,类型为 Boolean。 如果为 TRUE,则指定列表为专用列表。
QuickLaunchUrl
可选属性,类型为 Text。 指定要通过快速启动导航为列表打开的视图页的 URL。
RootWebOnly
可选属性,类型为 Boolean如果为 TRUE ,则指定从定义创建的列表仅存在于网站集的根网站中。
ThumbnailSize
可选属性,类型为 Integer。 指定在图片库中显示的缩略图的宽度。
标题
必需属性,类型为 Text。 列表的通用显示名称。
类型
可选属性,类型为 Integer。 指定列表的列表模板类型。

以下值是默认列表模板类型。

100 泛型列表
101 文档库
102 调查
103 链接列表
104 公告列表
105 联系人列表
106 事件列表
107 任务列表
108 讨论板
109 图片库
110 数据源
111 网站模板库
112 用户信息列表
113 Web 部件库
114 列表模板库
115 XML 表单库
116 个母版页库
117 No-Code工作流
118 自定义工作流流程
119 Wiki 页面库
120 列表的自定义网格
130 数据连接库
140 工作流历史记录
150 甘特任务列表
200 会议系列列表
201 会议议程列表
202 会议与会者列表
204 会议决策列表
207 会议目标列表
210 会议文本框
211 会议要带物品列表
212 会议工作区页面列表
301 博客文章列表
302 博客评论列表
303 博客类别列表
1100 问题跟踪
1200 管理员任务列表

此属性对应于 ListTemplate 元素的 Type 属性。
Url
可选 文本。 指定目录的根路径,该目录包含列表定义所应用到的 ASPX 文件(相对于网站的根 URL)。
URLEncode
可选属性,类型为 Boolean。 如果为 TRUE,则将特殊字符(如空格)转换为引用的 UTF-8 格式(例如,%c3%ab 表示字符 ë)。
VersioningEnabled
可选属性,类型为 Boolean。 如果为 TRUE,则在 Schema.xml 文件中指定为通过列表定义创建的文档库默认启用版本控制。 设置此属性不会影响现有文档库。 如果为 TRUE,则在创建库时仍然可以在“新建文档库”页上对文档库禁用版本控制。
WebImageHeight
可选属性,类型为 Integer。 指定图片库中图片的高度(以像素为单位)。
WebImageWidth
可选属性,类型为 Integer。 指定图片库中图片的宽度(以像素为单位)。

子元素

父元素

出现次数

  • 最小值:0
  • 最大值:1

备注

当用作列表架构文件中的根元素时, List 元素必须包含 Microsoft SharePoint Foundation ows: 命名空间声明。 下面的行显示文档库中 Schema.xml 文件的开始部分:

<List
  xmlns:ows="Microsoft SharePoint"
  Name="Documents"
  Title="$Resources:shareddocuments_Title;"
  Direction="$Resources:Direction;"
  Url="Shared Documents"
  BaseType="1">

在列表架构中,MetaData 元素包含列表定义的不同部分。 (List/>) 使用空的 List 元素<返回当前列表的标题。

在网站定义 (Onet.xml) 中,List 元素不包含 MetaData 节,但包含 Data 节,可通过 Data 节为给定的列表类型指定默认列值。