[Officeアドイン]Excel Custom functionsの紹介

ホーム
Office アドイン, Office関連, Office 2016
[Officeアドイン]Excel Custom functionsの紹介

2017.12.10

[Officeアドイン]Excel Custom functionsの紹介

Office 365 Advent Calendar

2017年12月、今年もAdvent Calendarの季節がやってきました。
昨年は「Office 365 Advent Calendar 2016」に参加させていただきましたが(下記記事参照)、今年も同じく「Office 365 Advent Calendar 2017」に参加させていただきます。

2016.12.02

Microsoft Graph JavaScript SDKを使ってOffice 365 APIを簡単に呼び出す方法

Office 365 Advent Calendar 2016 今年もアドベントカレンダー(Advent calendar)の季節がやってまいりました。 Office Development MVPとして、今年は「Office 365 Advent C...

2016.12.16

Visio Onlineの機能をJavaScriptで拡張する方法

@mokudaiさんからのバトンを引き継ぎまして、「Office 365 Advent Calendar 2016」、16日目の記事を書かせていただきます。 (2日目に書いた記事は下記参照) 今回取り扱うのは「Visio」です。 Visi...

Excel Custom functions

今回紹介するのはExcelの新機能、Custom functionsです。

Dev Preview – Custom Functions in Excel. Get all the details and try custom functions for yourself at https://t.co/7cl81IA8jc #Office365 pic.twitter.com/jMO5GO9Ig7

— Office Developer (@OfficeDev) 2017年11月6日

上記ツイートの動画を見ると何となく何をやっているかが分かると思いますが、Excel Custom functionsは、早い話が“ユーザー定義関数のようにワークシート上から使える独自関数を、JavaScriptで定義できる機能”です。
(「Office 365 Advent CalendarなのにOffice 365関係ないじゃん！？」と思われる方もいらっしゃるかもしれませんが、動作検証に使っているのはOffice 365 Enterprise E3のInsider版Excelを使っているので、一応関わりがあるということで・・・。)

Office 2016 Insiderビルドのインストール

現時点(2017年12月)では、Custom functions機能はExcel 2016 バージョン 16.8711 以降でないと使えないため、InsiderビルドのOfficeをインストールする必要があります。

インストール方法は「Office 365 の商用ユーザーが Office 2016 の新機能にいち早くアクセスする方法」に書いてある通りで、「Office Deployment Tool」を使って、設定ファイル指定でOfficeをインストールします。

設定ファイル例(configuration.xml)

<Configuration>
  <Add OfficeClientEdition="32" Channel="InsiderFast">
    <Product ID="O365ProPlusRetail">
      <Language ID="ja-jp" />
    </Product>
  </Add>
</Configuration>

Custom functions用Office アドインの作成

Custom functionsの開発方法はOffice アドインと全く同じで、マニフェストファイル、アドイン本体となるWebページ、JavaScriptファイル、この3つを用意する必要があります。

Office アドインの開発方法についてはここでは深く解説しませんので、下記記事等をご参照ください。

2012.11.01

Office用アプリ(apps for Office)の概要と開発方法

当ブログでもカテゴリー:JavaScript API for OfficeでOffice用アプリ関連の技術情報を紹介していますが、Office 2013 RTMリリースに伴って、改めてOffice用アプリ(apps for Office)の概要と開発方法につい...

2015.09.29

OfficeJS Snippet Explorerを使って新しいOffice アドインを体験する。

前回の記事と打って変わって元のOffice アドインの記事に戻ります(“Office アドインってなに？”という方はコチラの記事をご参照ください)。さて、先日書いた記事「Office 2016で進化したOffice アドイン」でOffice アドイ...

2017.02.28

YO OFFICE(Yeoman)を使ってOffice アドインのひな型を作成する方法

Webアプリのひな型を一発で作ってくれる便利ツール「Yeoman」には、Office アドイン用のGenerator「YO OFFICE」が用意されています。今回はこのGeneratorを使ってOffice アドインのひな型を作成する方法を紹介します。...

