ExcelScript.Workbook interface

Ссылка

Пакет:: ExcelScript

Workbook — это объект верхнего уровня, содержащий связанные объекты книги, такие как листы, таблицы и диапазоны.

Методы

addBinding(range, bindingType, id)	Добавляет привязку к определенному объекту Range.
addBindingFromNamedItem(name, bindingType, id)	Добавляет новую привязку с учетом именованного элемента в книге. Если именованный элемент ссылается на несколько областей, будет возвращена `InvalidReference` ошибка.
addBindingFromSelection(bindingType, id)	Добавляет новую привязку с учетом выделенного в настоящий момент фрагмента. Если выбор имеет несколько областей, будет возвращена `InvalidReference` ошибка.
addComment(cellAddress, content, contentType)	Создает новое примечание с указанным содержимым в определенной ячейке. Если `InvalidArgument` указанный диапазон больше одной ячейки, возникает ошибка.
addCustomXmlPart(xml)	Добавляет новую пользовательскую XML-часть в книгу.
addNamedItem(name, reference, comment)	Добавляет новое имя в определенную коллекцию.
addNamedItemFormulaLocal(name, formula, comment)	Добавляет новое имя в определенную коллекцию, используя языковой стандарт пользователя для формулы.
addPivotTable(name, source, destination)	Добавьте сводную таблицу на основе указанных исходных данных и вставьте ее в левую верхнюю ячейку целевого диапазона.
addPivotTableStyle(name, makeUniqueName)	Создает пустой `PivotTableStyle` объект с указанным именем.
addPredefinedCellStyle(name)	Добавляет новый стиль в коллекцию.
addSlicer(slicerSource, sourceField, slicerDestination)	Добавляет новый срез в книгу.
addSlicerStyle(name, makeUniqueName)	Создает пустой стиль среза с указанным именем.
addTable(address, hasHeaders)	Создает таблицу. Объект или исходный адрес диапазона определяет лист, на который будет добавлена таблица. Если добавить таблицу не удается (например, если адрес недействителен или одна таблица будет перекрываться другой), выводится сообщение об ошибке.
addTableStyle(name, makeUniqueName)	Создает пустой `TableStyle` объект с указанным именем.
addTimelineStyle(name, makeUniqueName)	Создает пустой `TimelineStyle` объект с указанным именем.
addWorksheet(name)	Добавляет новый лист в книгу. Лист будет добавлен после существующих листов. Если вы хотите активировать только что добавленный лист, вызовите `.activate()` его.
breakAllLinksToLinkedWorkbooks()	Разрывает все ссылки на связанные книги. После разрыва ссылок все формулы, ссылающиеся на ссылки на книги, полностью удаляются и заменяются последними извлеченными значениями.
getActiveCell()	Получает текущую активную ячейку из книги.
getActiveChart()	Получает текущую активную диаграмму в книге. Если активной диаграммы нет, этот метод возвращает `undefined`.
getActiveSlicer()	Получает текущий активный срез в книге. Если активный срез отсутствует, этот метод возвращает `undefined`.
getActiveWorksheet()	Получает текущий активный лист в книге.
getApplication()	Представляет экземпляр приложения Excel, содержащий эту книгу.
getAutoSave()	Указывает, находится ли книга в режиме автосохранений.
getBinding(id)	Возвращает объект привязки по идентификатору. Если объект привязки не существует, этот метод возвращает `undefined`.
getBindings()	Представляет коллекцию привязок, включенных в книгу.
getCalculationEngineVersion()	Возвращает номер версии модуля вычислений Excel.
getChartDataPointTrack()	Значение true, если все диаграммы в книге отслеживают точки фактических данных, с которыми они связаны. False, если диаграммы отслеживают индекс точек данных.
getComment(commentId)	Получает примечание из коллекции на основе его идентификатора. Если объект comment не существует, этот метод возвращает `undefined`.
getCommentByCell(cellAddress)	Получает примечание из указанной ячейки. Если в ячейке нет комментария, возникает ошибка.
getCommentByReplyId(replyId)	Возвращает комментарий, к которому подключен данный ответ.
getComments()	Представляет коллекцию комментариев, связанных с книгой.
getCustomXmlPart(id)	Получает пользовательскую XML-часть по идентификатору. `CustomXmlPart` Если объект не существует, то этот метод возвращает `undefined`.
getCustomXmlPartByNamespace(namespaceUri)	Возвращает новую коллекцию настраиваемых XML-частей, пространства имен которых соответствуют заданному пространству имен.
getCustomXmlParts()	Представляет коллекцию настраиваемых XML-частей, содержащихся в этой книге.
getCustomXmlPartsByNamespace(namespaceUri)	Возвращает новую коллекцию настраиваемых XML-частей, пространства имен которых соответствуют заданному пространству имен.
getDefaultPivotTableStyle()	Возвращает стиль сводной таблицы по умолчанию для область родительского объекта.
getDefaultSlicerStyle()	Возвращает значение по умолчанию `SlicerStyle` для область родительского объекта.
getDefaultTableStyle()	Возвращает стиль таблицы по умолчанию для область родительского объекта.
getDefaultTimelineStyle()	Возвращает стиль временная шкала по умолчанию для область родительского объекта.
getFirstWorksheet(visibleOnly)	Получает первый лист в коллекции.
getIsDirty()	Указывает, были ли изменения внесены с момента последнего сохранения книги. Для этого свойства можно присвоить значение , `true` если нужно закрыть измененную книгу, не сохраняя ее или не запрашивая ее сохранение.
getLastWorksheet(visibleOnly)	Получает последний лист в коллекции.
getLinkedWorkbookByUrl(key)	Получает сведения о связанной книге по URL-адресу. Если книга не существует, этот метод возвращает `undefined`.
getLinkedWorkbookRefreshMode()	Представляет режим обновления ссылок книги. Режим одинаков для всех ссылок книг, присутствующих в книге.
getLinkedWorkbooks()	Возвращает коллекцию связанных книг. В формулах ссылки на книги можно использовать для ссылки на данные (значения ячеек и имена) за пределами текущей книги.
getName()	Получает имя книги.
getNamedItem(name)	Возвращает объект, `NamedItem` используя его имя. Если объект не существует, этот метод возвращает `undefined`.
getNames()	Представляет коллекцию именованных элементов с областью книги (именованные диапазоны и константы).
getPivotTable(name)	Получает сводную таблицу по имени. Если сводная таблица не существует, этот метод возвращает `undefined`.
getPivotTables()	Представляет коллекцию сводных таблиц, сопоставленных с книгой.
getPivotTableStyle(name)	Возвращает по `PivotTableStyle` имени. `PivotTableStyle` Если объект не существует, то этот метод возвращает `undefined`.
getPivotTableStyles()	Представляет коллекцию объектов PivotTableStyles, связанных с книгой.
getPredefinedCellStyle(name)	Получает стиль по имени. Если объект стиля не существует, этот метод возвращает `undefined`.
getPredefinedCellStyles()	Представляет коллекцию стилей, связанных с книгой.
getPreviouslySaved()	Указывает, сохранялась ли книга локально или в сети.
getProperties()	Получает свойства книги.
getProtection()	Возвращает объект защиты для книги.
getQueries()	Возвращает коллекцию Power Query запросов, входящих в книгу.
getQuery(key)	Получает запрос из коллекции на основе его имени.
getReadOnly()	Возвращает значение `true` , если книга открыта в режиме только для чтения.
getSelectedRange()	Возвращает выбранный в данный момент один диапазон из книги. Если выбрано несколько диапазонов, этот метод вызовет ошибку.
getSelectedRanges()	Получает текущий выделенный диапазон (один или несколько) в книге. В отличие от `getSelectedRange()`, этот метод возвращает `RangeAreas` объект, представляющий все выбранные диапазоны.
getSlicer(key)	Возвращает срез с использованием его имени или идентификатора. Если срез не существует, этот метод возвращает `undefined`.
getSlicers()	Представляет коллекцию срезов, связанных с книгой.
getSlicerStyle(name)	Возвращает по `SlicerStyle` имени. Если стиль среза не существует, этот метод возвращает `undefined`.
getSlicerStyles()	Представляет коллекцию объектов SlicerStyles, связанных с книгой.
getTable(key)	Получает таблицу по имени или ИД. Если таблица не существует, этот метод возвращает `undefined`.
getTables()	Представляет коллекцию таблиц, сопоставленных с книгой.
getTableStyle(name)	Возвращает по `TableStyle` имени. Если стиль таблицы не существует, этот метод возвращает `undefined`.
getTableStyles()	Представляет коллекцию объектов TableStyles, связанных с книгой.
getTimelineStyle(name)	Возвращает по `TimelineStyle` имени. Если стиль временная шкала не существует, этот метод возвращает `undefined`.
getTimelineStyles()	Представляет коллекцию объектов TimelineStyles, связанных с книгой.
getUsePrecisionAsDisplayed()	Значение true, если вычисления в книге выполняются только с той точностью чисел, с которой они отображаются. Данные навсегда потеряют точность при переключении этого свойства с `false` на `true`.
getWorksheet(key)	Получает объект листа по его имени или ИД. Если лист не существует, этот метод возвращает `undefined`.
getWorksheets()	Представляет коллекцию листов, сопоставленных с книгой.
refreshAllDataConnections()	Обновляет все Connections данных.
refreshAllLinksToLinkedWorkbooks()	Отправляет запрос на обновление всех ссылок книги.
refreshAllPivotTables()	Обновляет все сводные таблицы в коллекции.
setChartDataPointTrack(chartDataPointTrack)	Значение true, если все диаграммы в книге отслеживают точки фактических данных, с которыми они связаны. False, если диаграммы отслеживают индекс точек данных.
setDefaultPivotTableStyle(newDefaultStyle)	Задает стиль сводной таблицы по умолчанию для использования в область родительского объекта.
setDefaultSlicerStyle(newDefaultStyle)	Задает стиль среза по умолчанию для использования в область родительского объекта.
setDefaultTableStyle(newDefaultStyle)	Задает стиль таблицы по умолчанию для использования в область родительского объекта.
setDefaultTimelineStyle(newDefaultStyle)	Задает стиль временная шкала по умолчанию для использования в область родительского объекта.
setIsDirty(isDirty)	Указывает, были ли изменения внесены с момента последнего сохранения книги. Для этого свойства можно присвоить значение , `true` если нужно закрыть измененную книгу, не сохраняя ее или не запрашивая ее сохранение.
setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)	Представляет режим обновления ссылок книги. Режим одинаков для всех ссылок книг, присутствующих в книге.
setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)	Значение true, если вычисления в книге выполняются только с той точностью чисел, с которой они отображаются. Данные навсегда потеряют точность при переключении этого свойства с `false` на `true`.

