ExcelScript.WorkbookRangeAreas interface

リファレンス

パッケージ:: ExcelScript

複数のワークシート内の 1 つまたは複数の四角形の範囲のコレクションを表します。

注釈

例

/**
 * This script finds the direct precedents of the active cell.
 * It changes the font and color of those precedent cells. 
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  const selected = workbook.getActiveCell();
  
  // Get the cells that are direct precedents of the current cell.
  const precedents : ExcelScript.WorkbookRangeAreas = selected.getDirectPrecedents();

  // Set the font to bold and the fill color to orange for all the precedent cells.
  precedents.getRanges().forEach(range => {
    range.getFormat().getFill().setColor("orange");
    range.getFormat().getFont().setBold(true);
  });
}

メソッド

getAddresses()	A1 スタイルのアドレスの配列を返します。アドレス値には、セルの四角形の各ブロックのワークシート名が含まれます (例: "Sheet1!A1:B4、Sheet1!D1:D4")。読み取り専用です。
getAreas()	`RangeAreasCollection` オブジェクトを返します。コレクション内の各 `RangeAreas` は、1 つのワークシート内の 1 つまたは複数の四角形の範囲を表します。
getRangeAreasBySheet(key)	コレクション内のワークシート名または ID に基づいて、 `RangeAreas` オブジェクトを返します。ワークシートが存在しない場合、このメソッドは `undefined`を返します。
getRanges()	`RangeCollection` オブジェクトでこのオブジェクトを構成する範囲を返します。

メソッドの詳細

getAddresses()

A1 スタイルのアドレスの配列を返します。アドレス値には、セルの四角形の各ブロックのワークシート名が含まれます (例: "Sheet1!A1:B4、Sheet1!D1:D4")。読み取り専用です。

getAddresses(): string[];

戻り値

string[]

getAreas()

RangeAreasCollection オブジェクトを返します。コレクション内の各 RangeAreas は、1 つのワークシート内の 1 つまたは複数の四角形の範囲を表します。

getAreas(): RangeAreas[];

戻り値

ExcelScript.RangeAreas[]

getRangeAreasBySheet(key)

コレクション内のワークシート名または ID に基づいて、 RangeAreas オブジェクトを返します。ワークシートが存在しない場合、このメソッドは undefinedを返します。

getRangeAreasBySheet(key: string): RangeAreas;

パラメーター

key: string

ワークシートの名前または ID。

戻り値

ExcelScript.RangeAreas

getRanges()

RangeCollection オブジェクトでこのオブジェクトを構成する範囲を返します。

getRanges(): Range[];

戻り値

ExcelScript.Range[]

次の方法で共有