文字列の置換

今回はオフィススクリプトを使って、特定の文字列を別の文字列へ置換する方法と、うまく置換できない場合の注意点をサンプルコードと併せて解説します。

利用するメソッド

Stringオブジェクトに含まれている、replaceメソッドを使用します。

VBA ではReplace関数を使用して、対象となる文字列、置換対象の文字列、置き換える文字列の 3 つの引数を指定していたと思いますが、オフィススクリプトでは対象の文字列に対して直接メソッドを実行します。

replaceメソッドの詳細

/**
 * @param searchValue 置換対象となる文字列
 * @param replaceValue 置き換える文字列
 */
replace(searchValue: string | RegExp, replaceValue: string): string;

元の文字列は変更されない

注意していただきたいのは、_このメソッドを実行しても元の文字列は変更されない_という点です。

あくまでこのメソッドの返り値として、置換後の文字列が返却されます。置換結果を使う場合は、返り値を変数に代入してください。

元の文字列は変更されない

let target = '朝食にパンを食べました';

let replaced = target.replace('パン', 'ご飯');

console.log(target); // 朝食にパンを食べました
console.log(replaced); // 朝食にご飯を食べました

特定の文字列を削除したい場合は、第二引数に空文字('')を指定します。

VBA との違い: 置換されるのは最初の 1 箇所のみ

VBA のReplace関数は、既定で一致したすべての箇所を置換します。

一方、replaceメソッドの第一引数に文字列を指定した場合、置換されるのは最初に一致した 1 箇所のみです。 一致したすべての箇所を置換したい場合は、gフラグを付けた正規表現を指定します。

すべての箇所を置換する

const target = 'リンゴとリンゴ';

console.log(target.replace('リンゴ', 'バナナ')); // バナナとリンゴ
console.log(target.replace(/リンゴ/g, 'バナナ')); // バナナとバナナ

第一引数には正規表現を指定することもできます。

正規表現正規表現を使った文字列の一致チェックや、文字列の置換・分割など、Officeスクリプトにおける正規表現の体系的な使用方法について解説します。

正規表現のgフラグを切り替えると、置き換わる箇所が変わることを確かめられます。

パターン//

フラグ

g（すべての一致）i（大文字・小文字を区別しない）

対象の文字列置き換える文字列

一致した箇所2 箇所

リンゴとリンゴ

• メソッドが使う一致
• 使われない一致

結果target.replace(/リンゴ/, 'バナナ')→'バナナとリンゴ'

• g フラグがないため、置き換わるのは最初の 1 箇所だけです（ほかに 1 箇所一致しています）。

パターンや文字列を変えて、一致する箇所と結果を確かめてみましょう。

サンプルコード

対象となる文字列を指定し、置換結果を別の変数に格納するサンプルコードです。

文字列の置換のサンプル

function main(workbook: ExcelScript.Workbook) {
  /** 対象文字列 */
  const target = '好きな果物はリンゴです';

  /** 置換後の文字列 */
  const replaced = target.replace('リンゴ', 'バナナ');

  console.log(replaced); // 好きな果物はバナナです
}