Сведения о методе

addBinding(range, bindingType, id)

Добавляет привязку к определенному объекту Range.

addBinding(
            range: Range | string,
            bindingType: BindingType,
            id: string
        ): Binding;

Параметры

range: ExcelScript.Range | string

Диапазон для привязки. Может быть Range объектом или строкой. Строка должна включать полный адрес, включающий имя листа.

bindingType: ExcelScript.BindingType

Тип привязки. См. раздел ExcelScript.BindingType.

id: string

Имя привязки.

Возвращаемое значение

ExcelScript.Binding

addBindingFromNamedItem(name, bindingType, id)

Добавляет новую привязку с учетом именованного элемента в книге. Если именованный элемент ссылается на несколько областей, будет возвращена InvalidReference ошибка.

addBindingFromNamedItem(
            name: string,
            bindingType: BindingType,
            id: string
        ): Binding;

Параметры

name: string

Имя элемента, на основе которого создается привязка.

bindingType: ExcelScript.BindingType

Тип привязки. См. раздел ExcelScript.BindingType.

id: string

Имя привязки.

Возвращаемое значение

ExcelScript.Binding

addBindingFromSelection(bindingType, id)

Добавляет новую привязку с учетом выделенного в настоящий момент фрагмента. Если выбор имеет несколько областей, будет возвращена InvalidReference ошибка.

