ExcelScript.Workbook interface

Workbook — это объект верхнего уровня, содержащий связанные объекты книг, такие как листы, таблицы, диапазоны и т. д. Чтобы узнать больше об объектной модели книги, читайте работу с книгами с помощью API JavaScript для Excel.

Методы

addBinding(range, bindingType, id)

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

addBindingFromNamedItem(name, bindingType, id)

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

addBindingFromSelection(bindingType, id)

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

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)

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

addTable(address, hasHeaders)

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

addTableStyle(name, makeUniqueName)

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

addTimelineStyle(name, makeUniqueName)

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

addWorksheet(name)

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

getActiveCell()

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

getActiveChart()

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

getActiveSlicer()

Получает текущий активный срез в книге. Если активный срез отсутствует, возвращается пустой объект.

getActiveWorksheet()

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

getApplication()

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

getAutoSave()

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

getBinding(id)

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

getBindings()

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

getCalculationEngineVersion()

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

getChartDataPointTrack()

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

getComment(commentId)

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

getCommentByCell(cellAddress)

Получает примечание из указанной ячейки.

getCommentByReplyId(replyId)

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

getComments()

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

getCustomXmlPart(id)

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

getCustomXmlPartByNamespace(namespaceUri)

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

getCustomXmlParts()

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

getDefaultPivotTableStyle()

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

getDefaultSlicerStyle()

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

getDefaultTableStyle()

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

getDefaultTimelineStyle()

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

getFirstWorksheet(visibleOnly)

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

getIsDirty()

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

getLastWorksheet(visibleOnly)

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

getName()

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

getNamedItem(name)

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

getNames()

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

getPivotTable(name)

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

getPivotTables()

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

getPivotTableStyle(name)

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

getPivotTableStyles()

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

getPredefinedCellStyle(name)

Получает стиль по имени.

getPredefinedCellStyles()

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

getPreviouslySaved()

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

getProperties()

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

getProtection()

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

getReadOnly()

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

getSelectedRange()

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

getSelectedRanges()

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

getSlicer(key)

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

getSlicers()

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

getSlicerStyle(name)

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

getSlicerStyles()

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

getTable(key)

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

getTables()

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

getTableStyle(name)

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

getTableStyles()

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

getTimelineStyle(name)

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

getTimelineStyles()

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

getUsePrecisionAsDisplayed()

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

getWorksheet(key)

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

getWorksheets()

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

refreshAllDataConnections()

Обновляет все подключения к данным.

refreshAllPivotTables()

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

setChartDataPointTrack(chartDataPointTrack)

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

setDefaultPivotTableStyle(newDefaultStyle)

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

setDefaultSlicerStyle(newDefaultStyle)

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

setDefaultTableStyle(newDefaultStyle)

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

setDefaultTimelineStyle(newDefaultStyle)

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

setIsDirty(isDirty)

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

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)

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

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

addBinding(range, bindingType, id)

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

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

Параметры

range
Range | string

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

bindingType
BindingType

Тип привязки. Обратитесь к разделу Excel. BindingType.

id
string

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

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

addBindingFromNamedItem(name, bindingType, id)

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

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

Параметры

name
string

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

bindingType
BindingType

Тип привязки. Обратитесь к разделу Excel. BindingType.

id
string

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

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

addBindingFromSelection(bindingType, id)

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

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

Параметры

bindingType
BindingType

Тип привязки. Обратитесь к разделу Excel. BindingType.

id
string

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

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

addComment(cellAddress, content, contentType)

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

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

Параметры

cellAddress
Range | string

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

content
CommentRichContent | string

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

contentType
ContentType

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

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

addCustomXmlPart(xml)

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

addCustomXmlPart(xml: string): CustomXmlPart;

Параметры

xml
string

XML-контент. Должен быть допустимым фрагментом XML.

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

addNamedItem(name, reference, comment)

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

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

Параметры

name
string

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

reference
Range | string

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

comment
string

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

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

addNamedItemFormulaLocal(name, formula, comment)

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

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

Параметры

name
string

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

