ExcelScript.NamedItem interface

包:

ExcelScript

表示单元格区域或值的定义名称。 名称可以是基元命名对象 (，如下面的类型) 、范围对象或对区域的引用所示。 此对象可用于获取与名称相关的 range 对象。

注解

示例

/**
 * 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()	返回与名称相关的 range 对象。 如果命名项的类型不是范围，则此方法返回 undefined。
getScope()	指定名称的范围是工作簿还是特定工作表。 可能的值为：Worksheet、Workbook。
getType()	指定名称公式返回的值的类型。 有关详细信息，请参阅 ExcelScript.NamedItemType。
getValue()	表示 name 公式计算出的值。 对于命名区域，它将返回范围地址。 此 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()

返回与名称相关的 range 对象。 如果命名项的类型不是范围，则此方法返回 undefined。

getRange(): Range;

返回

ExcelScript.Range

getScope()

指定名称的范围是工作簿还是特定工作表。 可能的值为：Worksheet、Workbook。

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()

表示 name 公式计算出的值。 对于命名区域，它将返回范围地址。 此 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