addBindingFromSelection(bindingType: BindingType, id: string): Binding;

Параметры

bindingType: ExcelScript.BindingType

Тип привязки. См. раздел ExcelScript.BindingType.

id: string

Имя привязки.

Возвращаемое значение

ExcelScript.Binding

addComment(cellAddress, content, contentType)

Создает новое примечание с указанным содержимым в определенной ячейке. Если InvalidArgument указанный диапазон больше одной ячейки, возникает ошибка.

addComment(
            cellAddress: Range | string,
            content: CommentRichContent | string,
            contentType?: ContentType
        ): Comment;

Параметры

cellAddress: ExcelScript.Range | string

Ячейка, в которую добавляется комментарий. Это может быть Range объект или строка. Если это строка, она должна содержать полный адрес, включая имя листа. Если InvalidArgument указанный диапазон больше одной ячейки, возникает ошибка.

content: ExcelScript.CommentRichContent | string

Содержимое комментария. Это может быть строка или CommentRichContent объект. Строки используются для обычного текста. CommentRichContent объекты позволяют использовать другие функции комментариев, такие как упоминания.

contentType: ExcelScript.ContentType

Необязательный параметр. Тип содержимого, содержащегося в комментарии. Значение по умолчанию — перечисление ContentType.Plain.

Возвращаемое значение

ExcelScript.Comment

addCustomXmlPart(xml)

Добавляет новую пользовательскую XML-часть в книгу.

addCustomXmlPart(xml: string): CustomXmlPart;

Параметры

xml: string

XML-содержимое. Должен быть допустимым ФРАГМЕНТом XML.

Возвращаемое значение

ExcelScript.CustomXmlPart

addNamedItem(name, reference, comment)

Добавляет новое имя в определенную коллекцию.

addNamedItem(
            name: string,
            reference: Range | string,
            comment?: string
        ): NamedItem;

Параметры

name: string

Имя именованного элемента.

reference: ExcelScript.Range | string

Формула или диапазон, на который будет ссылаться имя.

comment: string

Необязательный параметр. Комментарий, связанный с именованным элементом.

Возвращаемое значение

ExcelScript.NamedItem

Примеры

/**
 * 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();
}

addNamedItemFormulaLocal(name, formula, comment)

Добавляет новое имя в определенную коллекцию, используя языковой стандарт пользователя для формулы.

addNamedItemFormulaLocal(
            name: string,
            formula: string,
            comment?: string
        ): NamedItem;

Параметры

name: string

Имя именованного элемента.

formula: string

Формула на языке пользователя, на которую будет ссылаться имя.

comment: string

Необязательный параметр. Комментарий, связанный с именованным элементом.

Возвращаемое значение

ExcelScript.NamedItem

addPivotTable(name, source, destination)

Добавьте сводную таблицу на основе указанных исходных данных и вставьте ее в левую верхнюю ячейку целевого диапазона.

addPivotTable(
            name: string,
            source: Range | string | Table,
            destination: Range | string
        ): PivotTable;

Параметры

name: string

Имя новой сводной таблицы.

source: ExcelScript.Range | string | ExcelScript.Table

Исходные данные для новой сводной таблицы могут быть диапазоном (или строковым адресом, включая имя листа) или таблицей.

destination: ExcelScript.Range | string

Ячейка в левом верхнем углу диапазона назначения отчета сводной таблицы (диапазон на листе, где будет размещен итоговый отчет).

Возвращаемое значение

ExcelScript.PivotTable

Примеры

/**
 * This script creates a PivotTable from an existing table and adds it to an existing worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 * It also assumes there is a worksheet named "PivotSheet".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];
  let pivotTable = workbook.addPivotTable("My Pivot", table, "PivotSheet!A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

addPivotTableStyle(name, makeUniqueName)

Создает пустой PivotTableStyle объект с указанным именем.

addPivotTableStyle(
            name: string,
            makeUniqueName?: boolean
        ): PivotTableStyle;

Параметры

name: string

Уникальное имя нового стиля сводной таблицы. Если имя уже используется, вызовет InvalidArgument ошибку.

makeUniqueName: boolean

Необязательный параметр. По умолчанию используется значение false. Если trueзначение , при необходимости добавит к имени номера, чтобы сделать его уникальным.

Возвращаемое значение

ExcelScript.PivotTableStyle

addPredefinedCellStyle(name)

Добавляет новый стиль в коллекцию.

addPredefinedCellStyle(name: string): void;

Параметры

name: string

Имя добавляемого стиля.

Возвращаемое значение

void

addSlicer(slicerSource, sourceField, slicerDestination)

Добавляет новый срез в книгу.

addSlicer(
            slicerSource: string | PivotTable | Table,
            sourceField: string | PivotField | number | TableColumn,
            slicerDestination?: string | Worksheet
        ): Slicer;

Параметры

slicerSource: string | ExcelScript.PivotTable | ExcelScript.Table

Источник данных, на который будет основан новый срез. Это может быть PivotTable объект, Table объект или строка. При передаче объекта сводной таблицы источник данных является источником PivotTable объекта . Table При передаче объекта источником данных является Table объект . При передаче строки она интерпретируется как имя или идентификатор сводной таблицы или таблицы.

sourceField: string | ExcelScript.PivotField | number | ExcelScript.TableColumn

Поле в источнике данных для фильтрации. Это может быть объект, TableColumn объект, идентификатор объекта PivotField или имя или идентификатор объекта TableColumn.PivotField

slicerDestination: string | ExcelScript.Worksheet

Необязательный параметр. Лист, на котором будет создан новый срез. Это может быть Worksheet объект или имя или идентификатор листа. Этот параметр можно опустить, если коллекция срезов извлекается с листа.

Возвращаемое значение

ExcelScript.Slicer

Примеры

/**
 * This script adds a slicer for an existing PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Pivot".
  const farmPivot = workbook.getPivotTable("Farm Pivot");

  // Create the slicer. 
  // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
  const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
    farmPivot, /* The table or PivotTale to be sliced. */
    farmPivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
  );

  // Select the items to display.
  fruitSlicer.selectItems(["Lemon", "Lime"]);

  // Set the left margin of the slicer.
  fruitSlicer.setLeft(400);
}

