ListTemplate 元素 (列表模板)

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

指定可用作在“创建”页上创建列表的选项的列表定义。

定义

<ListTemplate
  AllowDeletion = "TRUE" | "FALSE"
  AllowEveryoneViewItems = "TRUE" | "FALSE"
  AlwaysIncludeContent = "TRUE" | "FALSE"
  BaseType = "0" | "1" | "3" |"4" | "5"
  CacheSchema = "TRUE" | "FALSE"
  Catalog = "TRUE" | "FALSE"
  Category = "Libraries" | "Communications" | "Tracking" |
    "Custom Lists"
  Default = "TRUE" | "FALSE"
  Description = "Text"
  DisableAttachments = "TRUE" | "FALSE"
  DisallowContentTypes = "TRUE" | "FALSE"
  DisplayName = "Text"
  DocumentAsEnclosure = "TRUE" | "FALSE"
  DocumentTemplate = "Integer"
  DontSaveInTemplate = "TRUE" | "FALSE"
  EditPage = "Text"
  EnableModeration = "TRUE" | "FALSE"
  EnablePeopleSelector = "TRUE" | "FALSE"
  EnableResourceSelector = "TRUE" | "FALSE"
  FeatureId = "Text"
  FolderCreation = "TRUE" | "FALSE"
  Hidden = "TRUE" | "FALSE"
  HiddenList = "TRUE" | "FALSE"
  Image = "URL"
  MultipleTypes = "TRUE" | "FALSE"
  MustSaveRootFiles = "TRUE" | "FALSE"
  Name = "Text"
  NewPage = "Text"
  NoCrawl = "TRUE" | "FALSE"
  OnQuickLaunch = "TRUE" | "FALSE"
  Path = "Text"
  RootWebOnly = "TRUE" | "FALSE"
  SecurityBits = "Text"
  Sequence = "Integer"
  SetupPath = "Text"
  SyncType = "Text"
  Type = "Integer"
  Unique = "TRUE" | "FALSE"
  UseRootFolderForNavigation = "TRUE" | "FALSE"
  VersioningEnabled = "TRUE" | "FALSE">
</ListTemplate>

元素和属性

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

Attributes

属性 说明
**AllowDeletion** 可选 **Boolean**。 **TRUE**,指定无法删除通过模板创建的列表;否则为 “FALSE”。
**AllowEveryoneViewItems** 可选 **Boolean**。 **TRUE**,以允许任何用户查看库中的项目。 例如,在母版页库中使用 AllowEveryoneViewItems** 属性,向所有用户授予对母版页的访问权限。
**AlwaysIncludeContent** 可选 **Boolean**。 **TRUE**,指定在通过模板创建的列表在用户界面中保存为列表模板时默认包含列表内容;否则为 “FALSE”。
**BaseType** 必需 **Integer**。 为从定义创建的列表指定基本类型或默认架构。

* 0 - GenericList

* 1 - DocumentLibrary

* 3 - DiscussionBoard

* 4 - 调查

* 5 - 问题
**CacheSchema** 可选 **Boolean**。 **TRUE**,用于在预配站点时启用列表的架构缓存。 例如,在全局 Onet.xml 文件中使用 **CacheSchema** 属性来为当前网站集启用用户列表的缓存。
**目录** 可选 **Boolean**。 **TRUE** 指定列表定义适用于网站库、列表库或 Web 部件库。
**类别** 可选 **Text**。 指定要将通过列表定义创建的列表与其关联的类别。 可能的值包括:

***图书馆**

***通信**

***跟踪**

