Excel JavaScript API を使用して範囲を取得する

  • [アーティクル]

この記事では、Excel JavaScript API を使用してワークシート内の範囲を取得するさまざまな方法を示す例を示します。 オブジェクトがサポートする Range プロパティとメソッドの完全な一覧については、「 Excel.Range クラス」を参照してください。

注:

Excel JavaScript API には、"Cell" オブジェクトまたはクラスがありません。 代わりに、Excel JavaScript API はすべての Excel セルを Range オブジェクトとして定義します。 Excel UI の個々のセルは、Excel JavaScript API の 1 つのセルを持つ Range オブジェクトに変換されます。 1 つの Range オブジェクトに複数の連続したセルを含めることもできます。 詳しくは、「Excel JavaScript API を使用したセルの操作」を参照してください。

アドレスによって範囲を取得する

次のコード サンプルは、Sample という名前のワークシートからアドレス B2:C5 の範囲を取得し、そのプロパティをaddress読み込み、コンソールにメッセージを書き込みます。

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    
    let range = sheet.getRange("B2:C5");
    range.load("address");
    await context.sync();
    
    console.log(`The address of the range B2:C5 is "${range.address}"`);
});

名前によって範囲を取得する

次のコード サンプルは、Sample という名前のワークシートからという名前MyRangeの範囲を取得し、そのプロパティをaddress読み込み、コンソールにメッセージを書き込みます。

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");

    let range = sheet.getRange("MyRange");
    range.load("address");
    await context.sync();

    console.log(`The address of the range "MyRange" is "${range.address}"`);
});

使用範囲を取得する

次のコード サンプルは、 Sample という名前のワークシートから使用範囲を取得し、そのプロパティを address 読み込み、コンソールにメッセージを書き込みます。 使用範囲とは、値または書式設定が割り当てられているワークシート内のセルを含む、最小の範囲です。 ワークシート全体が空白の場合、 getUsedRange() メソッドは左上のセルのみで構成される範囲を返します。

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");

    let range = sheet.getUsedRange();
    range.load("address");
    await context.sync();
    
    console.log(`The address of the used range in the worksheet is "${range.address}"`);
});

範囲全体を取得する

次のコード サンプルは、 Sample という名前のワークシートからワークシート範囲全体を取得し、そのプロパティを address 読み込み、コンソールにメッセージを書き込みます。

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");

    let range = sheet.getRange();
    range.load("address");
    await context.sync();
    
    console.log(`The address of the entire worksheet range is "${range.address}"`);
});

関連項目