addSlicerStyle(name, makeUniqueName)

Создает пустой стиль среза с указанным именем.

addSlicerStyle(name: string, makeUniqueName?: boolean): SlicerStyle;

Параметры

name: string

Уникальное имя нового стиля среза. Вызовет InvalidArgument исключение, если имя уже используется.

makeUniqueName: boolean

Возвращаемое значение

ExcelScript.SlicerStyle

addTable(address, hasHeaders)

Создает таблицу. Объект или исходный адрес диапазона определяет лист, на который будет добавлена таблица. Если добавить таблицу не удается (например, если адрес недействителен или одна таблица будет перекрываться другой), выводится сообщение об ошибке.

addTable(address: Range | string, hasHeaders: boolean): Table;

Параметры

address: ExcelScript.Range | string

Объект Range или строковый адрес или имя диапазона, представляющего источник данных. Если адрес не содержит имя листа, используется текущий активный лист.

hasHeaders: boolean

Логическое значение, указывающее, имеют ли импортируемые данные метки столбцов. Если источник не содержит заголовки (т. е. если для этого свойства задано значение false), Excel автоматически создаст заголовок и сместит данные вниз на одну строку.

Возвращаемое значение

ExcelScript.Table

Примеры

/**
 * This sample converts the information in the first worksheet
 * into a table with headers.
*/
function main(workbook: ExcelScript.Workbook) {
  // This assumes there is one contiguous range in the first worksheet.
  const dataRange = workbook.getFirstWorksheet().getUsedRange();
  
  // Add a table at the workbook level.
  workbook.addTable(dataRange.getAddress(), true);
}

addTableStyle(name, makeUniqueName)

Создает пустой TableStyle объект с указанным именем.

addTableStyle(name: string, makeUniqueName?: boolean): TableStyle;

Параметры

name: string

Уникальное имя нового стиля таблицы. Если имя уже используется, вызовет InvalidArgument ошибку.

makeUniqueName: boolean

Возвращаемое значение

ExcelScript.TableStyle

addTimelineStyle(name, makeUniqueName)

Создает пустой TimelineStyle объект с указанным именем.

addTimelineStyle(name: string, makeUniqueName?: boolean): TimelineStyle;

Параметры

name: string

Уникальное имя нового стиля временная шкала. Если имя уже используется, вызовет InvalidArgument ошибку.

makeUniqueName: boolean

Возвращаемое значение

ExcelScript.TimelineStyle

addWorksheet(name)

Добавляет новый лист в книгу. Лист будет добавлен после существующих листов. Если вы хотите активировать только что добавленный лист, вызовите .activate() его.

addWorksheet(name?: string): Worksheet;

Параметры

name: string

Необязательный параметр. Имя добавляемого листа. Если указано, имя должно быть уникальным. В противном случае Excel определяет имя нового листа.

Возвращаемое значение

ExcelScript.Worksheet

Примеры

