File Element (Module)

Article
06/29/2022

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Specifies a file to include within a module in a site definition.

Definition

<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>

Elements and attributes

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute	Description
IgnoreIfAlreadyExists	Optional Boolean. TRUE to provision the view even if the file already exists at the specified URL; otherwise, FALSE.
Name	Optional Text. Specifies the virtual path for the file. Cannot contain the following characters: `"` `#` `%` `&` `*` `:` `<` `>` `?` `\` `{` `}` `\|` `~` `\x7f`
NavBarHome	Optional Boolean. TRUE if the file is the destination URL for the Home link in the top navigation bar used throughout the site.
Path	Optional Text. Specifies the physical path to the file relative to %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\Features\Feature. Can only contain the following characters: alphanumeric hyphen (`-`) underscore (`_`) period (`.`) space ( )
Type	Optional Text. Specifies that the file be cached in memory on the front-end Web server. Possible values include Ghostable and GhostableInLibrary. Both values specify that the file be cached, but GhostableInLibrary specifies that the file be cached as part of a list whose base type is DocumentLibrary. When changes are made, for example, to the home page through the UI, only the differences from the original page definition are stored in the database, while default.aspx is cached in memory along with the schema files. The HTML page that is displayed in the browser is constructed through the combined definition resulting from the original definition cached in memory and from changes stored in the database.
ReplaceContent	Optional Boolean. TRUE to overwrite the previously installed version of the file with a new version when the element manifest is being applied as part of an upgrade of the parent Feature; otherwise FALSE.
Url	Required Text. Specifies the virtual path for the file. If the Name attribute is specified, its value is used for the virtual path. If Path is not specified, the value of Url is used for the physical path. Cannot contain the following characters: `"` `#` `%` `&` `*` `:` `<` `>` `?` `\` `{` `}` `\|` `~` `\x7f`

Child elements

AllUsersWebPart, BinarySerializedWebPart Element (Module), NavBarPage, Property, View, WebPartConnection Element (Module)

Parent elements

Module

Occurrences

Minimum: 0

Maximum: Unbounded

Example

For an example of how this element is used, see Modules.

Attribute	Description
IgnoreIfAlreadyExists	Optional Boolean. TRUE to provision the view even if the file already exists at the specified URL; otherwise, FALSE.
Name	Optional Text. Specifies the virtual path for the file. Cannot contain the following characters: `"` `#` `%` `&` `*` `:` `<` `>` `?` `\` `{` `}` `\|` `~` `\x7f`
NavBarHome	Optional Boolean. TRUE if the file is the destination URL for the Home link in the top navigation bar used throughout the site.
Path	Optional Text. Specifies the physical path to the file relative to %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\Features\Feature. Can only contain the following characters: alphanumeric hyphen (`-`) underscore (`_`) period (`.`) space ( )
Type	Optional Text. Specifies that the file be cached in memory on the front-end Web server. Possible values include Ghostable and GhostableInLibrary. Both values specify that the file be cached, but GhostableInLibrary specifies that the file be cached as part of a list whose base type is DocumentLibrary. When changes are made, for example, to the home page through the UI, only the differences from the original page definition are stored in the database, while default.aspx is cached in memory along with the schema files. The HTML page that is displayed in the browser is constructed through the combined definition resulting from the original definition cached in memory and from changes stored in the database.
ReplaceContent	Optional Boolean. TRUE to overwrite the previously installed version of the file with a new version when the element manifest is being applied as part of an upgrade of the parent Feature; otherwise FALSE.
Url	Required Text. Specifies the virtual path for the file. If the Name attribute is specified, its value is used for the virtual path. If Path is not specified, the value of Url is used for the physical path. Cannot contain the following characters: `"` `#` `%` `&` `*` `:` `<` `>` `?` `\` `{` `}` `\|` `~` `\x7f`

Share via