SharePoint使用命令集扩展自定义列表功能

前端

2023-12-27 07:03:59

增强 SharePoint 列表功能：使用命令集扩展列表

使用命令集自定义 SharePoint 列表

SharePoint 命令集是一种强大的功能，允许用户通过创建自定义命令来扩展 SharePoint 列表的功能，从而可以执行广泛的操作，例如启动外部进程或运行自定义脚本。这些命令集可以显著增强用户体验，简化任务并提高工作效率。

构建命令集的步骤

构建命令集涉及以下步骤：

1. 配置 SPFx 解决方案

创建一个新的 SharePoint Framework（SPFx）解决方案。
添加一个新的 Web 部件文件（例如 CustomListCommandSet.tsx）。
在 Web 部件文件中，定义命令集，包括标题、图标 URL 和单击事件处理程序。

2. 创建 JSOM 代码

创建一个新的 JSOM 文件（例如 CustomListCommandSet.js）。
使用 SP.SOD.executeOrDelayUntilScriptLoaded() 方法确保在加载必要脚本后执行 JSOM 代码。
使用 SP.List.getShareableObject() 方法获取列表对象。
使用 SP.List.addCommandSet() 方法将命令集添加到列表中。

部署 SPFx 解决方案

使用 Yeoman 或 gulp 打包 SPFx 解决方案。
将打包后的解决方案上传到 SharePoint 网站。
激活解决方案。

使用命令集增强列表

一旦部署了命令集，用户就可以在列表中访问它们。例如：

打开外部进程： 命令可打开外部应用程序或执行特定操作。
执行自定义脚本： 命令可运行自定义 JavaScript 代码，允许执行复杂的操作。

示例代码

以下是向列表添加命令集的 JSOM 代码示例：

SP.SOD.executeOrDelayUntilScriptLoaded(() => {
  SP.List.getShareableObject(context, hostUrl, listId, function (list) {
    list.addCommandSet({
      title: "Custom Command Set",
      commands: [
        {
          title: "Open External Process",
          iconUrl: "https://contoso.com/icon.png",
          onclick: function () {
            // Code to open an external process
          }
        },
        {
          title: "Execute Custom Script",
          iconUrl: "https://contoso.com/icon.png",
          onclick: function () {
            // Code to execute a custom script
          }
        }
      ]
    });
  });
}, "sp.js");