/**
 * This script adds a new worksheet named "Data" to the workbook.
 * If a worksheet with that name already exists, the script logs a note.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet already exists.
  if (workbook.getWorksheet("Data")) {
    console.log("The Data worksheet is already in the workbook.");
  } else {
    // Add a new worksheet.
    let worksheet = workbook.addWorksheet("Data");
  }
}

breakAllLinksToLinkedWorkbooks()

Разрывает все ссылки на связанные книги. После разрыва ссылок все формулы, ссылающиеся на ссылки на книги, полностью удаляются и заменяются последними извлеченными значениями.

breakAllLinksToLinkedWorkbooks(): void;

Возвращаемое значение

void

getActiveCell()

Получает текущую активную ячейку из книги.

getActiveCell(): Range;

Возвращаемое значение

ExcelScript.Range

Примеры

/**
 * This script logs the value of the current active cell. 
 * If multiple cells are selected, the top-leftmost cell will be logged.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current active cell in the workbook.
  let cell = workbook.getActiveCell();
  console.log(`The current cell's value is ${cell.getValue()}`);
}

getActiveChart()

Получает текущую активную диаграмму в книге. Если активной диаграммы нет, этот метод возвращает undefined.

getActiveChart(): Chart;

Возвращаемое значение

ExcelScript.Chart

getActiveSlicer()

Получает текущий активный срез в книге. Если активный срез отсутствует, этот метод возвращает undefined.

getActiveSlicer(): Slicer;

Возвращаемое значение

ExcelScript.Slicer

getActiveWorksheet()

Получает текущий активный лист в книге.

getActiveWorksheet(): Worksheet;

Возвращаемое значение

ExcelScript.Worksheet

getApplication()

Представляет экземпляр приложения Excel, содержащий эту книгу.

getApplication(): Application;

Возвращаемое значение

ExcelScript.Application

getAutoSave()

Указывает, находится ли книга в режиме автосохранений.

getAutoSave(): boolean;

Возвращаемое значение

boolean

getBinding(id)

Возвращает объект привязки по идентификатору. Если объект привязки не существует, этот метод возвращает undefined.

getBinding(id: string): Binding | undefined;

Параметры

id: string

Идентификатор получаемого объекта привязки.

Возвращаемое значение

ExcelScript.Binding | undefined

getBindings()

Представляет коллекцию привязок, включенных в книгу.

getBindings(): Binding[];

Возвращаемое значение

ExcelScript.Binding[]

getCalculationEngineVersion()

Возвращает номер версии модуля вычислений Excel.

getCalculationEngineVersion(): number;

Возвращаемое значение

number

getChartDataPointTrack()

Значение true, если все диаграммы в книге отслеживают точки фактических данных, с которыми они связаны. False, если диаграммы отслеживают индекс точек данных.

getChartDataPointTrack(): boolean;

Возвращаемое значение

boolean

getComment(commentId)

Получает примечание из коллекции на основе его идентификатора. Если объект comment не существует, этот метод возвращает undefined.

getComment(commentId: string): Comment | undefined;

Параметры

commentId: string

Идентификатор комментария.

Возвращаемое значение

ExcelScript.Comment | undefined

getCommentByCell(cellAddress)

Получает примечание из указанной ячейки. Если в ячейке нет комментария, возникает ошибка.

getCommentByCell(cellAddress: Range | string): Comment;

Параметры

cellAddress: ExcelScript.Range | string

Ячейка, в которой находится комментарий. Это может быть Range объект или строка. Если это строка, она должна содержать полный адрес, включая имя листа. Если InvalidArgument указанный диапазон больше одной ячейки, возникает ошибка.

Возвращаемое значение

ExcelScript.Comment

getCommentByReplyId(replyId)

Возвращает комментарий, к которому подключен данный ответ.

getCommentByReplyId(replyId: string): Comment;

Параметры

replyId: string

Идентификатор ответа на комментарий.

Возвращаемое значение

ExcelScript.Comment

getComments()

Представляет коллекцию комментариев, связанных с книгой.

getComments(): Comment[];

Возвращаемое значение

ExcelScript.Comment[]

getCustomXmlPart(id)

Получает пользовательскую XML-часть по идентификатору. CustomXmlPart Если объект не существует, то этот метод возвращает undefined.

getCustomXmlPart(id: string): CustomXmlPart | undefined;

Параметры

id: string

Идентификатор извлекаемого объекта.

Возвращаемое значение

ExcelScript.CustomXmlPart | undefined

getCustomXmlPartByNamespace(namespaceUri)

Предупреждение

Теперь этот API является нерекомендуемым.

Use getCustomXmlPartsByNamespace instead.

Возвращает новую коллекцию настраиваемых XML-частей, пространства имен которых соответствуют заданному пространству имен.

getCustomXmlPartByNamespace(namespaceUri: string): CustomXmlPart[];

Параметры

namespaceUri: string

Это должен быть полный URI схемы; например , "http://schemas.contoso.com/review/1.0".

Возвращаемое значение

ExcelScript.CustomXmlPart[]

getCustomXmlParts()

Представляет коллекцию настраиваемых XML-частей, содержащихся в этой книге.

getCustomXmlParts(): CustomXmlPart[];

Возвращаемое значение

ExcelScript.CustomXmlPart[]

getCustomXmlPartsByNamespace(namespaceUri)

getCustomXmlPartsByNamespace(namespaceUri: string): CustomXmlPart[];

Параметры

namespaceUri: string

Это должен быть полный URI схемы; например , "http://schemas.contoso.com/review/1.0".

Возвращаемое значение

ExcelScript.CustomXmlPart[]

getDefaultPivotTableStyle()

Возвращает стиль сводной таблицы по умолчанию для область родительского объекта.

getDefaultPivotTableStyle(): PivotTableStyle;

Возвращаемое значение

ExcelScript.PivotTableStyle

getDefaultSlicerStyle()

Возвращает значение по умолчанию SlicerStyle для область родительского объекта.

getDefaultSlicerStyle(): SlicerStyle;

Возвращаемое значение

ExcelScript.SlicerStyle

getDefaultTableStyle()

Возвращает стиль таблицы по умолчанию для область родительского объекта.

getDefaultTableStyle(): TableStyle;

Возвращаемое значение

ExcelScript.TableStyle

getDefaultTimelineStyle()

Возвращает стиль временная шкала по умолчанию для область родительского объекта.

getDefaultTimelineStyle(): TimelineStyle;

Возвращаемое значение

ExcelScript.TimelineStyle

getFirstWorksheet(visibleOnly)

Получает первый лист в коллекции.

getFirstWorksheet(visibleOnly?: boolean): Worksheet;

Параметры

visibleOnly: boolean

Необязательный параметр. Если trueзначение , учитывает только видимые листы, пропуская все скрытые листы.

Возвращаемое значение

ExcelScript.Worksheet

getIsDirty()

Указывает, были ли изменения внесены с момента последнего сохранения книги. Для этого свойства можно присвоить значение , true если нужно закрыть измененную книгу, не сохраняя ее или не запрашивая ее сохранение.

getIsDirty(): boolean;

Возвращаемое значение

boolean

getLastWorksheet(visibleOnly)

Получает последний лист в коллекции.

getLastWorksheet(visibleOnly?: boolean): Worksheet;

Параметры

visibleOnly: boolean

Необязательный параметр. Если trueзначение , учитывает только видимые листы, пропуская все скрытые листы.

Возвращаемое значение

ExcelScript.Worksheet

getLinkedWorkbookByUrl(key)

Получает сведения о связанной книге по URL-адресу. Если книга не существует, этот метод возвращает undefined.

getLinkedWorkbookByUrl(key: string): LinkedWorkbook | undefined;

Параметры

key: string

URL-адрес связанной книги.

Возвращаемое значение

ExcelScript.LinkedWorkbook | undefined

getLinkedWorkbookRefreshMode()

Представляет режим обновления ссылок книги. Режим одинаков для всех ссылок книг, присутствующих в книге.

getLinkedWorkbookRefreshMode(): WorkbookLinksRefreshMode;

Возвращаемое значение

ExcelScript.WorkbookLinksRefreshMode

Примеры

/**
 * This script refreshes all the links to external workbooks, 
 * if the linked workbook refresh mode is set to manual.
 * To learn about linked workbooks, see https://support.microsoft.com/office/c98d1803-dd75-4668-ac6a-d7cca2a9b95f.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check the refresh mode.
  if (workbook.getLinkedWorkbookRefreshMode() === ExcelScript.WorkbookLinksRefreshMode.manual) {
    console.log("Refreshing workbook links");

    // Trigger a refresh of linked workbook content.
    workbook.refreshAllLinksToLinkedWorkbooks();
  }

getLinkedWorkbooks()

Возвращает коллекцию связанных книг. В формулах ссылки на книги можно использовать для ссылки на данные (значения ячеек и имена) за пределами текущей книги.

getLinkedWorkbooks(): LinkedWorkbook[];

Возвращаемое значение

ExcelScript.LinkedWorkbook[]

Примеры

/**
 * This script removes all links to other workbooks.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get all the linked workbook references.
    const externalWorkbooks: ExcelScript.LinkedWorkbook[] = workbook.getLinkedWorkbooks();
    console.log(`There are ${externalWorkbooks.length} other workbooks linked to from this workbook.`);

    // Remove all the links to those workbooks.
    // This changes the value of cells with workbook links to "#CONNECT!".
    externalWorkbooks.forEach((workbookLink) => {
        workbookLink.breakLinks();
    });
}

getName()

Получает имя книги.

getName(): string;

Возвращаемое значение

string

Примеры

/**
 * This script logs the name of the workbook without the ".xlsx" extension.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the workbook's name.
  let name = workbook.getName();

  // Remove the file extension.
  name = name.substring(0, name.lastIndexOf(".xlsx"));

  // Display the name in the console.
  console.log(name);
}

getNamedItem(name)

Возвращает объект, NamedItem используя его имя. Если объект не существует, этот метод возвращает undefined.

getNamedItem(name: string): NamedItem | undefined;

Параметры

name: string

Nameitem name.

Возвращаемое значение

ExcelScript.NamedItem | undefined

getNames()

Представляет коллекцию именованных элементов с областью книги (именованные диапазоны и константы).

getNames(): NamedItem[];

Возвращаемое значение

ExcelScript.NamedItem[]

Примеры

/**
 * 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");
      }
    }
  });
}

getPivotTable(name)

Получает сводную таблицу по имени. Если сводная таблица не существует, этот метод возвращает undefined.

getPivotTable(name: string): PivotTable | undefined;

Параметры

name: string

Имя получаемой сводной таблицы.

Возвращаемое значение

ExcelScript.PivotTable | undefined

getPivotTables()

Представляет коллекцию сводных таблиц, сопоставленных с книгой.

getPivotTables(): PivotTable[];

Возвращаемое значение

ExcelScript.PivotTable[]

getPivotTableStyle(name)

Возвращает по PivotTableStyle имени. PivotTableStyle Если объект не существует, то этот метод возвращает undefined.

getPivotTableStyle(name: string): PivotTableStyle | undefined;

Параметры

name: string

Имя стиля сводной таблицы, который требуется извлечь.

Возвращаемое значение

ExcelScript.PivotTableStyle | undefined

getPivotTableStyles()

Представляет коллекцию объектов PivotTableStyles, связанных с книгой.

getPivotTableStyles(): PivotTableStyle[];

Возвращаемое значение

ExcelScript.PivotTableStyle[]

getPredefinedCellStyle(name)

Получает стиль по имени. Если объект стиля не существует, этот метод возвращает undefined.

getPredefinedCellStyle(name: string): PredefinedCellStyle | undefined;

Параметры

name: string

Имя извлекаемого стиля.

Возвращаемое значение

ExcelScript.PredefinedCellStyle | undefined

getPredefinedCellStyles()

Представляет коллекцию стилей, связанных с книгой.

getPredefinedCellStyles(): PredefinedCellStyle[];

Возвращаемое значение

ExcelScript.PredefinedCellStyle[]

getPreviouslySaved()

Указывает, сохранялась ли книга локально или в сети.

getPreviouslySaved(): boolean;

Возвращаемое значение

boolean

getProperties()

Получает свойства книги.

getProperties(): DocumentProperties;

Возвращаемое значение

ExcelScript.DocumentProperties

getProtection()

Возвращает объект защиты для книги.

getProtection(): WorkbookProtection;

Возвращаемое значение

ExcelScript.WorkbookProtection

Примеры

/**
 * This script protects the workbook with a password, if it isn't already protected.
 * The password is provided by the user through a prompt.
 */
