使用模块包括解决方案中的文件

有时您可能希望将文件部署到 SharePoint Server,而不管文件的类型如何(如新母版页)。 为此,可以使用模块(不要与 Visual Basic 代码模块混淆)。 模块是 SharePoint 解决方案中的文件容器。 在部署解决方案时,模块中的文件将复制到 SharePoint Server 上的指定文件夹中。

模块项和元素

若要创建模块,请通过在**“添加新项”**对话框中选择模块来将它添加到项目中。 然后,修改模块的 Elements.xml 文件以包含要部署的文件的名称、这些文件在系统上的位置以及应将这些文件复制到 SharePoint Server 上的位置。

下面是模块的 Elements.xml 文件的示例:

<?xml version="1.0" encoding="utf-8"?>

<Elements xmlns="https://schemas.microsoft.com/sharepoint/">

<Module Name="Module1">

<File Path="Module1\Sample.txt" Url="Module1/Sample.txt" />

</Module>

</Elements>

新创建的模块包含以下默认文件:

文件名

说明

Elements.xml

模块的定义文件。

Sample.txt

用作模块中的文件示例的占位符文件。

Elements.xml 文件包含以下元素:

元素名称

说明

Elements

包含模块中定义的所有元素。

模块

Module 元素只有一个 Name 特性,该特性以 <Module Name="Module1"> 格式指定模块的名称。

注意注意
如果更改模块的名称(或其 Folder Name 属性),则必须在 Module 元素中手动更新该名称。

如果在 Module 元素中为文件指定子目录,则 Windows SharePoint Services (WSS) 将自动为这些文件创建匹配的目录结构。

文件

File 元素有两个参数,即 Path 和 Url。

特性名说明
路径该文件在 SharePoint 解决方案中的名称和位置。格式为 Path="Module1\Sample.txt"。
Url在 SharePoint Server 上要将该文件部署到的位置。格式为 Url="Module1/Sample.txt"。
类型一个可选特性,它有两个设置:GhostableInLibrary 和 Ghostable。格式为 Type="GhostableInLibrary"。指定 GhostableInLibrary 意味着,该文件将与一个列表项一起添加到 SharePoint 中的文档库中,从而使添加到库中的文件伴随有一个列表项。指定 Ghostable 会导致将该文件添加到 SharePoint 中的文档库外部。

要部署的每个文件都要在 Elements.xml 中具有单独的 <File> 元素项。

请参见

任务

如何:使用模块包括文件

其他资源

如何:设置文件

开发 SharePoint 解决方案

为 SharePoint 创建 Web 部件

打包和部署 SharePoint 解决方案