ExcelScript.NamedItem interface

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

delete(): void;

戻り値

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

getArrayValues(): NamedItemArrayValues;

戻り値

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

getComment(): string;

戻り値

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

getFormula(): string;

戻り値

オブジェクトの名前。

getName(): string;

戻り値

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

getRange(): Range;

戻り値

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

getScope(): NamedItemScope;

戻り値

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

getType(): 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");
      }
    }
  });
}

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

getValue(): string | number;

戻り値

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

getVisible(): boolean;

戻り値

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

getWorksheet(): Worksheet | undefined;

戻り値

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

setComment(comment: string): void;

パラメーター

戻り値

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

setFormula(formula: string): void;

パラメーター

戻り値

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

setVisible(visible: boolean): void;

パラメーター

戻り値