function main(workbook: ExcelScript.Workbook, password?: string) {
  // Get the workbook-level protection object.
  const protection = workbook.getProtection();

  // Check if the workbook is already protected.
  if (!protection.getProtected()) {
      // Protect the workbook with the given password.
      // If the optional password was omitted, 
      // no password will be needed to unprotect the workbook.
    protection.protect(password);
  }
}

getQueries()

Возвращает коллекцию Power Query запросов, входящих в книгу.

getQueries(): Query[];

Возвращаемое значение

ExcelScript.Query[]

getQuery(key)

Получает запрос из коллекции на основе его имени.

getQuery(key: string): Query;

Параметры

key: string

Имя запроса без учета регистра.

Возвращаемое значение

ExcelScript.Query

getReadOnly()

Возвращает значение true , если книга открыта в режиме только для чтения.

getReadOnly(): boolean;

Возвращаемое значение

boolean

getSelectedRange()

Возвращает выбранный в данный момент один диапазон из книги. Если выбрано несколько диапазонов, этот метод вызовет ошибку.

getSelectedRange(): Range;

Возвращаемое значение

ExcelScript.Range

getSelectedRanges()

Получает текущий выделенный диапазон (один или несколько) в книге. В отличие от getSelectedRange(), этот метод возвращает RangeAreas объект, представляющий все выбранные диапазоны.

