Module Element (Module)
Specifies files with which to provision SharePoint Web sites within an element manifest.
<Module HyperlinkBaseUrl = string IncludeFolders = "Text" List = "Integer" Name = "Text" Path = "Text" RootWebOnly = "TRUE" | "FALSE" SetupPath = "Text" Url = "Text"> </Module>
Attribute | Description |
|---|---|
HyperlinkBaseUrl | Optional string. Specifies an absolute URL to use as the base URL for hyperlinks. |
IncludeFolders | Optional Text. |
List | Optional Integer. Specifies the type of list, which is defined within Onet.xml. |
Name | Required Text. Contains the name of the file set. Can only contain the following characters:
|
Path | Optional Text. Specifies the physical path to the file set relative to %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\Features\Feature. Can only contain the following characters:
|
RootWebOnly | Optional Boolean. TRUE if the files specified in the module are installed only in the top-level Web site of the site collection. |
SetupPath | Optional Text. Specifies the physical path to a folder in the SharePoint Foundation setup directory %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE) that contains a file to include in the module. Can only contain the following characters:
|
Url | Optional Text. Specifies the virtual path of the folder in which to place the files when a site is instantiated. If Path is not specified, the value of Url is used for the physical path. Use the Url attribute to provision a folder through the Feature. The Url attribute cannot contain the following characters:
|
Minimum: 0 Maximum: Unbounded |
The Module element specifies a file or collection of files and a location where the files are installed during site creation. If the file is a Web Part Page, the module definition can specify which Web Parts should be included on the page.