formula
string

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

comment
string

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

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

addPivotTable(name, source, destination)

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

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

Параметры

name
string

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

source
Range | string | Table

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

destination
Range | string

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

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

addPivotTableStyle(name, makeUniqueName)

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

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

Параметры

name
string

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

makeUniqueName
boolean

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

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

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 | PivotTable | Table

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

sourceField
string | PivotField | number | TableColumn

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

slicerDestination
string | Worksheet

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

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

addSlicerStyle(name, makeUniqueName)

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

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

Параметры

name
string

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

makeUniqueName
boolean

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

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

addTable(address, hasHeaders)

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

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

Параметры

address
Range | string

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

hasHeaders
boolean

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

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

addTableStyle(name, makeUniqueName)

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

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

Параметры

name
string

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

makeUniqueName
boolean

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

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

addTimelineStyle(name, makeUniqueName)

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

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

Параметры

name
string

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

makeUniqueName
boolean

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

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

addWorksheet(name)

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

addWorksheet(name?: string): Worksheet;

Параметры

name
string

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

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

getActiveCell()

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

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

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

getActiveChart(): Chart;

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

getActiveSlicer()

Получает текущий активный срез в книге. Если активный срез отсутствует, возвращается пустой объект.

getActiveSlicer(): Slicer;

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

getActiveWorksheet()

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

getActiveWorksheet(): Worksheet;

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

getApplication()

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

getApplication(): Application;

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

getAutoSave()

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

getAutoSave(): boolean;

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

boolean

getBinding(id)

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

getBinding(id: string): Binding | undefined;

Параметры

id
string

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

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

Binding | undefined

getBindings()

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

getBindings(): Binding[];

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

getCalculationEngineVersion()

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

getCalculationEngineVersion(): number;

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

number

getChartDataPointTrack()

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

getChartDataPointTrack(): boolean;

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

boolean

getComment(commentId)

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

getComment(commentId: string): Comment;

Параметры

commentId
string

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

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

getCommentByCell(cellAddress)

Получает примечание из указанной ячейки.

getCommentByCell(cellAddress: Range | string): Comment;

Параметры

cellAddress
Range | string

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

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

getCommentByReplyId(replyId)

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

getCommentByReplyId(replyId: string): Comment;

Параметры

replyId
string

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

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

getComments()

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

getComments(): Comment[];

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

getCustomXmlPart(id)

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

getCustomXmlPart(id: string): CustomXmlPart | undefined;

Параметры

id
string

ИДЕНТИФИКАТОР получаемого объекта.

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

CustomXmlPart | undefined

getCustomXmlPartByNamespace(namespaceUri)

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

getCustomXmlPartByNamespace(namespaceUri: string): CustomXmlPart[];

Параметры

namespaceUri
string

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

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

getCustomXmlParts()

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

getCustomXmlParts(): CustomXmlPart[];

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

getDefaultPivotTableStyle()

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

getDefaultPivotTableStyle(): PivotTableStyle;

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

getDefaultSlicerStyle()

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

getDefaultSlicerStyle(): SlicerStyle;

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

getDefaultTableStyle()

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

getDefaultTableStyle(): TableStyle;

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

getDefaultTimelineStyle()

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

getDefaultTimelineStyle(): TimelineStyle;

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

getFirstWorksheet(visibleOnly)

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

getFirstWorksheet(visibleOnly?: boolean): Worksheet;

Параметры

visibleOnly
boolean

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

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

getIsDirty()

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

getIsDirty(): boolean;

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

boolean

getLastWorksheet(visibleOnly)

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

getLastWorksheet(visibleOnly?: boolean): Worksheet;

Параметры

visibleOnly
boolean

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

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

getName()

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

getName(): string;

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

string

getNamedItem(name)

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

getNamedItem(name: string): NamedItem | undefined;

Параметры

name
string

Имя NamedItem.

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

NamedItem | undefined

getNames()

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

getNames(): NamedItem[];

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

getPivotTable(name)

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

getPivotTable(name: string): PivotTable | undefined;