getSelectedRanges(): RangeAreas;

Возвращаемое значение

ExcelScript.RangeAreas

getSlicer(key)

Возвращает срез с использованием его имени или идентификатора. Если срез не существует, этот метод возвращает undefined.

getSlicer(key: string): Slicer | undefined;

Параметры

key: string

Имя или идентификатор извлекаемого среза.

Возвращаемое значение

ExcelScript.Slicer | undefined

getSlicers()

Представляет коллекцию срезов, связанных с книгой.

getSlicers(): Slicer[];

Возвращаемое значение

ExcelScript.Slicer[]

getSlicerStyle(name)

Возвращает по SlicerStyle имени. Если стиль среза не существует, этот метод возвращает undefined.

getSlicerStyle(name: string): SlicerStyle | undefined;

Параметры

name: string

Имя стиля среза, который требуется извлечь.

Возвращаемое значение

ExcelScript.SlicerStyle | undefined

getSlicerStyles()

Представляет коллекцию объектов SlicerStyles, связанных с книгой.

getSlicerStyles(): SlicerStyle[];

Возвращаемое значение

ExcelScript.SlicerStyle[]

getTable(key)

Получает таблицу по имени или ИД. Если таблица не существует, этот метод возвращает undefined.

getTable(key: string): Table | undefined;

Параметры

key: string

Имя или ИД получаемой таблицы.

Возвращаемое значение

ExcelScript.Table | undefined

getTables()

Представляет коллекцию таблиц, сопоставленных с книгой.

getTables(): Table[];

Возвращаемое значение

ExcelScript.Table[]

getTableStyle(name)

Возвращает по TableStyle имени. Если стиль таблицы не существует, этот метод возвращает undefined.

getTableStyle(name: string): TableStyle | undefined;

Параметры

name: string

Имя возвращаемого стиля таблицы.

Возвращаемое значение

ExcelScript.TableStyle | undefined

getTableStyles()

Представляет коллекцию объектов TableStyles, связанных с книгой.

getTableStyles(): TableStyle[];

Возвращаемое значение

ExcelScript.TableStyle[]

getTimelineStyle(name)

Возвращает по TimelineStyle имени. Если стиль временная шкала не существует, этот метод возвращает undefined.

getTimelineStyle(name: string): TimelineStyle | undefined;

Параметры

name: string

Имя извлекаемого стиля временная шкала.

Возвращаемое значение

ExcelScript.TimelineStyle | undefined

getTimelineStyles()

Представляет коллекцию объектов TimelineStyles, связанных с книгой.

getTimelineStyles(): TimelineStyle[];

Возвращаемое значение

ExcelScript.TimelineStyle[]

getUsePrecisionAsDisplayed()

Значение true, если вычисления в книге выполняются только с той точностью чисел, с которой они отображаются. Данные навсегда потеряют точность при переключении этого свойства с false на true.

getUsePrecisionAsDisplayed(): boolean;

Возвращаемое значение

boolean

getWorksheet(key)

Получает объект листа по его имени или ИД. Если лист не существует, этот метод возвращает undefined.

getWorksheet(key: string): Worksheet | undefined;

Параметры

key: string

Имя или идентификатор листа.

Возвращаемое значение

ExcelScript.Worksheet | undefined

Примеры

