excel - 将自定义函数添加到现有的 excel 加载项(由 visual studio 生成)

Question

所以我正在为 excel 开发一个加载项。我从 visual studio 生成的模板开始(不是 yeomon，因为用 VS 生成使调试设置更容易)。到目前为止，我已经设置了一些任务 Pane 以通过远程服务器进行身份验证，但现在我在尝试运行自定义函数时遇到了问题。该文档侧重于 yeomon 生成的项目，我已尽力翻译，但我似乎遗漏了一些东西。

到目前为止我做了什么:

为了概念验证，我坚持尝试让 OfficeDev 存储库中提供的示例正常工作 (https://github.com/OfficeDev/Excel-Custom-Functions)。我已将示例 ( https://github.com/OfficeDev/Excel-Custom-Functions/blob/master/src/functions/functions.ts ) 中的 functions.ts 添加到项目的 MyAddInWeb/Custom 目录中。我手动复制了 Functions.json 和通过构建示例生成的 Functions.html 文件，并指向 JSON-URL，JS-URL 和 HTML-URL 在我的 list 中添加到各自的文件路径，并添加了一个 ExtensionPoint xsi:type="CustomFunctions 标签和将 script/page/metadata 标记指向相同的文件。我 list 的相关部分如下所示:

<?xml version="1.0" encoding="UTF-8"?>
<OfficeApp 
          xmlns="http://schemas.microsoft.com/office/appforoffice/1.1" 
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
          xmlns:bt="http://schemas.microsoft.com/office/officeappbasictypes/1.0" 
          xmlns:ov="http://schemas.microsoft.com/office/taskpaneappversionoverrides"
          xsi:type="TaskPaneApp">
...    
  <!--Begin TaskPane Mode integration. This section is used if there are no VersionOverrides or if the Office client version does not support add-in commands. -->
  <Hosts>
    <Host Name="Workbook" />
  </Hosts>
  <DefaultSettings>
    <SourceLocation DefaultValue="~remoteAppUrl/Home.html" />
  </DefaultSettings>
  <!-- End TaskPane Mode integration.  -->

  <Permissions>ReadWriteDocument</Permissions>

  <!-- Begin Add-in Commands Mode integration. -->
  <VersionOverrides xmlns="http://schemas.microsoft.com/office/taskpaneappversionoverrides" xsi:type="VersionOverridesV1_0">

    <!-- The Hosts node is required. -->
    <Hosts>
      <!-- Each host can have a different set of commands. -->
      <!-- Excel host is Workbook, Word host is Document, and PowerPoint host is Presentation. -->
      <!-- Make sure the hosts you override match the hosts declared in the top section of the manifest. -->
      <Host xsi:type="Workbook">
        <!-- Form factor. Currently only DesktopFormFactor is supported. -->
        <AllFormFactors>
          <ExtensionPoint xsi:type="CustomFunctions">
            <Script>
              <SourceLocation resid="Functions.Script.Url"/>
            </Script>
            <Page>
              <SourceLocation resid="Functions.Page.Url"/>
            </Page>
            <Metadata>
              <SourceLocation resid="Functions.Metadata.Url"/>
            </Metadata>
            <Namespace resid="Functions.Namespace"/>
          </ExtensionPoint>
        </AllFormFactors>
        <DesktopFormFactor>
...
        </DesktopFormFactor>
      </Host>
    </Hosts>

    <!-- You can use resources across hosts and form factors. -->
    <Resources>
      <bt:Images>
        <bt:Image id="Contoso.tpicon_16x16" DefaultValue="~remoteAppUrl/Images/Button16x16.png" />
        <bt:Image id="Contoso.tpicon_32x32" DefaultValue="~remoteAppUrl/Images/Button32x32.png" />
        <bt:Image id="Contoso.tpicon_80x80" DefaultValue="~remoteAppUrl/Images/Button80x80.png" />
      </bt:Images>
      <bt:Urls>

        <bt:Url id="JSON-URL" DefaultValue="~remoteAppUrl/Custom/Functions.json"/>
        <bt:Url id="JS-URL" DefaultValue="~remoteAppUrl/Custom/Functions.js"/>
        <bt:Url id="HTML-URL" DefaultValue="~remoteAppUrl/Custom/Functions.html"/>
        <bt:Url id="Functions.Script.Url" DefaultValue="~remoteAppUrl/Custom/Functions.js" />
        <bt:Url id="Functions.Metadata.Url" DefaultValue="~remoteAppUrl/Custom/Functions.json" />
        <bt:Url id="Functions.Page.Url" DefaultValue="~remoteAppUrl/Custom/Functions.html" />
        <bt:Url id="Contoso.DesktopFunctionFile.Url" DefaultValue="~remoteAppUrl/Functions/FunctionFile.html" />
        <bt:Url id="Contoso.Taskpane.Url" DefaultValue="~remoteAppUrl/Home.html" />
        <bt:Url id="Contoso.Callback.Url" DefaultValue="~remoteAppUrl/callback.html" />
        <bt:Url id="Contoso.GetStarted.LearnMoreUrl" DefaultValue="https://go.microsoft.com/fwlink/?LinkId=276812" />
      </bt:Urls>
      <!-- ShortStrings max characters==125. -->
      <bt:ShortStrings>
        <bt:String id="Functions.Namespace" DefaultValue="CONTOSO" />
        <bt:String id="Contoso.TaskpaneButton.Label" DefaultValue="Show Taskpane" />
        <bt:String id="Contoso.Group1Label" DefaultValue="Commands Group" />
        <bt:String id="Contoso.GetStarted.Title" DefaultValue="Get started with your sample add-in!" />
      </bt:ShortStrings>
      <!-- LongStrings max characters==250. -->
      <bt:LongStrings>
        <bt:String id="Contoso.TaskpaneButton.Tooltip" DefaultValue="Click to Show a Taskpane" />
        <bt:String id="Contoso.GetStarted.Description" DefaultValue="Your sample add-in loaded succesfully. Go to the HOME tab and click the 'Show Taskpane' button to get started." />
      </bt:LongStrings>
    </Resources>
  </VersionOverrides>
  <!-- End Add-in Commands Mode integration. -->

</OfficeApp>

这是我遇到的第一个障碍。在 Functions.ts 中，我收到一个 typescript 错误，提示未定义 CustomFunctions 命名空间。不确定样本中的来源。如果我删除类型声明(坏主意，我知道)，加载项构建和显示的自定义函数已注册，但尝试运行它们中的任何一个都会导致 excel 挂起“我们正在启动加载项运行时，请稍等...”片刻，然后我在任务 Pane 中收到一条错误消息，提示加载项无法启动。不幸的是，据我所知，我没有收到任何可用的错误消息，所以我不确定问题出在哪里。如果我不得不猜测， list 中的某些内容没有正确连接，但我不确定。任何帮助将非常感激。到目前为止，文档似乎非常缺乏。

Answer 1

我相信我遇到了同样的问题。对我来说，CustomFunctions 接口(interface)丢失了(如果您在 yo office-generator 中选择自定义函数模板，它会自动添加，但如果您不使用 Excel 自定义函数模板选项，则不会自动添加) .

比较 Excel 自定义函数模板中的 project.json 文件，我添加了 @types/custom-functions-runtime 和 custom-functions-metadata- plugin 包，为我解决了问题。

可以添加以下行:

npm install --save-dev @types/custom-functions-runtimenpm install --save-dev 自定义函数元数据插件