Параметры

name
string

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

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

PivotTable | undefined

getPivotTables()

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

getPivotTables(): PivotTable[];

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

getPivotTableStyle(name)

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

getPivotTableStyle(name: string): PivotTableStyle | undefined;

Параметры

name
string

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

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

PivotTableStyle | undefined

getPivotTableStyles()

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

getPivotTableStyles(): PivotTableStyle[];

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

getPredefinedCellStyle(name)

Получает стиль по имени.

getPredefinedCellStyle(name: string): PredefinedCellStyle;

Параметры

name
string

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

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

getPredefinedCellStyles()

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

getPredefinedCellStyles(): PredefinedCellStyle[];

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

getPreviouslySaved()

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

getPreviouslySaved(): boolean;

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

boolean

getProperties()

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

getProperties(): DocumentProperties;

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

getProtection()

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

getProtection(): WorkbookProtection;

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

getReadOnly()

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

getReadOnly(): boolean;

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

boolean

getSelectedRange()

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

getSelectedRange(): Range;

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

getSelectedRanges()

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

getSelectedRanges(): RangeAreas;

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

getSlicer(key)

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

getSlicer(key: string): Slicer | undefined;

Параметры

key
string

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

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

Slicer | undefined

getSlicers()

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

getSlicers(): Slicer[];

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

Slicer[]

getSlicerStyle(name)

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

getSlicerStyle(name: string): SlicerStyle | undefined;

Параметры

name
string

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

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

SlicerStyle | undefined

getSlicerStyles()

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

getSlicerStyles(): SlicerStyle[];

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

getTable(key)

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

getTable(key: string): Table | undefined;

Параметры

key
string

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

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

Table | undefined

getTables()

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

getTables(): Table[];

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

Table[]

getTableStyle(name)

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

getTableStyle(name: string): TableStyle | undefined;

Параметры

name
string

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

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

TableStyle | undefined

getTableStyles()

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

getTableStyles(): TableStyle[];

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

getTimelineStyle(name)

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

getTimelineStyle(name: string): TimelineStyle | undefined;

Параметры

name
string

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

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

TimelineStyle | undefined

getTimelineStyles()

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

getTimelineStyles(): TimelineStyle[];

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

getUsePrecisionAsDisplayed()

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

getUsePrecisionAsDisplayed(): boolean;

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

boolean

getWorksheet(key)

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

getWorksheet(key: string): Worksheet | undefined;

Параметры

key
string

Имя или ИД листа.

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

Worksheet | undefined

getWorksheets()

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

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

Обновляет все подключения к данным.

refreshAllDataConnections(): void;

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

void

refreshAllPivotTables()

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

refreshAllPivotTables(): void;

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

void

setChartDataPointTrack(chartDataPointTrack)

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

setChartDataPointTrack(chartDataPointTrack: boolean): void;

Параметры

chartDataPointTrack
boolean

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

void

setDefaultPivotTableStyle(newDefaultStyle)

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

setDefaultPivotTableStyle(
            newDefaultStyle: PivotTableStyle | string
        ): void;

Параметры

newDefaultStyle
PivotTableStyle | string

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

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

void

setDefaultSlicerStyle(newDefaultStyle)

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

setDefaultSlicerStyle(newDefaultStyle: SlicerStyle | string): void;

Параметры

newDefaultStyle
SlicerStyle | string

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

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

void

setDefaultTableStyle(newDefaultStyle)

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

setDefaultTableStyle(newDefaultStyle: TableStyle | string): void;

Параметры

newDefaultStyle
TableStyle | string

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

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

void

setDefaultTimelineStyle(newDefaultStyle)

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

setDefaultTimelineStyle(newDefaultStyle: TimelineStyle | string): void;

Параметры

newDefaultStyle
TimelineStyle | string

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

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

void

setIsDirty(isDirty)

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

setIsDirty(isDirty: boolean): void;

Параметры

isDirty
boolean

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

void

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)

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

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed: boolean): void;

Параметры

usePrecisionAsDisplayed
boolean

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

void