/**
 * This script switches the active view to a worksheet named "Data", if it exists.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet exists.
  let dataWorksheet = workbook.getWorksheet("Data");
  if (dataWorksheet) {
    // Switch to the "Data" worksheet.
    dataWorksheet.activate();
  } else {
    console.log(`No worksheet named "Data" in this workbook.`);
  }
}

getWorksheets()

Представляет коллекцию листов, сопоставленных с книгой.

getWorksheets(): Worksheet[];

Возвращаемое значение

ExcelScript.Worksheet[]

Примеры

/**
 * This script logs the names of all the worksheets in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the worksheets in the workbook. 
  let sheets = workbook.getWorksheets();

  // Get a list of all the worksheet names.
  let names = sheets.map ((sheet) => sheet.getName());

  // Write in the console all the worksheet names and the total count.
  console.log(names);
  console.log(`Total worksheets inside of this workbook: ${sheets.length}`);
}

refreshAllDataConnections()

Обновляет все Connections данных.

refreshAllDataConnections(): void;

Возвращаемое значение

void

refreshAllLinksToLinkedWorkbooks()

Отправляет запрос на обновление всех ссылок книги.

refreshAllLinksToLinkedWorkbooks(): void;

Возвращаемое значение

void

refreshAllPivotTables()

Обновляет все сводные таблицы в коллекции.

refreshAllPivotTables(): void;

Возвращаемое значение

void

setChartDataPointTrack(chartDataPointTrack)

setChartDataPointTrack(chartDataPointTrack: boolean): void;

Параметры

chartDataPointTrack: boolean

Возвращаемое значение

void

setDefaultPivotTableStyle(newDefaultStyle)

Задает стиль сводной таблицы по умолчанию для использования в область родительского объекта.

setDefaultPivotTableStyle(
            newDefaultStyle: PivotTableStyle | string
        ): void;

Параметры

newDefaultStyle: ExcelScript.PivotTableStyle | string

Объект PivotTableStyle или имя PivotTableStyle объекта, который должен быть новым значением по умолчанию.

Возвращаемое значение

void

setDefaultSlicerStyle(newDefaultStyle)

Задает стиль среза по умолчанию для использования в область родительского объекта.

setDefaultSlicerStyle(newDefaultStyle: SlicerStyle | string): void;

Параметры

newDefaultStyle: ExcelScript.SlicerStyle | string

Объект SlicerStyle или имя SlicerStyle объекта, который должен быть новым значением по умолчанию.

Возвращаемое значение

void

setDefaultTableStyle(newDefaultStyle)

Задает стиль таблицы по умолчанию для использования в область родительского объекта.

setDefaultTableStyle(newDefaultStyle: TableStyle | string): void;

Параметры

newDefaultStyle: ExcelScript.TableStyle | string

Объект TableStyle или имя TableStyle объекта, который должен быть новым значением по умолчанию.

Возвращаемое значение

void

setDefaultTimelineStyle(newDefaultStyle)

Задает стиль временная шкала по умолчанию для использования в область родительского объекта.

setDefaultTimelineStyle(newDefaultStyle: TimelineStyle | string): void;

Параметры

newDefaultStyle: ExcelScript.TimelineStyle | string

Объект TimelineStyle или имя TimelineStyle объекта, который должен быть новым значением по умолчанию.

Возвращаемое значение

void

setIsDirty(isDirty)

setIsDirty(isDirty: boolean): void;

Параметры

isDirty: boolean

Возвращаемое значение

void

setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)

Представляет режим обновления ссылок книги. Режим одинаков для всех ссылок книг, присутствующих в книге.

setLinkedWorkbookRefreshMode(
            linkedWorkbookRefreshMode: WorkbookLinksRefreshMode
        ): void;

Параметры

linkedWorkbookRefreshMode: ExcelScript.WorkbookLinksRefreshMode

Возвращаемое значение

void

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed: boolean): void;

Параметры

usePrecisionAsDisplayed: boolean

Возвращаемое значение

void

Поделиться через

ExcelScript.Workbook interface

Комментарии

Примеры

Методы

Сведения о методе

addBinding(range, bindingType, id)

Параметры

Возвращаемое значение

addBindingFromNamedItem(name, bindingType, id)

Параметры

Возвращаемое значение

addBindingFromSelection(bindingType, id)

Параметры

Возвращаемое значение

addComment(cellAddress, content, contentType)

Параметры

Возвращаемое значение

addCustomXmlPart(xml)

Параметры

Возвращаемое значение

addNamedItem(name, reference, comment)

Параметры

Возвращаемое значение

Примеры

addNamedItemFormulaLocal(name, formula, comment)

Параметры

Возвращаемое значение

addPivotTable(name, source, destination)

Параметры

Возвращаемое значение

Примеры

addPivotTableStyle(name, makeUniqueName)

Параметры

Возвращаемое значение

addPredefinedCellStyle(name)

Параметры

Возвращаемое значение

addSlicer(slicerSource, sourceField, slicerDestination)

Параметры

Возвращаемое значение

Примеры

addSlicerStyle(name, makeUniqueName)

Параметры

Возвращаемое значение

addTable(address, hasHeaders)

Параметры

Возвращаемое значение

Примеры

addTableStyle(name, makeUniqueName)

Параметры

Возвращаемое значение

addTimelineStyle(name, makeUniqueName)

Параметры

Возвращаемое значение

addWorksheet(name)

Параметры

Возвращаемое значение

Примеры

breakAllLinksToLinkedWorkbooks()

Возвращаемое значение

getActiveCell()

Возвращаемое значение

Примеры

getActiveChart()

Возвращаемое значение

getActiveSlicer()

Возвращаемое значение

getActiveWorksheet()

Возвращаемое значение

getApplication()

Возвращаемое значение

getAutoSave()

Возвращаемое значение

getBinding(id)

Параметры

Возвращаемое значение

getBindings()

Возвращаемое значение

getCalculationEngineVersion()