File 元素(模块)

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

指定要包含在网站定义中的模块内的文件。

定义

<File
  DocumentTemplateForList = string
  DoGUIDFixUp = "TRUE" | "FALSE"
  IgnoreIfAlreadyExists = "TRUE" | "FALSE"
  Level = Draft
  Name = string
  NavBarHome = "TRUE" | "FALSE"
  Path = string  ReplaceContent = "TRUE" | "FALSE"
  Type = "Ghostable" | "GhostableInLibrary"
  Url = string>
  <AllUsersWebPart />
  <BinarySerializedWebPart />
  <NavBarPage />
  <Property />
  <View />
  <WebPartConnection />
</File>

元素和属性

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

Attributes

属性

说明

**IgnoreIfAlreadyExists**

可选 **Boolean**。 **TRUE** 预配视图,即使文件已存在于指定的 URL 上;否则为 “FALSE”。

**名字**

可选 **Text**。 指定文件的虚拟路径。 路径中不能包含下列字符:

  • `"`

  • `#`

  • `%`

  • `&`

  • `*`

  • `:`

  • `<`

  • `>`

  • `?`

  • `\`

  • `{`

  • `}`

  • `|`

  • `~`

  • “\x7f”

**NavBarHome**

可选 **Boolean**。 如果文件是整个网站使用的顶部导航栏中“主页”链接的目标 URL,则为 “TRUE”。

**路径**

可选 **Text**。 指定相对于 %ProgramFiles%\Common Files\Microsoft Shared\Web 服务器扩展\15\TEMPLATE\Features\Feature 的文件的物理路径。 只能包含下列字符:

  • 字母

  • 连字符 (“-”)

  • 下划线 (“_”)

  • 句点 (“.”)

  • 空格 ( )

**类型**

可选 **Text**。 指定在前端 Web 服务器上的内存中缓存该文件。 可能的值包括“Ghostable”和“GhostableInLibrary”。 这两个值都指定要缓存文件,但 **GhostableInLibrary** 指定将文件作为基类型为 “DocumentLibrary” 的列表的一部分进行缓存。

例如,发生更改时,通过用户界面对主页进行更改,只有与原始页面定义之间的差异被存入数据库,而 default.aspx 则与架构文件一起被缓存在内存中。 显示在浏览器中的 HTML 页面通过由在内存中缓存的原始定义和数据库中存储的更改所生成的组合定义构建而成。

**ReplaceContent**

可选 **Boolean**。 **TRUE**:在父功能升级过程中应用元素清单时,使用新版本覆盖以前安装的文件版本;否则为 FALSE。

**Url**

必需 **Text**。 指定文件的虚拟路径。 如果指定了 “Name” 属性,则其值将用于虚拟路径。 如果未指定 “Path” ,则 “Url” 的值将用于物理路径。 路径中不能包含下列字符:

  • `"`

  • `#`

  • `%`

  • `&`

  • `*`

  • `:`

  • `<`

  • `>`

  • `?`

  • `\`

  • `{`

  • `}`

  • `|`

  • `~`

  • “\x7f”

子元素

AllUsersWebPartBinarySerializedWebPart Element (Module) NavBarPagePropertyViewWebPartConnection Element (Module)

父元素

Module

出现次数

最小值:0

最大值:无限制

示例

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

另请参阅