* **自定义列表**
**默认** 可选 **Boolean**。 **TRUE** 指定新的 SharePoint 网站将包含此列表。
**描述** 可选 **Text**。 提供列表定义的说明。
**DisableAttachments** 可选 **Boolean**。 **TRUE** 指定用户可以将文件附加到通过模板创建的列表中的项;否则为 “FALSE”。
**DisallowContentTypes** 可选 **Boolean**。 **TRUE** 指定无法对通过模板创建的列表管理内容类型;否则为 “FALSE”。
**DisplayName** 必需 **Text**。 指定列表定义的显示名称。
**DocumentAsEnclosure** 可选 **Boolean**。 指定是否将文档作为外壳对象包括在列表中。
**DocumentTemplate** 可选 **Integer**。 当前未使用。 这仅在 ListTemplate 元素中有效,该元素的 “BaseType” 设置为 1 (文档库) 。 为了将来的兼容性,这应为空白或对应于 DocumentTemplates 枚举中 DocumentTemplate 元素的 Type 属性。 [与以前的版本相同,但已弃用。]
**DontSaveInTemplate** 可选 **Boolean**。 当列表另存为自定义列表模板或通过用户界面将列表所属的网站另存为自定义网站模板时,用于排除列表内容。
**EditPage** 可选 **Text**。 指定自定义应用程序页的名称, (/_layouts) 用作编辑通过列表模板创建的列表的列表属性的页面。
**EnableModeration** 可选 **Boolean**。 **TRUE** 指定默认情况下在通过模板创建的列表中启用内容审批;否则为 “FALSE”。
**EnablePeopleSelector** 可选 **Boolean**。 指定 EnablePeopleSelector 属性的值。
**EnableResourceSelector** 可选 **Boolean**。 指定 EnableResourceSelector 属性的值。
**FeatureId** 可选 **Text**。 指定用于标识与模板关联的功能 GUID。
**FolderCreation** 可选 **Boolean**。 **TRUE**:在列表中启用文件夹创建,并指定“新建文件夹”命令显示在列表视图的“新建”菜单上;否则为 “FALSE”。
**隐藏** 可选 **Boolean**。 **TRUE** 指定列表定义在创建列表的 “创建” 页上不可用。
**HiddenList** 可选 **Boolean**。 **TRUE** 指定隐藏从列表定义创建的列表。
**图像** 可选 **URL**。 指定指向用于表示列表的图标的 URL。
**MultipleMtgDataList** 可选 **Boolean**。 如果指定了“MultipleMtgDataList=”TRUE“,则会议工作区网站中的列表包含网站中多个会议实例的数据。
**MultipleTypes** 可选 **Boolean**。 指定是否存在多个列表类型。
**MustSaveRootFiles** 可选 **Boolean**。 **TRUE**,用于保存特殊文档库中包含的页面,在保存列表模板时内部用于会议工作区网站。 此属性不是为公共使用而设计的。
**名字** 必需 **Text**。 指定列表定义的内部名称。 不能使用空格或特殊字符。 此名称还用于查找包含用于定义正在使用的架构的 Schema.xml 文件的文件夹。
**NewPage** 可选 **Text**。 指定自定义页的名称,该页用于通过列表模板创建新列表。
**NoCrawl** 可选 **Boolean**。 **TRUE**,指定列表在搜索结果中不可见;否则为 “FALSE”。
**OnQuickLaunch** 可选 **Boolean**。 “TRUE”,用于显示从“快速启动”栏上的列表定义创建的列表。
**路径** 可选 **Text**。 指定包含列表定义的网站定义的名称;例如 ,**STS**。 假定此路径与 12\TEMPLATE 目录有关。 路径可以定向到功能架构;例如,Features\Announcements。 [与以前的版本相同,但已弃用。]
**RootWebOnly** 可选 **Boolean**。 **TRUE** 指定从定义创建的列表仅存在于网站集的根网站中。 [与以前的版本相同,但已弃用。]
**SecurityBits** 可选 **Text**。 为具有足够读取或编辑列表项权限的用户定义列表中的项目级权限。 **SecurityBits** 属性包含一个 2 位字符串。 该字符串中的第一个数字控制读取权限;字符串中的第二个数字控制编辑权限。 对于读取权限,有效的数字如下:

* **1** 用户可以读取所有项目。

* **2** 用户只能读取自己的项目。


对于编辑权限,有效的数字如下:

* **1** 用户可以编辑所有项目。

* **2** 用户只能编辑自己的项目。

* **4** 用户无法编辑项目。


**注意**:具有 ManageLists 权限的用户可以读取和编辑所有项目,而不考虑 “SecurityBits” 属性的值。

此属性不适用于文档库。
**序列** 可选 **Integer**。 指定用于“创建”页上列表模板的排序优先级。 如果未设置“Sequence”,则模板以任意顺序以任意顺序显示在最后,而其他任何模板也缺少 “Sequence” 值。 指定相同序列的两个模板以任意顺序排序在一起。
**SetupPath** 可选 **Text**。 指定 SharePoint Foundation 安装目录中文件夹的路径 (%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\\TEMPLATE) ,其中包含要包含在模板中的文件。
**SyncType** 可选 **Boolean**。 **TRUE** 以替代与 SharePoint Foundation 基模板关联的默认客户端列表类型。
**类型** 可选 **Integer**。 提供模板的唯一标识符。 此标识符在功能内必须是唯一的,但不必在所有功能定义或网站定义中均是唯一的。 有关默认列表模板类型的列表,请参阅 SPListTemplateType。

此属性对应于 List 元素的 Type 属性。
**独特** 可选 **Boolean**。 **TRUE** 指定列表定义或列表模板只能在网站创建期间用于创建列表,并且不能用于在应用网站模板或定义后通过对象模型或用户界面创建列表。 将此属性设置为“TRUE”可隐藏列表,使其不显示为“创建”页面或“文档和列表”页上的选项。
**UseRootFolderForNavigation** 可选 **Boolean**。 **TRUE** 指定指向“快速启动”中显示的列表的链接指向根文件夹,以便用户转到自定义欢迎页,而不是默认列表视图页。

如果未为列表设置自定义欢迎 URL,则呈现一个指向根文件夹的链接,从而达到与链接到默认列表视图相同的效果。
**VersioningEnabled** 可选 **Boolean**。 **TRUE**,指定在通过模板创建的列表中默认启用版本控制;否则为 “FALSE”。

子元素

父元素

元素
元素

示例

有关如何使用此元素的示例,请参阅List Template Files