通过

在 Visual Studio 中创建 SharePoint 加载项

  • 项目

可以在 vsnv 中使用新的项目模板和项目项模板开发 SharePoint 加载项。

项目模板

在 Visual Studio 中使用项目模板可以创建一个解决方案，其中包含项目类型需要的项目项和文件。 如果展开“Office/SharePoint”节点并选择“加载项”节点，可以在“新项目”对话框中看到下列项目模板。 若要了解“SharePoint 解决方案”节点下的项目模板，请参阅 SharePoint 项目模板和项目项模板。

Office 加载项

创建托管于 Office 应用（如 Excel 或 Outlook）的网页。 Office 加载项在文档或 Outlook 项中提供更多内容和功能。

有关详细信息，请参阅 Office 加载项平台概述。

SharePoint 加载项

基于您在向导中指定的信息创建一个 SharePoint 外接程序。 此信息包括以下数据。

  • 加载项的名称。
  • 要用于调试您的加载项的本地或远程 SharePoint 网站。
  • 要创建的加载项类型：提供程序托管加载项或 SharePoint 托管加载项。

有关详细信息，请参阅 SharePoint 加载项。

项目项模板

在创建 SharePoint 解决方案后，您可以使用以下模板（显示在"Office/SharePoint"节点下的"添加新项"对话框中）向其中添加项目项。

Office 加载项

向 SharePoint 加载项添加 Office 加载项。 可以添加任务窗格加载项、内容加载项或邮件加载项。

有关详细信息，请参阅 Office 加载项平台概述。

客户端 Web 部件（主机 Web）

将客户端 Web 部件添加到您的 SharePoint 外接程序中。 通过添加客户端 Web 部件，您可以在宿主网站页面上显示加载项。 此模板包含一个 Elements.xml 文件，其属性定义客户端 Web 部件的下列元素。

属性名称 说明
ClientWebPart 指定客户端 Web 部件的名称、标题、描述和尺寸。
Content 定义页面在客户端 Web 部件内的呈现位置。 此元素有下列两个属性：Type 和 Src。
Type 指定要创建的 Web 部件类型（如 HTML）。
Src 定义页面在客户端 Web 部件内的呈现位置。
模板使用 PropertyName 模式在查询字符串中引用属性（如 Src="~addinWebUrl/Pages/ClientWebPart1.aspx?Property1=_property1_"）

有关详细信息，请参阅创建与 SharePoint 加载项一起安装的加载项部件。

内容类型

将一个内容类型添加到您的 SharePoint 外接程序，类似于在 SharePoint 早期版本中使用的内容类型。 一个内容类型是 SharePoint 列表或库中一个项目类别的一组元数据、工作流和行为。 例如，一个项是一种列表内容类型。 其他列表内容类型包括公告、联系人和任务，而且它们从项目内容类型继承。 联系人内容类型包含栏，如"名字"、"姓氏"及"职位"。

When you add a content type to your SharePoint Add-in, you specify the base content type from which the new content type inherits. 例如，可以继承自公告、联系人、文档或项内容类型。 然后，使用内容类型设计器，为内容类型和它的其他属性（如名称和说明）配置列。 选择的值会添加到 Elements.xml 文件的 ContentType 和 FieldRef 元素中。

有关详细信息，请参阅构建基块：SharePoint 2010 内容类型。

空元素

将空元素的一个项目项添加到您的 SharePoint 外接程序。 此项目项包含单个文件 Elements.xml，您在其中定义元素的属性。 您通常使用空元素来定义 Visual Studio 不为其提供模板的项。

列表

向 SharePoint 加载项添加下列两个项目项：列表定义和列表实例。 向加载项添加列表时，应指定列表名称，以及是创建空白列表，还是在现有列表类型的基础之上创建列表。 还应指定能否自定义列表。 然后，使用列表设计器，为列表和其他属性（如列表名称和说明）配置列和视图。

若要详细了解列表属性，请参阅 ListTemplate 元素（列表模板）和 ListInstance 元素（列表实例）。

向列表菜单添加操作，添加可扩展主机网站 UI 的项目项。 菜单自定义操作包含用于定义操作属性的 Elements.xml 文件。

有关详细信息，请参阅创建与 SharePoint 加载项一起部署的自定义操作。

模块