マニフェストファイル(manifest.xml)

SourceLocation要素やbt:Url要素で、アドイン本体となるWebページとJavaScriptファイルを指定しています。
また、Id要素の値は、Generate GUIDs online等で作成した、新しいGUIDに置き換える必要があります。

<?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">
  <Id>ed75112a-f94f-43d9-bb73-0889225ae851</Id>
  <Version>1.0.0.0</Version>
  <ProviderName>kinuasa</ProviderName>
  <DefaultLocale>ja-JP</DefaultLocale>
  <DisplayName DefaultValue="Custom functions sample" />
  <Description DefaultValue="Custom functionsのサンプルアドインです。" />
  <Hosts>
    <Host Name="Workbook" />
  </Hosts>
  <DefaultSettings>
    <SourceLocation DefaultValue="https://localhost/customfunctions/customfunctions.html"/>
  </DefaultSettings>
  <Permissions>ReadWriteDocument</Permissions>
  <VersionOverrides xmlns="http://schemas.microsoft.com/office/taskpaneappversionoverrides" xsi:type="VersionOverridesV1_0">
    <Hosts>
      <Host xsi:type="Workbook">
        <AllFormFactors>
          <ExtensionPoint xsi:type="CustomFunctions">
            <Script>
              <SourceLocation resid="functionsjs" />
            </Script>
            <Page>
              <SourceLocation resid="functionshtml"/>
            </Page>
          </ExtensionPoint>
        </AllFormFactors>
      </Host>
    </Hosts>
    <Resources>
      <bt:Urls>
          <bt:Url id="functionsjs" DefaultValue="https://localhost/customfunctions/customfunctions.js" />
          <bt:Url id="functionshtml" DefaultValue="https://localhost/customfunctions/customfunctions.html" />
      </bt:Urls>
    </Resources>
  </VersionOverrides>
</OfficeApp>

アドイン本体(customfunctions.html)

Webページの内容は非常にシンプルで、単にJavaScriptを読み込んでいるだけです。
(Custom functionsがまだPreview段階であるため、使用するライブラリもbeta版のものを読み込んでいます。)

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8" />
  <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
  <meta http-equiv="Expires" content="0" />
  <title>Custom functions sample</title>
  <!-- <script src="https://appsforoffice.microsoft.com/lib/1/hosted/office.js"></script> -->
  <!-- <script src="https://appsforoffice.microsoft.com/lib/beta/hosted/office.js"></script> -->
  <script src="https://appsforoffice.edog.officeapps.live.com/lib/beta/hosted/office.js"></script>
  <script src="customfunctions.js"></script>
</head>
<body></body>
</html>

JavaScriptファイル

関数本体となるJavaScriptファイルで、ここで独自関数を定義します。
下記コードでは、2つの数値に100を足した値を返す独自関数「ADD100」を定義しています。

Office.initialize = function(reason){
    Excel.Script.CustomFunctions = {};
    Excel.Script.CustomFunctions["CONTOSO"] = {};
    
    function add100 (a, b) {
        return a + b + 100;
    }
    
    Excel.Script.CustomFunctions["CONTOSO"]["ADD100"] = {
        call: add100,
        description: "2つの数値に100を足した値を返します。",
        helpUrl: "https://localhost/help.html",
        result: {
            resultType: Excel.CustomFunctionValueType.number,
            resultDimensionality: Excel.CustomFunctionDimensionality.scalar,
        },
        parameters: [
            {
                name: "num 1",
                description: "最初の数値",
                valueType: Excel.CustomFunctionValueType.number,
                valueDimensionality: Excel.CustomFunctionDimensionality.scalar,
            },
            {
                name: "num 2",
                description: "2番目の数値",
                valueType: Excel.CustomFunctionValueType.number,
                valueDimensionality: Excel.CustomFunctionDimensionality.scalar,
            }
        ],
        options:{ batch: false, stream: false }
    };
    
    Excel.run(function (context) {
        context.workbook.customFunctions.addAll();
        return context.sync().then(function(){});
    }).catch(function(error){});
};