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()	Возвращает объект Range, сопоставленный с именем. Если тип именованного элемента не является диапазоном, то этот метод возвращает undefined.
getScope()	Указывает, имеет ли имя область действия книги или определенного листа. Возможные значения: Лист, Книга.
getType()	Указывает тип значения, возвращаемого формулой имени. Дополнительные сведения см. в этой ExcelScript.NamedItemType статье.
getValue()	Представляет значение, вычисленное по формуле имени. Для именованного диапазона он вернет адрес диапазона. Этот API возвращает #VALUE! ошибка в пользовательском интерфейсе Excel, если она ссылается на определяемую пользователем функцию.
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()

Указывает, имеет ли имя область действия книги или определенного листа. Возможные значения: Лист, Книга.

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, если она ссылается на определяемую пользователем функцию.

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