Officeスクリプト 関数の作成｜引数・戻り値・アロー関数

OfficeScripts（オフィススクリプト）で関数の作成方法について紹介します。

ドノ

スクリプト内の関数名・変数名・値などは例が入っていますので状況に応じて変更して使用してください。

関数の作成

まずは関数の基本構文から紹介します。

関数の基本構文

関数の基本構文は下記の通りです。関数名・引数・データ型・処理などを設定することで関数が作成できます。

function 関数名(引数1: データ型, 引数2: データ型, ...): 戻り値のデータ型 {

  // 関数内の処理
  return 戻り値;
}

ドノ

上記は2つですが 関数の引数はいくつでも設定可能です。

関数の具体例

関数は具体例を引数ありなし、戻り値ありなしで紹介します。

引数なし、戻り値なしの関数

下記が具体例です。一番簡単な関数で関数名()で呼び出すことができ 指定の処理の実行だけします。

function sayHello(): void {
  //関数内処理
  console.log("Hello!");
}

実際に上記を用いて下記のスクリプトで関数を実行するとこのような結果となります。

function main(workbook: ExcelScript.Workbook) {
    
    //関数を作成
    function sayHello(): void {
      console.log("Hello!");
    }
    //関数を実行
    sayHello();
}

引数あり、戻り値なしの関数

下記が具体例です。関数名(引数)で呼び出すことができ 引数を利用した処理が行えます。

function greet(name: string): void {
  //関数内処理
  console.log("Hello! "+ name);
}

実際に上記を用いて下記のスクリプトで関数を実行するとこのような結果となります。

function main(workbook: ExcelScript.Workbook) {
    
    //関数を作成
    function greet(name: string): void {
        console.log("Hello! " + name);
    }
    //関数を実行
    greet("Taro");  //引数に"Taro"を設定
}

引数あり、戻り値ありの関数

下記が具体例です。関数名(引数)で呼び出すことができ 処理を行った結果を取得できます。

function addNumbers(a: number, b: number): number {
  return a + b;
}

実際に上記を用いて下記のスクリプトで関数を実行するとこのような結果となります。

function main(workbook: ExcelScript.Workbook) {
  
  //関数を作成
  function addNumbers(a: number, b: number): number {
    return a + b;
  }
  
  //関数を実行
  let result = addNumbers(10,20);  //引数に10と20を設定
  console.log(result)
}

Sponsored link

関数の呼び出し

次に関数の呼び出し方法についてです。

関数の使用方法は非常に簡単で関数名(引数)の形式で記載すればOKです。

下記は作成したaddNumbers()を引数を設定して呼び出している例です。

function main(workbook: ExcelScript.Workbook) {
  
  //関数を作成
  function addNumbers(a: number, b: number): number {
    return a + b;
  }
  
  //関数を実行
  let result = addNumbers(10,20);  //引数に10と20を設定
  console.log(result)
}

結果はこのようになります。

ドノ

Officeスクリプトでは必ずmain関数が必要です。
main関数内で作成した関数は使用するようにしてください

Sponsored link

引数のデフォルト値

関数の引数にはデフォルト値を設定することができます。

下記のように引数 = デフォルト値のように記載すればOKです。

function 関数名(引数1 = デフォルト値1, 引数2 = デフォルト値2, ...) {

  // 関数内の処理
  return 戻り値;
}

下記が具体例です。greet()という関数を作成してデフォルト値を”Guest”としています。

function main(workbook: ExcelScript.Workbook) {
  
  //関数を作成
  function greet(name = "Guest") {
    console.log("Hello! " + name);
  }

  // 関数を実行（引数を渡さない場合）
  greet();

  // 関数を実行（引数を渡した場合）
  greet("Taro");
}

結果はこのようになります。

Sponsored link

アロー関数の作成

次にアロー関数の作成方法について紹介します。アロー関数は関数を簡潔に記述するための構文です。

アロー関数の基本構文

関数の基本構文は下記の通りです。引数・処理内容を設定することで関数が作成できます。

• 引数：引数1, 引数2 ... は関数の引数を表します。
• データ型：データ型は引数のデータ型を表します。
• 矢印：=>はアロー関数を示します。
• 処理内容：関数の処理内容を記述します。

(引数1:データ型, 引数2:データ型, ...) => { 処理内容 }

ドノ

上記は2つですが 関数の引数はいくつでも設定可能です。

アロー関数の具体例

下記が引数a,bを足し合わせるアロー関数の例です。

(a:number, b:number) => { return a + b; }

実際に上記を用いて下記のスクリプトで関数を実行するとこのような結果となります。

function main(workbook: ExcelScript.Workbook) {

    //関数を作成
    let add = (a:number, b:number) => { return a + b; };

    //関数を実行
    console.log(add(2, 3));
}

結果はこのようになります。

Sponsored link