将一个模块项目项添加到您的 SharePoint 外接程序。 模块基本上是容器，您可以在部署您的 SharePoint 外接程序时用它来包含其他文件。 若要添加一个文件，将其复制到"解决方案资源管理器"中的模块下的项目中。 对该文件的引用将自动添加到模块的 Elements.xml 文件中，并且该引用指定新文件的路径和 URL。 您可以删除模块附带的 Sample.txt 文件，因为它仅用作示例。

远程事件接收器

向 SharePoint 加载项添加远程事件接收器项目项，并向解决方案添加 Web 应用项目（如果尚无此类项目的话）。 Web 应用中的 Web 服务与 SharePoint 加载项中的远程事件接收器相关联。 Web 服务中的 Visual Basic 或 Visual C# 代码文件在 SharePoint 加载项中发生列表、列表项或 Web 项事件时执行。 若有 Web 应用，它便与 SharePoint 加载项相关联，Web 服务也会添加到此应用中。

有关详细信息，请参阅处理 SharePoint 加载项中的事件。

功能区自定义操作

向功能区添加操作，添加可扩展主机网站 UI 的项目项。 功能区自定义操作包含用于定义操作属性的 Elements.xml 文件。

有关详细信息，请参阅创建与 SharePoint 加载项一起部署的自定义操作。

搜索配置

添加一个项目项，使您可以导入从某个 SharePoint 网站导出的自定义搜索配置设置。

网站列

向 SharePoint 加载项添加网站列项目项。 网站列包含定义网站列的 Field 属性的 Elements.xml 文件，具体包含以下数据。

属性名 说明
ID 该网站栏的唯一 GUID 值。
名称 用于引用该网站栏的唯一名称。
DisplayName 在 UI 中显示的友好名称。
类型 基于 SPFieldType 的网站栏的数据类型，如布尔、查找或文本。
必需 如果栏是必需的，该属性将设置为 True；否则，该属性将设置为 False。
Group 指定网站栏所分配到的组的名称。 此属性的默认值是“自定义网站栏”。

有关详细信息，请参阅构建基块：列和字段类型。

工作流

向 SharePoint 加载项添加 Microsoft Azure 工作流项目项。 有关详细信息，请参阅 SharePoint 中的工作流。

添加此类型的项时，应指定工作流名称，以及是列表工作流，还是网站工作流。 顾名思义，列表工作流仅适用于列表，而网站工作流则仅适用于 SharePoint 网站。 创建工作流时，还应指定是否自动将工作流与列表和库相关联；如果是，关联到哪些列表和库。 对于添加的每个关联，都会向工作流项目添加相应的文件。 工作流包含以下文件。

文件名 说明
Elements.xml 指定工作流的配置及其包含的文件，例如 workflow.xaml 文件和关联文件以及每个文件的属性，如其 URL、类型和路径。 对于添加到工作流项目的每个文件，会将一个相应的节添加到工作流的 Elements.xml 文件。 列表工作流中的关联文件要求一个列表，所以它们有对列表令牌的引用。 在网站工作流中，为该网站添加了一个 GUID。 谨慎 由于 Visual Studio 维护Elements.xml文件中的项，因此建议不要更改它，除非你熟悉更改的影响。
Workflow.xaml 表示工作流的设计器。 在此文件中，您将操作添加到工作流并设置其代码和属性。
WorkflowStartAssociation 在 SharePoint 上手动启动工作流。 如果您在工作流向导中选中“用户手动启动工作流”复选框，此文件将添加到工作流项目。
ItemAddedAssociation 如果用户在网站或列表（根据工作流类型）中创建项时存在一个工作流，将自动启动该工作流。 如果您在工作流向导中选中“添加项时自动启动工作流”复选框，此文件将添加到工作流项目。
ItemUpdatedAssociation 如果用户在网站或列表（根据工作流类型）中更改项时存在一个工作流，将自动启动该工作流。 如果您在工作流向导中选中“更改项时自动启动工作流”复选框，此文件将添加到工作流项目。
WorkflowHistoryList 表示添加到工作流项目中的文件（如果您在工作流向导中创建工作流的历史记录列表）。
WorkflowTaskList 表示添加到工作流项目中的文件（如果您在工作流向导中创建工作流的任务列表）。

工作流自定义活动

向 SharePoint 加载项添加工作流自定义活动项目项。 通过添加工作流自定义活动，可以创建其他工作流操作，然后能够在 SharePoint Designer 中将它们导入为自定义操作。 工作流自定义活动包含定义操作属性的 Elements.xml 文件，以及工作流设计器的 .xaml 文件。

有关详细信息，请参阅 SharePoint 中的工作流。

另请参阅