ExcelScript.NamedItem interface

パッケージ:

ExcelScript

セルまたは値の範囲の定義済みの名前を表します。 名前には、プリミティブの名前付きオブジェクト (以下の型に示すように)、範囲オブジェクト、または範囲への参照を指定できます。 このオブジェクトを使用して、名前に関連付けられた範囲オブジェクトを取得することができます。

注釈

例

/**
 * This script creates a named formula and uses it in another part of the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a named item for a formula.
  // This formula is the sum of the cells F2:F21 on Sheet1.
  const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
    "GrandTotal", 
    "=SUM(Sheet1!$F$2:$F$21)", 
    "The sum of table sums."
  );

  // Add this named formula to a new sheet in the workbook.
  const otherSheet = workbook.addWorksheet();
  otherSheet.getRange("A1").setFormula(namedItem.getFormula());

  // Switch to the new worksheet.
  otherSheet.activate();
}

メソッド

delete()	指定された名前を削除します。
getArrayValues()	名前付きアイテムの値と型を含むオブジェクトを返します。
getComment()	この名前に関連付けられているコメントを指定します。
getFormula()	名前付き項目の数式。 数式は常に等号 ("=") で始まります。
getName()	オブジェクトの名前。
getRange()	名前に関連付けられている範囲オブジェクトを返します。 名前付き項目の型が範囲でない場合、このメソッドは を返します undefined。
getScope()	名前の範囲をブックまたは特定のワークシートに指定するかどうかを指定します。 使用可能な値は、ワークシート、ブックです。
getType()	名前の数式によって返される値の型を指定します。 詳細は「ExcelScript.NamedItemType」をご覧ください。
getValue()	名前の数式で計算された値を表します。 名前付き範囲の場合、範囲アドレスが返されます。 この API は、#VALUE を返します。 ユーザー定義関数を参照している場合は、Excel UI でエラーが発生します。
getVisible()	オブジェクトが表示されるかどうかを指定します。
getWorksheet()	名前付き項目のスコープを設定するワークシートを返します。 アイテムのスコープがブックの代わりにである場合、このメソッドは を返します undefined。
setComment(comment)	この名前に関連付けられているコメントを指定します。
setFormula(formula)	名前付き項目の数式。 数式は常に等号 ("=") で始まります。
setVisible(visible)	オブジェクトが表示されるかどうかを指定します。

メソッドの詳細

delete()

指定された名前を削除します。

delete(): void;

戻り値

void

getArrayValues()

名前付きアイテムの値と型を含むオブジェクトを返します。

getArrayValues(): NamedItemArrayValues;

戻り値

ExcelScript.NamedItemArrayValues

getComment()

この名前に関連付けられているコメントを指定します。

getComment(): string;

戻り値

string

getFormula()

名前付き項目の数式。 数式は常に等号 ("=") で始まります。

getFormula(): string;

戻り値

string

getName()

オブジェクトの名前。

getName(): string;

戻り値

string

getRange()

名前に関連付けられている範囲オブジェクトを返します。 名前付き項目の型が範囲でない場合、このメソッドは を返します undefined。

getRange(): Range;

戻り値

ExcelScript.Range

getScope()

名前の範囲をブックまたは特定のワークシートに指定するかどうかを指定します。 使用可能な値は、ワークシート、ブックです。

getScope(): NamedItemScope;

戻り値

ExcelScript.NamedItemScope

getType()

名前の数式によって返される値の型を指定します。 詳細は「ExcelScript.NamedItemType」をご覧ください。

getType(): NamedItemType;

戻り値

ExcelScript.NamedItemType

例

/**
 * This script looks for every named range with "Review" in the name 
 * and marks the range with a yellow fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Look at every named item in the workbook.
  workbook.getNames().forEach((namedItem) => {
    // Find names containing "Review".
    if (namedItem.getName().includes("Review")) {
      // Only change the fill color if the named item is a range (not a formula).
      let itemType: ExcelScript.NamedItemType = namedItem.getType();
      if (itemType === ExcelScript.NamedItemType.range) {
        // Set the range's fill color to yellow.
        namedItem.getRange().getFormat().getFill().setColor("yellow");
      }
    }
  });
}

getValue()

名前の数式で計算された値を表します。 名前付き範囲の場合、範囲アドレスが返されます。 この API は、#VALUE を返します。 ユーザー定義関数を参照している場合は、Excel UI でエラーが発生します。

getValue(): string | number;

戻り値

string | number

getVisible()

オブジェクトが表示されるかどうかを指定します。

getVisible(): boolean;

戻り値

boolean

getWorksheet()

名前付き項目のスコープを設定するワークシートを返します。 アイテムのスコープがブックの代わりにである場合、このメソッドは を返します undefined。

getWorksheet(): Worksheet | undefined;

戻り値

ExcelScript.Worksheet | undefined

setComment(comment)

この名前に関連付けられているコメントを指定します。

setComment(comment: string): void;

パラメーター

comment

string

戻り値

void

setFormula(formula)

名前付き項目の数式。 数式は常に等号 ("=") で始まります。

setFormula(formula: string): void;

パラメーター

formula

string

戻り値

void

setVisible(visible)

オブジェクトが表示されるかどうかを指定します。

setVisible(visible: boolean): void;

パラメーター

visible

boolean

戻り値

void