Office Web 小部件 - 实验版概述

警告

Office Web 小组件 - 实验版仅用于研究和反馈目的。 请勿在生产方案中使用。 Office Web 小组件行为可能会在将来版本中发生重大变化。 阅读和审阅 Office Web 小组件 - 实验版许可条款

“Office Web 小组件 - 实验版”等客户端控件可以大大减少构建加载项所需的时间，同时提高加载项的质量。为实现这一点，我们必须确保小组件满足以下条件：

小组件必须：

• 设计为用于任何网页，即使该页面未托管在 SharePoint 上。

• 在 Office 控件运行时内工作 这样我们就可以提供一套通用要求和一致的语法来使用小组件。

• 使用跨域库重新与 SharePoint 通信。 小组件不会依赖于特定的服务器端平台或技术，不论你选择何种服务器技术，均可使用小组件。

• 与页面上的其他元素共存。 页面上的小组件包含不应修改其中的其他元素。

• 与现有框架完美运行。 我们希望确保您仍可使用习惯的工具和技术。

使用 Office Web 小组件 - 实验版的加载项

可以通过安装来自 Visual Studio 的 Office Web 小组件 - 实验版 NuGet 包使用小组件。 有关详细信息，请参阅 NuGet 包管理器 UI。 也可以浏览 NuGet 库页面。

你的反馈和评论可帮助我们决定提供哪些小组件。 如上图所示，(1) 人员选取器和 (2) 桌面列表视图小组件都已经准备好供你试用。 请保留 来自 Office 开发人员平台 UserVoice 站点的反馈。

也可以在 Office Web 小组件 - 实验版演示代码示例中查看该小组件的实际演练。

“人员选取器”小组件

您可以在外接程序中使用实验性“人员选取器”小部件，帮助您的用户查找和选择租户中的人员和组。 用户可以开始在文本框中键入内容，小部件将检索名字或电子邮件与用户所键入文本匹配的人员。

用于解析查询的“人员选取器”小组件

可以在 HTML 标记中声明小组件，也可以使用 JavaScript 以编程方式声明。 在任一情况下，都可以使用 div 元素作为小组件的占位符。 此外，还可以设置“人员选取器”小组件的属性和事件处理程序。 下表显示“人员选取器”小组件中的可用属性和事件。

属性/事件	类型	说明
objectType	JSON Object (list of strings)	小部件将解析的项目的类型。 选项：用户组默认为仅限用户。
allowMultipleSelections	Boolean	True/False。 如果为 False，小组件应允许一次仅选择一项。 默认值为 False。
rootGroupName	String	如果提供，小组件会将选择限制为此组中的项。 如果未提供，小组件会从整个租赁中查询对象。
selectedItems	JSON 数组	所选项列表。 每个项返回一个表示用户或组的对象。
onAdded	函数	将新对象添加到选择时触发的事件。 收到添加的对象的处理程序函数。
onRemoved	函数	将新对象从选择中删除时触发的事件。 收到删除的对象的处理程序函数。
onChange	函数	添加或删除对象都会触发此事件。 不向处理程序函数传递任何参数。
validationErrors	Array	可能的验证错误的数组：empty、unresolvedItem、tooManyItems
autoShowValidationMessage	Boolean	True=显示 False=不显示
hasErrors	Boolean	True=存在 1 个或多个验证错误 False=不存在验证错误
errors	Array	可能的验证错误的数组：empty、unresolvedItem、tooManyItems
displayErrors	Boolean	True=显示错误 False=不显示错误

"人员选取器"小部件的 CSS 类在 Office.Controls.css 样式表中定义。 您可以覆盖类并确定外接程序的小部件的样式。

有关详细信息，请参阅在 SharePoint 外接程序中使用试验性人员选取器小组件和在外接程序代码示例中使用人员选取器实验小组件。

“桌面列表视图”小部件

您的用户可以受益于"列表视图"小部件，并像常规"列表视图"小部件一样显示数据，但您可以将其用于不必在 SharePoint 中托管的外接程序。

显示列表中的数据时的“桌面列表视图”小组件

可以指定列表上的现有视图，该小组件将按字段在此视图中的显示顺序来显示这些字段。

注意

此时，“桌面列表视图”小组件仅显示数据。 它不提供编辑功能。

您可以使用 div 元素为小部件提供占位符。 您可以编程方式或声明方式使用小部件。

您还可以为"桌面列表视图"小部件设置属性或事件处理程序。 下表显示了"桌面列表视图"小部件中的可用属性和事件。

属性/事件	类型	说明
listUrl	URL	从中拉取项的列表视图的 URL。 它可以是假定位于加载项 Web 本身的相对 URL，也可以是绝对 URL。
viewName	String	要显示的视图名称。 这是视图的编程名称（不是其显示名称）。
onItemSelected	函数	选定列表上的项时触发的事件。
onItemAdded	函数	将新项添加到列表时触发的事件。
onItemRemoved	函数	从列表删除项时触发的事件。
selectedItems	Array	JSON 格式的选定项列表。

小部件需要 SharePoint 网站样式表。 您可以直接引用 SharePoint 样式表，或使用部件版式小部件。 有关样式表的详细信息，请参阅 在 SharePoint 外接程序中使用 SharePoint 网站的样式表 和 在 SharePoint 外接程序中使用客户端版式控件。

若要查看运行中的“列表视图”小组件，请参阅在加载项中使用“桌面列表视图”实验版小组件代码示例。 另请参阅在 SharePoint 加载项中使用实验版桌面列表视图小组件

小组件有助于加速开发过程、降低加载项的成本并缩短上市时间。“Office Web 小组件 - 实验版”可提供用于非生产加载项的小组件。欢迎你在 Office 开发人员平台 UserVoice 网站上提供反馈和意见。

另请参阅

• 在 SharePoint 中创建 UX 组件