ExcelScript.Range interface

Пакет:

ExcelScript

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

Комментарии

Примеры

/**
 * This script logs the address of the used range in the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let currentWorksheet = workbook.getActiveWorksheet();

  // Get the range containing all the cells with data or formatting.
  let usedRange = currentWorksheet.getUsedRange();

  // Log the range's address to the console.
  console.log(usedRange.getAddress());
}

Методы

addConditionalFormat(type)	Добавляет новый условный формат в коллекцию с первым или верхним приоритетом.
autoFill(destinationRange, autoFillType)	Заполняет диапазон от текущего до целевого диапазона с помощью указанной логики автозаполнения. Диапазон назначения может быть null или может расширять диапазон источника по горизонтали или по вертикали. Несогласоные диапазоны не поддерживаются.
calculate()	Вычисляет диапазон ячеек на листе.
clear(applyTo)	Очищает значения, формат, заливку, границу диапазона и т. д.
clearAllConditionalFormats()	Полное удаление условного форматирование в указанном диапазоне.
convertDataTypeToText()	Преобразует ячейки диапазона с типами данных в текст.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Копирует данные ячейки или форматирование из исходного диапазона или RangeAreas в текущий диапазон. Диапазон назначения может отличаться от исходного диапазона или RangeAreas. Назначение развертывается автоматически, если оно меньше исходного. Примечание. Как и функция копирования в пользовательском интерфейсе Excel, если диапазон назначения точно больше исходного диапазона в строках или столбцах, исходное содержимое реплицируется несколько раз. Например, копирование диапазона 2x2 в диапазон 2x6 приведет к 3 копиям исходного диапазона 2x2.
delete(shift)	Удаляет ячейки, связанные с диапазоном.
find(text, criteria)	Находит определенную строку на основе указанных условий. Если текущий диапазон больше одной ячейки, поиск будет ограничен этим диапазоном, в противном случае поиск будет охватывать весь лист, начиная с этой ячейки. Если совпадений нет, этот метод возвращает undefined.
flashFill()	Выполняется заполнение флэш-памяти в текущем диапазоне. Flash Fill автоматически заполняет данные, когда он чувствует шаблон, поэтому диапазон должен быть одним диапазоном столбцов и содержать данные вокруг него, чтобы найти шаблон.
getAbsoluteResizedRange(numRows, numColumns)	Range Возвращает объект с той же левой верхней ячейкой, что и текущий Range объект, но с указанным числом строк и столбцов.
getAddress()	Указывает ссылку на диапазон в стиле A1. Значение address содержит ссылку на лист (например, "Лист1! A1:B4").
getAddressLocal()	Представляет ссылку на диапазон для указанного диапазона на языке пользователя.
getBoundingRect(anotherRange)	Возвращает наименьший объект диапазона, включающий в себя заданные диапазоны. Например, значения GetBoundingRect "B2:C5" и "D10:E15" — "B2:E15".
getCell(row, column)	Получает объект диапазона, содержащий одну ячейку, по номеру строки и столбца. Ячейка может находиться за пределами родительского диапазона, если она находится в сетке листа. Возвращаемая ячейка располагается относительно верхней левой ячейки диапазона.
getCellCount()	Указывает количество ячеек в диапазоне. Этот API возвращает значение -1, если количество ячеек превышает 2^31-1 (2,147,483,647).
getColumn(column)	Возвращает столбец в диапазоне.
getColumnCount()	Задает общее количество столбцов в диапазоне.
getColumnHidden()	Представляет, если все столбцы в текущем диапазоне скрыты. Значение — это true , когда все столбцы в диапазоне скрыты. Значение имеет значение, false если столбцы в диапазоне не скрыты. Значением считается, null когда некоторые столбцы в диапазоне скрыты, а другие столбцы в том же диапазоне не скрыты.
getColumnIndex()	Задает номер столбца первой ячейки в диапазоне. Используется нулевой индекс.
getColumnsAfter(count)	Возвращает определенное количество столбцов справа от текущего Range объекта.
getColumnsBefore(count)	Возвращает определенное количество столбцов слева от текущего Range объекта.
getConditionalFormat(id)	Возвращает условный формат, определяемый идентификатором. Если объект условного формата не существует, этот метод возвращает undefined.
getConditionalFormats()	Коллекция, ConditionalFormats пересекающая диапазон.
getDataValidation()	Возвращает объект проверки данных.
getDirectPrecedents()	WorkbookRangeAreas Возвращает объект , представляющий диапазон, содержащий все ячейки прямого прецедента указанного диапазона на одном листе или на нескольких листах.
getEntireColumn()	Возвращает объект, представляющий весь столбец диапазона (например, если текущий диапазон представляет ячейки "B4:E11", он getEntireColumn представляет собой диапазон, представляющий столбцы "B:E").
getEntireRow()	Возвращает объект, представляющий всю строку диапазона (например, если текущий диапазон представляет ячейки "B4:E11", он GetEntireRow представляет собой диапазон, представляющий строки "4:11").
getExtendedRange(direction, activeCell)	Возвращает объект диапазона, включающий текущий диапазон и до края диапазона на основе указанного направления. Это соответствует поведению клавиш CTRL+SHIFT+СТРЕЛКА в пользовательском интерфейсе Excel в Windows.
getFormat()	Возвращает объект формата, в который включены шрифт, заливка, границы, выравнивание и другие свойства диапазона.
getFormula()	Представляет формулу ячейки в нотации в стиле A1. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).
getFormulaLocal()	Представляет формулу ячейки в нотации в стиле A1 в языке пользователя и языковом стандарте форматирования чисел. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).
getFormulaR1C1()	Представляет формулу ячейки в нотации в стиле R1C1. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).
getFormulas()	Представляет формулу в формате A1. Если в ячейке нет формулы, возвращается ее значение.
getFormulasLocal()	Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.
getFormulasR1C1()	Представляет формулу в формате R1C1. Если в ячейке нет формулы, возвращается ее значение.
getHasSpill()	Указывает, есть ли во всех ячейках граница переноса. Возвращает значение true , если все ячейки имеют границу разлива или false если у всех ячеек нет границы разлива. Возвращает, null если в диапазоне имеются ячейки как с границами разлива, так и без них.
getHeight()	Возвращает расстояние в точках для 100 %-го увеличения от верхнего края диапазона до нижнего края диапазона.
getHidden()	Представляет, скрыты ли все ячейки в текущем диапазоне. Значение — это true , когда все ячейки в диапазоне скрыты. Значение — это значение false , когда ячейки в диапазоне не скрыты. Значение — это null , когда некоторые ячейки в диапазоне скрыты, а другие ячейки в том же диапазоне не скрыты.
getHyperlink()	Представляет гиперссылку для текущего диапазона.
getImage()	Отрисовывает диапазон в виде изображения PNG в кодировке Base64.
getIntersection(anotherRange)	Возвращает объект диапазона, представляющий прямоугольное пересечение заданных диапазонов. Если пересечение не найдено, этот метод возвращает undefined.
getIsEntireColumn()	Указывает, является ли текущий диапазон целым столбцом.
getIsEntireRow()	Указывает, является ли текущий диапазон целой строкой.
getLastCell()	Возвращает последнюю ячейку в диапазоне. Например, последняя ячейка диапазона B2:D5 — D5.
getLastColumn()	Возвращает последний столбец в диапазоне. Например, последний столбец диапазона B2:D5 — D2:D5.
getLastRow()	Возвращает последнюю строку в диапазоне. Например, последняя строка в диапазоне "B2:D5" — "B5:D5".
getLeft()	Возвращает расстояние в точках для 100 % увеличения от левого края листа до левого края диапазона.
getLinkedDataTypeState()	Представляет состояние типа данных ячейки.
getLinkedDataTypeStates()	Представляет состояние типа данных каждой ячейки.
getMergedAreas()	RangeAreas Возвращает объект , представляющий объединенные области в этом диапазоне. Обратите внимание, что если количество объединенных областей в этом диапазоне превышает 512, этот метод не вернет результат. RangeAreas Если объект не существует, эта функция возвращает undefined.
getNumberFormat()	Представляет код чисел в формате Excel ячейки для заданного диапазона. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).
getNumberFormatCategories()	Представляет категорию числового формата каждой ячейки.
getNumberFormatCategory()	Задает категорию числового формата первой ячейки в диапазоне (представлена индексом строки 0 и индексом столбца 0).
getNumberFormatLocal()	Представляет код номера ячейки Excel для заданного диапазона на основе языковых параметров пользователя. Excel не выполняет приведение языка или формата при получении или задании numberFormatLocal свойства. Любой возвращаемый текст использует строки в локальном формате на основе языка, указанного в параметрах системы. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).
getNumberFormats()	Представляет код числового формата Excel для заданного диапазона.
getNumberFormatsLocal()	Представляет код числового формата Excel для заданного диапазона на основе языковых параметров пользователя. Excel не выполняет приведение языка или формата при получении или задании numberFormatLocal свойства. Любой возвращаемый текст использует строки в локальном формате на основе языка, указанного в параметрах системы.
getOffsetRange(rowOffset, columnOffset)	Возвращает объект, представляющий диапазон, который смещен от указанного диапазона. Измерение возвращаемого диапазона будет соответствовать этому диапазону. Если результирующий диапазон выходит за пределы таблицы листа, возникнет ошибка.
getPivotTables(fullyContained)	Возвращает коллекцию сводных таблиц с заданной областью, перекрывающуюся с диапазоном.
getPredefinedCellStyle()	Представляет стиль текущего диапазона. Если стили ячеек несогласованны, null возвращается. Для пользовательских стилей будет возвращено имя стиля. Для встроенных стилей возвращается строка, представляющая значение в перечислении BuiltInStyle .
getRangeEdge(direction, activeCell)	Возвращает объект диапазона, представляющий собой реберную ячейку области данных, соответствующую указанному направлению. Это соответствует поведению клавиш CTRL+СТРЕЛКА в пользовательском интерфейсе Excel в Windows.
getResizedRange(deltaRows, deltaColumns)	Возвращает объект, аналогичный Range текущему Range объекту, но с его правым нижним углом, развернутым (или с сокращением) на некоторое количество строк и столбцов.
getRow(row)	Возвращает строку из диапазона.
getRowCount()	Возвращает общее количество строк в диапазоне.
getRowHidden()	Представляет, скрыты ли все строки в текущем диапазоне. Значение — это true , когда все строки в диапазоне скрыты. Значение — это значение false , когда строки в диапазоне не скрыты. Значением является, null когда некоторые строки в диапазоне скрыты, а другие строки в том же диапазоне не скрыты.
getRowIndex()	Возвращает номер строки первой ячейки диапазона. Используется нулевой индекс.
getRowsAbove(count)	Возвращает определенное количество строк над текущим Range объектом .
getRowsBelow(count)	Возвращает определенное количество строк под текущим Range объектом .
getSavedAsArray()	Представляет, будут ли все ячейки сохранены в виде формулы массива. Возвращает значение true , если все ячейки будут сохранены в виде формулы массива или false если все ячейки не будут сохранены в виде формулы массива. Возвращает значение null , если некоторые ячейки будут сохранены в виде формулы массива, а некоторые — нет.
getSort()	Представляет порядок сортировки текущего диапазона.
getSpecialCells(cellType, cellValueType)	Возвращает объект , состоящий RangeAreas из одного или нескольких диапазонов, который представляет все ячейки, соответствующие указанному типу и значению. Если специальные ячейки не найдены, этот метод возвращает undefined.
getSpillingToRange()	Получает объект range, содержащий диапазон переноса при вызове для базовой ячейки. Если диапазон не является ячейкой привязки или не удается найти диапазон разлива, то этот метод возвращает undefined.
getSpillParent()	Возвращает объект диапазона, содержащий ячейку привязки для ячейки, в нее попадает. Если это не разлитая ячейка или задано несколько ячеек, то этот метод возвращает undefined.
getSurroundingRegion()	Range Возвращает объект , представляющий окружающую область для левой верхней ячейки в этом диапазоне. Это диапазон, ограниченный любым сочетанием пустых строк и столбцов, относящихся к этому диапазону.
getTables(fullyContained)	Получает коллекцию таблиц с заданной областью, перекрывающую диапазон.
getText()	Представляет текстовое значение указанного диапазона. Текстовое значение не зависит от ширины ячейки. Замена знака #, которая происходит в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).
getTexts()	Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Подстановка числового знака (#), выполняемая в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API.
getTop()	Возвращает расстояние в точках для 100% увеличения от верхнего края листа до верхнего края диапазона.
getUsedRange(valuesOnly)	Возвращает используемый диапазон заданного объекта диапазона. Если в диапазоне нет используемых ячеек, этот метод возвращает undefined.
getValue()	Представляет необработанное значение указанного диапазона. Могут возвращаться строковые и числовые данные, а также логические значения. Ячейка, которая содержит ошибку, вернет строку ошибки. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).
getValues()	Представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строковыми, числовыми или логическими. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.
getValueType()	Представляет тип данных в ячейке. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).
getValueTypes()	Указывает тип данных в каждой ячейке.
getVisibleView()	Представляет видимые строки текущего диапазона.
getWidth()	Возвращает расстояние в точках для 100 %-го увеличения от левого края диапазона до правого края диапазона.
getWorksheet()	Лист, содержащий текущий диапазон.
group(groupOption)	Группы столбцы и строки для структуры.
hideGroupDetails(groupOption)	Скрывает сведения о группе строк или столбцов.
insert(shift)	Вставляет ячейку или диапазон ячеек на лист вместо этого диапазона, а также сдвигает другие ячейки, чтобы освободить место. Возвращает новый Range объект в пустом пространстве.
merge(across)	Объединяет ячейки диапазона в одну область на листе.
moveTo(destinationRange)	Перемещает значения ячеек, форматирование и формулы из текущего диапазона в целевой диапазон, заменяя старые сведения в этих ячейках. Диапазон назначения будет автоматически расширен, если он меньше текущего диапазона. Все ячейки в целевом диапазоне, которые находятся за пределами области исходного диапазона, не изменяются.
removeDuplicates(columns, includesHeader)	Удаляет повторяющиеся значения из диапазона, заданного столбцами.
replaceAll(text, replacement, criteria)	Находит и заменяет определенную строку на основе условий, указанных в текущем диапазоне.
select()	Выбирает указанный диапазон в пользовательском интерфейсе Excel.
setColumnHidden(columnHidden)	Представляет, если все столбцы в текущем диапазоне скрыты. Значение — это true , когда все столбцы в диапазоне скрыты. Значение имеет значение, false если столбцы в диапазоне не скрыты. Значением считается, null когда некоторые столбцы в диапазоне скрыты, а другие столбцы в том же диапазоне не скрыты.
setDirty()	Устанавливает диапазон, предназначенный для пересчета при выполнении следующего пересчета.
setFormula(formula)	Задает формулу ячейки в нотации в стиле A1. Если диапазон содержит несколько ячеек, каждая ячейка в заданном диапазоне будет обновлена с помощью входных данных.
setFormulaLocal(formulaLocal)	Задайте формулу ячейки в нотации в стиле A1 на языке пользователя и языковом стандарте форматирования чисел. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если диапазон содержит несколько ячеек, каждая ячейка в заданном диапазоне будет обновлена с помощью входных данных.
setFormulaR1C1(formulaR1C1)	Задает формулу ячейки в нотации в стиле R1C1. Если диапазон содержит несколько ячеек, каждая ячейка в заданном диапазоне будет обновлена с помощью входных данных.
setFormulas(formulas)	Представляет формулу в формате A1. Если в ячейке нет формулы, возвращается ее значение.
setFormulasLocal(formulasLocal)	Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.
setFormulasR1C1(formulasR1C1)	Представляет формулу в формате R1C1. Если в ячейке нет формулы, возвращается ее значение.
setHyperlink(hyperlink)	Представляет гиперссылку для текущего диапазона.
setNumberFormat(numberFormat)	Задает код нумерового формата excel ячейки для заданного диапазона. Если диапазон содержит несколько ячеек, каждая ячейка в заданном диапазоне будет обновлена с помощью входных данных.
setNumberFormatLocal(numberFormatLocal)	Задает код формата чисел excel ячейки для заданного диапазона на основе языковых параметров пользователя. Excel не выполняет приведение языка или формата при получении или задании numberFormatLocal свойства. Любой возвращаемый текст использует строки в локальном формате на основе языка, указанного в параметрах системы. Если диапазон содержит несколько ячеек, каждая ячейка в заданном диапазоне будет обновлена с помощью входных данных.
setNumberFormats(numberFormats)	Представляет код числового формата Excel для заданного диапазона.
setNumberFormatsLocal(numberFormatsLocal)	Представляет код числового формата Excel для заданного диапазона на основе языковых параметров пользователя. Excel не выполняет приведение языка или формата при получении или задании numberFormatLocal свойства. Любой возвращаемый текст использует строки в локальном формате на основе языка, указанного в параметрах системы.
setPredefinedCellStyle(predefinedCellStyle)	Представляет стиль текущего диапазона.
setRowHidden(rowHidden)	Представляет, скрыты ли все строки в текущем диапазоне. Значение — это true , когда все строки в диапазоне скрыты. Значение — это значение false , когда строки в диапазоне не скрыты. Значением является, null когда некоторые строки в диапазоне скрыты, а другие строки в том же диапазоне не скрыты.
setValue(value)	Задает необработанное значение указанного диапазона. Заданные данные могут быть типа string, number или boolean. null значение будет игнорироваться (не задано или перезаписывается в Excel). Если диапазон содержит несколько ячеек, каждая ячейка в заданном диапазоне будет обновлена с помощью входных данных.
setValues(values)	Задает необработанные значения указанного диапазона. Предоставленные данные могут быть строковыми, числовыми или логическими. Если указанное значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.
showCard()	Отображает карточку для активной ячейки, если она имеет содержимое c форматированным значением.
showGroupDetails(groupOption)	Показывает сведения о группе строк или столбцов.
ungroup(groupOption)	Разгруппирует столбцы и строки для структуры.
unmerge()	Разъединяет ячейки диапазона на отдельные ячейки.

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

addConditionalFormat(type)

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

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Параметры

type

ExcelScript.ConditionalFormatType

Тип добавляемого условного формата. Дополнительные сведения см. в этой ExcelScript.ConditionalFormatType статье.

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

ExcelScript.ConditionalFormat

Примеры

/**
 * This sample applies conditional formatting to the currently used range in the worksheet. 
 * The conditional formatting is a green fill for the top 10% of values.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the used range in the worksheet.
  let range = selectedSheet.getUsedRange();

  // Set the fill color to green for the top 10% of values in the range.
  let conditionalFormat = range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
  conditionalFormat.getTopBottom().getFormat().getFill().setColor("green");
  conditionalFormat.getTopBottom().setRule({
    rank: 10, // The percentage threshold.
    type: ExcelScript.ConditionalTopBottomCriterionType.topPercent // The type of the top/bottom condition.
  });
}

autoFill(destinationRange, autoFillType)

Заполняет диапазон от текущего до целевого диапазона с помощью указанной логики автозаполнения. Диапазон назначения может быть null или может расширять диапазон источника по горизонтали или по вертикали. Несогласоные диапазоны не поддерживаются.

autoFill(
            destinationRange?: Range | string,
            autoFillType?: AutoFillType
        ): void;

Параметры

destinationRange

ExcelScript.Range | string

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

autoFillType

ExcelScript.AutoFillType

Тип автозаполнения. Указывает способ заполнения целевого диапазона на основе содержимого текущего диапазона. Значение по умолчанию — FillDefault.

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

void

Примеры

/**
 * This script uses the autofill feature to complete a table.
 * See https://support.microsoft.com/office/74e31bdd-d993-45da-aa82-35a236c5b5db
 * for examples of autofill scenarios.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let currentWorksheet = workbook.getActiveWorksheet();

  // Get the data range that shows the pattern.
  let dataRange = currentWorksheet.getRange("C2:C3");

  // Autofill the connected range. C2:C3 are filled in. C4:C14 are blank.
  // This uses the default behavior to match a pattern with the table's contents.
  dataRange.autoFill("C2:C14");
}

calculate()

Вычисляет диапазон ячеек на листе.

calculate(): void;

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

void

Примеры

/**
 * This script recalculates the used range of a specific worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Only recalculate if the calculation mode is not set to automatic.
  if (workbook.getApplication().getCalculationMode() !== ExcelScript.CalculationMode.automatic) {
    // Get the used range from a worksheet named "Monthly Report".
    const sheet = workbook.getWorksheet("Monthly Report");
    const range = sheet.getUsedRange();
    console.log(`Calculating ${range.getAddress()}`);

    // Force all the used cells in that worksheet to calculate.
    sheet.getUsedRange().calculate();
  }
}

clear(applyTo)

Очищает значения, формат, заливку, границу диапазона и т. д.

clear(applyTo?: ClearApplyTo): void;

Параметры

applyTo

ExcelScript.ClearApplyTo

Необязательный параметр. Определяет тип действия очистки. Дополнительные сведения см. в этой ExcelScript.ClearApplyTo статье.

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

void

Примеры

/**
 * This script removes all the formatting from the selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  let range = workbook.getSelectedRange();

  // Clear all the formatting in that range.
  range.clear(ExcelScript.ClearApplyTo.formats);
}

clearAllConditionalFormats()

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

clearAllConditionalFormats(): void;

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

void

convertDataTypeToText()

Преобразует ячейки диапазона с типами данных в текст.

convertDataTypeToText(): void;

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

void

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Копирует данные ячейки или форматирование из исходного диапазона или RangeAreas в текущий диапазон. Диапазон назначения может отличаться от исходного диапазона или RangeAreas. Назначение развертывается автоматически, если оно меньше исходного. Примечание. Как и функция копирования в пользовательском интерфейсе Excel, если диапазон назначения точно больше исходного диапазона в строках или столбцах, исходное содержимое реплицируется несколько раз. Например, копирование диапазона 2x2 в диапазон 2x6 приведет к 3 копиям исходного диапазона 2x2.

copyFrom(
            sourceRange: Range | RangeAreas | string,
            copyType?: RangeCopyType,
            skipBlanks?: boolean,
            transpose?: boolean
        ): void;

Параметры

sourceRange

ExcelScript.Range | ExcelScript.RangeAreas | string

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

copyType

ExcelScript.RangeCopyType

Тип данных ячейки или форматирование для копирования. Значение по умолчанию — "All".

skipBlanks

boolean

Значение true, если пропускать пустые ячейки в исходном диапазоне. Значение по умолчанию: false.

transpose

boolean

Значение true, если требуется транспонировать ячейки в целевом диапазоне. Значение по умолчанию: false.

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

void

Примеры

/**
 * This script copies a table from one worksheet to a new worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the worksheet named "TableTemplate".
  let base = workbook.getWorksheet("TableTemplate");
  
  // Get the range to be copied based on the first table.
  let tableRange = base.getTables()[0].getRange();

  // Get the area in a new worksheet for the new table.
  let newWorksheet = workbook.addWorksheet();
  let newRange = newWorksheet.getRangeByIndexes(0,0, tableRange.getRowCount(), tableRange.getColumnCount());

  // Copy the existing data into the new range.
  newRange.copyFrom(tableRange);
}

delete(shift)

Удаляет ячейки, связанные с диапазоном.

delete(shift: DeleteShiftDirection): void;

Параметры

shift

ExcelScript.DeleteShiftDirection

Определяет способ сдвига ячеек. Дополнительные сведения см. в этой ExcelScript.DeleteShiftDirection статье.

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

void

Примеры

/**
 * This sample creates a sample range, then deletes
 * "A1" using different DeleteShiftDirection values.
 */
function main(workbook: ExcelScript.Workbook) {
  // Add sample data to better visualize the delete changes.
  const currentSheet = workbook.getActiveWorksheet();
  currentSheet.getRange("A1:D4").setValues([
    [1,2,3,4],
    [5,6,7,8],
    [9,10,11,12],
    [13,14,15,16]]);

  // Delete A1 and shift the cells from the right to fill the space.
  // The value being deleted is 1.
  currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.left);

  // Delete A1 and shift the cells from the bottom to fill the space.
  // The value being deleted is 2.
  currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.up);

  // Log the sample range. The values should be:
  /*
    5, 3, 4, "",
    9, 6, 7, 8,
    13, 10, 11, 12,
    "", 14, 15, 16
  */
  console.log(currentSheet.getRange("A1:D4").getValues()); 
}

find(text, criteria)

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

find(text: string, criteria: SearchCriteria): Range;

Параметры

text

string

Строка для поиска.

criteria

ExcelScript.SearchCriteria

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

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

ExcelScript.Range

Примеры

/**
 * This script searches through a table column and finds cells marked "no change". 
 * Those cells have "no change" replaced with the value from the cell to the left.
 * This script uses Range.find instead of Worksheet.findAll 
 * to limit the search to a specific range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range of a table named "Orders".
  let table = workbook.getTable("Orders");
  let range = table.getColumnByName("March").getRange();

  // Find all cells with the value "no change".
  let cellToOverwrite = range.find("no change", { completeMatch: true });
  while (cellToOverwrite) {
    let cellToCopyFrom = cellToOverwrite.getOffsetRange(0,-1);
    cellToOverwrite.setValue(cellToCopyFrom.getValue());
    cellToOverwrite = range.find("no change", { completeMatch: true });
  }
}

flashFill()

Выполняется заполнение флэш-памяти в текущем диапазоне. Flash Fill автоматически заполняет данные, когда он чувствует шаблон, поэтому диапазон должен быть одним диапазоном столбцов и содержать данные вокруг него, чтобы найти шаблон.

flashFill(): void;

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

void

Примеры

/**
 * This script uses the Flash Fill feature to complete a table.
 * See https://support.microsoft.com/office/3f9bcf1e-db93-4890-94a0-1578341f73f7
 * for the example table.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let currentWorksheet = workbook.getActiveWorksheet();

  // Get the data range with a pattern and cells to fill. C2 is filled in. C3:C6 are blank.
  let dataRange = currentWorksheet.getRange("C2:C6");

  // Flash fill the connected range. 
  dataRange.flashFill();
}

getAbsoluteResizedRange(numRows, numColumns)

Range Возвращает объект с той же левой верхней ячейкой, что и текущий Range объект, но с указанным числом строк и столбцов.

getAbsoluteResizedRange(numRows: number, numColumns: number): Range;

Параметры

numRows

number

Количество строк нового размера диапазона.

numColumns

number

Количество столбцов нового размера диапазона.

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

ExcelScript.Range

getAddress()

Указывает ссылку на диапазон в стиле A1. Значение address содержит ссылку на лист (например, "Лист1! A1:B4").

getAddress(): string;

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

string

Примеры

/**
 * This script logs the address of the used range in each worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Iterate over every worksheet in the workbook.
  workbook.getWorksheets().forEach((sheet) => {
    // Get the used range for a single worksheet.
    let range = sheet.getUsedRange();

    // Print the address of the used range to the console.
    console.log(range.getAddress());
  });
}

getAddressLocal()

Представляет ссылку на диапазон для указанного диапазона на языке пользователя.

getAddressLocal(): string;

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

string

getBoundingRect(anotherRange)

Возвращает наименьший объект диапазона, включающий в себя заданные диапазоны. Например, значения GetBoundingRect "B2:C5" и "D10:E15" — "B2:E15".

getBoundingRect(anotherRange: Range | string): Range;

Параметры

anotherRange

ExcelScript.Range | string

Объект диапазона, адрес или имя диапазона.

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

ExcelScript.Range

Примеры

/**
 * This script gets the bounding range of two existing ranges and puts a border around it.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let sheet = workbook.getActiveWorksheet();

  // Create two range objects for the sample.
  let range1 = sheet.getRange("B2:C5");
  let range2 = sheet.getRange("D10:E15");

  // Get the rectangular range that fully includes both ranges.
  let boundingRectangle = range1.getBoundingRect(range2);

  // Add a border around the whole bounding range (B2:E15).
  let format = boundingRectangle.getFormat();
  format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
}

getCell(row, column)

Получает объект диапазона, содержащий одну ячейку, по номеру строки и столбца. Ячейка может находиться за пределами родительского диапазона, если она находится в сетке листа. Возвращаемая ячейка располагается относительно верхней левой ячейки диапазона.

getCell(row: number, column: number): Range;

Параметры

row

number

Номер строки ячейки, которую требуется извлечь. Используется нулевой индекс.

column

number

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

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

ExcelScript.Range

getCellCount()

Указывает количество ячеек в диапазоне. Этот API возвращает значение -1, если количество ячеек превышает 2^31-1 (2,147,483,647).

getCellCount(): number;

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

number

getColumn(column)

Возвращает столбец в диапазоне.

getColumn(column: number): Range;

Параметры

column

number

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

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

ExcelScript.Range

getColumnCount()

Задает общее количество столбцов в диапазоне.

getColumnCount(): number;

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

number

Примеры

/**
 * This sample provides the count of negative numbers that are present
 * in the used range of the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the working range.
  let usedRange = workbook.getActiveWorksheet().getUsedRange();
  let rowCount = usedRange.getRowCount();
  let columnCount = usedRange.getColumnCount();

  // Save the values locally to avoid repeatedly asking the workbook.
  let usedRangeValues = usedRange.getValues();

  // Start the negative number counter.
  let negativeCount = 0;

  // Iterate over the entire range looking for negative numbers.
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < columnCount; j++) {
      if (usedRangeValues[i][j] < 0) {
        negativeCount++;
      }
    }
  }

  // Log the negative number count to the console.
  console.log(negativeCount);
}

getColumnHidden()

Представляет, если все столбцы в текущем диапазоне скрыты. Значение — это true , когда все столбцы в диапазоне скрыты. Значение имеет значение, false если столбцы в диапазоне не скрыты. Значением считается, null когда некоторые столбцы в диапазоне скрыты, а другие столбцы в том же диапазоне не скрыты.

getColumnHidden(): boolean;

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

boolean

getColumnIndex()

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

getColumnIndex(): number;

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

number

getColumnsAfter(count)

Возвращает определенное количество столбцов справа от текущего Range объекта.

getColumnsAfter(count?: number): Range;

Параметры

count

number

Необязательный параметр. Количество столбцов, включаемых в полученный диапазон. Чтобы создать диапазон за пределами текущего диапазона, используйте положительное число. Вы также можете использовать отрицательное число, чтобы создать диапазон в рамках текущего диапазона. Значение по умолчанию равно 1.

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

ExcelScript.Range

getColumnsBefore(count)

Возвращает определенное количество столбцов слева от текущего Range объекта.

getColumnsBefore(count?: number): Range;

Параметры

count

number

Необязательный параметр. Количество столбцов, включаемых в полученный диапазон. Чтобы создать диапазон за пределами текущего диапазона, используйте положительное число. Вы также можете использовать отрицательное число, чтобы создать диапазон в рамках текущего диапазона. Значение по умолчанию равно 1.

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

ExcelScript.Range

getConditionalFormat(id)

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

getConditionalFormat(id: string): ConditionalFormat | undefined;

Параметры

id

string

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

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

ExcelScript.ConditionalFormat | undefined

getConditionalFormats()

Коллекция, ConditionalFormats пересекающая диапазон.

getConditionalFormats(): ConditionalFormat[];

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

ExcelScript.ConditionalFormat[]

getDataValidation()

Возвращает объект проверки данных.

getDataValidation(): DataValidation;

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

ExcelScript.DataValidation

Примеры

/**
 * This script creates a drop-down selection list for a cell. It uses the existing values of the selected range as the choices for the list.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the values for data validation.
  let selectedRange = workbook.getSelectedRange();
  let rangeValues = selectedRange.getValues();

  // Convert the values into a comma-delimited string.
  let dataValidationListString = "";
  rangeValues.forEach((rangeValueRow) => {
    rangeValueRow.forEach((value) => {
      dataValidationListString += value + ",";
    });
  });

  // Clear the old range.
  selectedRange.clear(ExcelScript.ClearApplyTo.contents);

  // Apply the data validation to the first cell in the selected range.
  let targetCell = selectedRange.getCell(0,0);
  let dataValidation = targetCell.getDataValidation();

  // Set the content of the drop-down list.
  dataValidation.setRule({
      list: {
        inCellDropDown: true,
        source: dataValidationListString
      }
    });
}

getDirectPrecedents()

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

getDirectPrecedents(): WorkbookRangeAreas;

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

ExcelScript.WorkbookRangeAreas

Примеры

/**
 * This script finds the direct precedents of the active cell.
 * It changes the font and color of those precedent cells. 
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  const selected = workbook.getActiveCell();
  
  // Get the cells that are direct precedents of the current cell.
  const precedents : ExcelScript.WorkbookRangeAreas = selected.getDirectPrecedents();

  // Set the font to bold and the fill color to orange for all the precedent cells.
  precedents.getRanges().forEach(range => {
    range.getFormat().getFill().setColor("orange");
    range.getFormat().getFont().setBold(true);
  });
}

getEntireColumn()

Возвращает объект, представляющий весь столбец диапазона (например, если текущий диапазон представляет ячейки "B4:E11", он getEntireColumn представляет собой диапазон, представляющий столбцы "B:E").

getEntireColumn(): Range;

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

ExcelScript.Range

getEntireRow()

Возвращает объект, представляющий всю строку диапазона (например, если текущий диапазон представляет ячейки "B4:E11", он GetEntireRow представляет собой диапазон, представляющий строки "4:11").

getEntireRow(): Range;

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

ExcelScript.Range

getExtendedRange(direction, activeCell)

Возвращает объект диапазона, включающий текущий диапазон и до края диапазона на основе указанного направления. Это соответствует поведению клавиш CTRL+SHIFT+СТРЕЛКА в пользовательском интерфейсе Excel в Windows.

getExtendedRange(
            direction: KeyboardDirection,
            activeCell?: Range | string
        ): Range;

Параметры

direction

ExcelScript.KeyboardDirection

Направление от активной ячейки.

activeCell

ExcelScript.Range | string

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

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

ExcelScript.Range

Примеры

/**
 * This script makes the font bold on all the contiguous cells between 
 * A1 and the bottom of the used range of the first column.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get every cell that's used between A1 and the end of the column.
  // This recreates the Ctrl+Shift+Down arrow key behavior.
  let firstCell = selectedSheet.getRange("A1");
  let firstColumn = firstCell.getExtendedRange(ExcelScript.KeyboardDirection.down);

  // Set the font to bold in that range.
  firstColumn.getFormat().getFont().setBold(true);
}

getFormat()

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

getFormat(): RangeFormat;

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

ExcelScript.RangeFormat

Примеры

/**
 * This script gives the total row of a table a green color fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  let table = workbook.getTables()[0];

  // Get the range for the total row of the table.
  let totalRange = table.getTotalRowRange();

  // Set the fill color to green.
  totalRange.getFormat().getFill().setColor("green");
}

getFormula()

Представляет формулу ячейки в нотации в стиле A1. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).

getFormula(): string;

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

string

Примеры

/*
 * This script sets a cell's formula, 
 * then displays how Excel stores the cell's formula and value separately.
 */
function main(workbook: ExcelScript.Workbook) {
  let selectedSheet = workbook.getActiveWorksheet();

  // Set A1 to 2.
  let a1 = selectedSheet.getRange("A1");
  a1.setValue(2);

  // Set B1 to the formula =(2*A1), which should equal 4.
  let b1 = selectedSheet.getRange("B1")
  b1.setFormula("=(2*A1)");

  // Log the current results for `getFormula` and `getValue` at B1.
  console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
}

getFormulaLocal()

Представляет формулу ячейки в нотации в стиле A1 в языке пользователя и языковом стандарте форматирования чисел. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).

getFormulaLocal(): string;

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

string

getFormulaR1C1()

Представляет формулу ячейки в нотации в стиле R1C1. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).

getFormulaR1C1(): string;

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

string

getFormulas()

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

getFormulas(): string[][];

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

string[][]

getFormulasLocal()

Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.

getFormulasLocal(): string[][];

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

string[][]

getFormulasR1C1()

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

getFormulasR1C1(): string[][];

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

string[][]

getHasSpill()

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

getHasSpill(): boolean;

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

boolean

getHeight()

Возвращает расстояние в точках для 100 %-го увеличения от верхнего края диапазона до нижнего края диапазона.

getHeight(): number;

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

number

getHidden()

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

getHidden(): boolean;

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

boolean

getHyperlink()

Представляет гиперссылку для текущего диапазона.

getHyperlink(): RangeHyperlink;

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

ExcelScript.RangeHyperlink

Примеры

/**
 * This sample clears all of the hyperlinks from the current worksheet
 * and removes the usual hyperlink formatting.
 */
function main(workbook: ExcelScript.Workbook, sheetName: string = 'Sheet1') {
  // Get the active worksheet. 
  let sheet = workbook.getWorksheet(sheetName);

  // Get the used range to operate on.
  // For large ranges (over 10000 entries), consider splitting the operation into batches for performance.
  const targetRange = sheet.getUsedRange(true);
  console.log(`Target Range to clear hyperlinks from: ${targetRange.getAddress()}`);

  const rowCount = targetRange.getRowCount();
  const colCount = targetRange.getColumnCount();
  console.log(`Searching for hyperlinks in ${targetRange.getAddress()} which contains ${(rowCount * colCount)} cells`);

  // Go through each individual cell looking for a hyperlink. 
  // This allows us to limit the formatting changes to only the cells with hyperlink formatting.
  let clearedCount = 0;
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < colCount; j++) {
      const cell = targetRange.getCell(i, j);
      const hyperlink = cell.getHyperlink();
      if (hyperlink) {
        cell.clear(ExcelScript.ClearApplyTo.hyperlinks);
        cell.getFormat().getFont().setUnderline(ExcelScript.RangeUnderlineStyle.none);
        cell.getFormat().getFont().setColor('Black');
        clearedCount++;
      }
    }
  }

  console.log(`Done. Cleared hyperlinks from ${clearedCount} cells`);
}

getImage()

Отрисовывает диапазон в виде изображения PNG в кодировке Base64.

getImage(): string;

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

string

getIntersection(anotherRange)

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

getIntersection(anotherRange: Range | string): Range;

Параметры

anotherRange

ExcelScript.Range | string

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

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

ExcelScript.Range

getIsEntireColumn()

Указывает, является ли текущий диапазон целым столбцом.

getIsEntireColumn(): boolean;

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

boolean

getIsEntireRow()

Указывает, является ли текущий диапазон целой строкой.

getIsEntireRow(): boolean;

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

boolean

getLastCell()

Возвращает последнюю ячейку в диапазоне. Например, последняя ячейка диапазона B2:D5 — D5.

getLastCell(): Range;

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

ExcelScript.Range

getLastColumn()

Возвращает последний столбец в диапазоне. Например, последний столбец диапазона B2:D5 — D2:D5.

getLastColumn(): Range;

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

ExcelScript.Range

getLastRow()

Возвращает последнюю строку в диапазоне. Например, последняя строка в диапазоне "B2:D5" — "B5:D5".

getLastRow(): Range;

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

ExcelScript.Range

getLeft()

Возвращает расстояние в точках для 100 % увеличения от левого края листа до левого края диапазона.

getLeft(): number;

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

number

getLinkedDataTypeState()

Представляет состояние типа данных ячейки.

getLinkedDataTypeState(): LinkedDataTypeState;

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

ExcelScript.LinkedDataTypeState

getLinkedDataTypeStates()

Представляет состояние типа данных каждой ячейки.

getLinkedDataTypeStates(): LinkedDataTypeState[][];

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

ExcelScript.LinkedDataTypeState[][]

getMergedAreas()

RangeAreas Возвращает объект , представляющий объединенные области в этом диапазоне. Обратите внимание, что если количество объединенных областей в этом диапазоне превышает 512, этот метод не вернет результат. RangeAreas Если объект не существует, эта функция возвращает undefined.

getMergedAreas(): RangeAreas;

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

ExcelScript.RangeAreas

getNumberFormat()

Представляет код чисел в формате Excel ячейки для заданного диапазона. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).

getNumberFormat(): string;

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

string

getNumberFormatCategories()

Представляет категорию числового формата каждой ячейки.

getNumberFormatCategories(): NumberFormatCategory[][];

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

ExcelScript.NumberFormatCategory[][]

Примеры

/**
 * This script finds cells in a table column that are not formatted as currency
 * and sets the fill color to red.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the "Cost" column from the "Expenses" table.
  const table = workbook.getTable("Expenses");
  const costColumn = table.getColumnByName("Cost");
  const costColumnRange = costColumn.getRangeBetweenHeaderAndTotal();

  // Get the number format categories for the column's range.
  const numberFormatCategories = costColumnRange.getNumberFormatCategories();

  // If any cell in the column doesn't have a currency format, make the cell red.
  numberFormatCategories.forEach((category, index) =>{
    if (category[0] != ExcelScript.NumberFormatCategory.currency) {
      costColumnRange.getCell(index, 0).getFormat().getFill().setColor("red");
    }
  }); 
}

getNumberFormatCategory()

Задает категорию числового формата первой ячейки в диапазоне (представлена индексом строки 0 и индексом столбца 0).

getNumberFormatCategory(): NumberFormatCategory;

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

ExcelScript.NumberFormatCategory

getNumberFormatLocal()

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

getNumberFormatLocal(): string;

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

string

getNumberFormats()

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

getNumberFormats(): string[][];

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

string[][]

getNumberFormatsLocal()

Представляет код числового формата Excel для заданного диапазона на основе языковых параметров пользователя. Excel не выполняет приведение языка или формата при получении или задании numberFormatLocal свойства. Любой возвращаемый текст использует строки в локальном формате на основе языка, указанного в параметрах системы.

getNumberFormatsLocal(): string[][];

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

string[][]

getOffsetRange(rowOffset, columnOffset)

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

getOffsetRange(rowOffset: number, columnOffset: number): Range;

Параметры

rowOffset

number

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

columnOffset

number

Количество столбцов (положительное, отрицательное или 0), на который нужно сместить диапазон. Положительные значения соответствуют смещению вправо, а отрицательные — влево.

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

ExcelScript.Range

Примеры

/**
 * This script gets adjacent cells using relative references.
 * Note that if the active cell is on the top row, part of the script fails, 
 * because it references the cell above the currently selected one.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the currently active cell in the workbook.
  let activeCell = workbook.getActiveCell();
  console.log(`The active cell's address is: ${activeCell.getAddress()}`);

  // Get the cell to the right of the active cell and set its value and color.
  let rightCell = activeCell.getOffsetRange(0,1);
  rightCell.setValue("Right cell");
  console.log(`The right cell's address is: ${rightCell.getAddress()}`);
  rightCell.getFormat().getFont().setColor("Magenta");
  rightCell.getFormat().getFill().setColor("Cyan");

  // Get the cell to the above of the active cell and set its value and color.
  // Note that this operation will fail if the active cell is in the top row.
  let aboveCell = activeCell.getOffsetRange(-1, 0);
  aboveCell.setValue("Above cell");
  console.log(`The above cell's address is: ${aboveCell.getAddress()}`);
  aboveCell.getFormat().getFont().setColor("White");
  aboveCell.getFormat().getFill().setColor("Black");
}

getPivotTables(fullyContained)

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

getPivotTables(fullyContained?: boolean): PivotTable[];

Параметры

fullyContained

boolean

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

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

ExcelScript.PivotTable[]

getPredefinedCellStyle()

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

getPredefinedCellStyle(): string;

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

string

getRangeEdge(direction, activeCell)

Возвращает объект диапазона, представляющий собой реберную ячейку области данных, соответствующую указанному направлению. Это соответствует поведению клавиш CTRL+СТРЕЛКА в пользовательском интерфейсе Excel в Windows.

getRangeEdge(
            direction: KeyboardDirection,
            activeCell?: Range | string
        ): Range;

Параметры

direction

ExcelScript.KeyboardDirection

Направление от активной ячейки.

activeCell

ExcelScript.Range | string

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

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

ExcelScript.Range

Примеры

/**
 * This script adds the value "Total" after the end of the first column.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the last used cell at the end of the column.
  // This recreates the Ctrl+Down arrow key behavior.
  let firstCell = selectedSheet.getRange("A1");
  let firstColumn = selectedSheet.getRange("A1").getRangeEdge(ExcelScript.KeyboardDirection.down);
  let cellAfter = firstColumn.getOffsetRange(1, 0);

  // Set the value of the cell after the current end of the used column to "Total".
  cellAfter.setValue("Total");
}

getResizedRange(deltaRows, deltaColumns)

Возвращает объект, аналогичный Range текущему Range объекту, но с его правым нижним углом, развернутым (или с сокращением) на некоторое количество строк и столбцов.

getResizedRange(deltaRows: number, deltaColumns: number): Range;

Параметры

deltaRows

number

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

deltaColumns

number

Число столбцов, на которые необходимо развернуть правый нижний угол относительно текущего диапазона. Используйте положительное число, чтобы расширить диапазон или отрицательное число, чтобы уменьшить его.

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

ExcelScript.Range

Примеры

/**
 * This script copies the formatting in the active cell to the neighboring cells.
 * Note that this script only works when the active cell isn't on an edge of the worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  let activeCell = workbook.getActiveCell();

  // Get the cell that's one row above and one column to the left of the active cell.
  let cornerCell = activeCell.getOffsetRange(-1,-1);

  // Get a range that includes all the cells surrounding the active cell.
  let surroundingRange = cornerCell.getResizedRange(2, 2)

  // Copy the formatting from the active cell to the new range.
  surroundingRange.copyFrom(
    activeCell, /* The source range. */
    ExcelScript.RangeCopyType.formats /* What to copy. */
  );
}

getRow(row)

Возвращает строку из диапазона.

getRow(row: number): Range;

Параметры

row

number

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

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

ExcelScript.Range

getRowCount()

Возвращает общее количество строк в диапазоне.

getRowCount(): number;

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

number

Примеры

/**
 * This sample provides the count of negative numbers that are present
 * in the used range of the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the working range.
  let usedRange = workbook.getActiveWorksheet().getUsedRange();
  let rowCount = usedRange.getRowCount();
  let columnCount = usedRange.getColumnCount();

  // Save the values locally to avoid repeatedly asking the workbook.
  let usedRangeValues = usedRange.getValues();

  // Start the negative number counter.
  let negativeCount = 0;

  // Iterate over the entire range looking for negative numbers.
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < columnCount; j++) {
      if (usedRangeValues[i][j] < 0) {
        negativeCount++;
      }
    }
  }

  // Log the negative number count to the console.
  console.log(negativeCount);
}

getRowHidden()

Представляет, скрыты ли все строки в текущем диапазоне. Значение — это true , когда все строки в диапазоне скрыты. Значение — это значение false , когда строки в диапазоне не скрыты. Значением является, null когда некоторые строки в диапазоне скрыты, а другие строки в том же диапазоне не скрыты.

getRowHidden(): boolean;

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

boolean

getRowIndex()

Возвращает номер строки первой ячейки диапазона. Используется нулевой индекс.

getRowIndex(): number;

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

number

getRowsAbove(count)

Возвращает определенное количество строк над текущим Range объектом .

getRowsAbove(count?: number): Range;

Параметры

count

number

Необязательный параметр. Количество строк, включаемых в полученный диапазон. Чтобы создать диапазон за пределами текущего диапазона, используйте положительное число. Вы также можете использовать отрицательное число, чтобы создать диапазон в рамках текущего диапазона. Значение по умолчанию равно 1.

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

ExcelScript.Range

getRowsBelow(count)

Возвращает определенное количество строк под текущим Range объектом .

getRowsBelow(count?: number): Range;

Параметры

count

number

Необязательный параметр. Количество строк, включаемых в полученный диапазон. Чтобы создать диапазон за пределами текущего диапазона, используйте положительное число. Вы также можете использовать отрицательное число, чтобы создать диапазон в рамках текущего диапазона. Значение по умолчанию равно 1.

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

ExcelScript.Range

getSavedAsArray()

Представляет, будут ли все ячейки сохранены в виде формулы массива. Возвращает значение true , если все ячейки будут сохранены в виде формулы массива или false если все ячейки не будут сохранены в виде формулы массива. Возвращает значение null , если некоторые ячейки будут сохранены в виде формулы массива, а некоторые — нет.

getSavedAsArray(): boolean;

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

boolean

getSort()

Представляет порядок сортировки текущего диапазона.

getSort(): RangeSort;

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

ExcelScript.RangeSort

getSpecialCells(cellType, cellValueType)

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

getSpecialCells(
            cellType: SpecialCellType,
            cellValueType?: SpecialCellValueType
        ): RangeAreas;

Параметры

cellType

ExcelScript.SpecialCellType

Тип включаемых ячеек.

cellValueType

ExcelScript.SpecialCellValueType

Если cellType имеет значение constants или formulas, этот аргумент используется для определения типов ячеек, которые следует включить в результат. Эти значения можно объединить для возврата нескольких типов. По умолчанию выбирается все константы или формулы независимо от типа.

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

ExcelScript.RangeAreas

Примеры

/**
 * This sample gets all the blank cells in the current worksheet's used range. It then highlights all those cells with a yellow background.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the current used range.
    let range = workbook.getActiveWorksheet().getUsedRange();
    
    // Get all the blank cells.
    let blankCells = range.getSpecialCells(ExcelScript.SpecialCellType.blanks);
    // Highlight the blank cells with a yellow background.
    blankCells.getFormat().getFill().setColor("yellow");
}

getSpillingToRange()

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

getSpillingToRange(): Range;

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

ExcelScript.Range

getSpillParent()

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

getSpillParent(): Range;

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

ExcelScript.Range

getSurroundingRegion()

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

getSurroundingRegion(): Range;

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

ExcelScript.Range

getTables(fullyContained)

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

getTables(fullyContained?: boolean): Table[];

Параметры

fullyContained

boolean

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

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

ExcelScript.Table[]

getText()

Представляет текстовое значение указанного диапазона. Текстовое значение не зависит от ширины ячейки. Замена знака #, которая происходит в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).

getText(): string;

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

string

getTexts()

Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Подстановка числового знака (#), выполняемая в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API.

getTexts(): string[][];

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

string[][]

getTop()

Возвращает расстояние в точках для 100% увеличения от верхнего края листа до верхнего края диапазона.

getTop(): number;

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

number

getUsedRange(valuesOnly)

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

getUsedRange(valuesOnly?: boolean): Range;

Параметры

valuesOnly

boolean

Учитывает только ячейки со значениями.

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

ExcelScript.Range

getValue()

Представляет необработанное значение указанного диапазона. Могут возвращаться строковые и числовые данные, а также логические значения. Ячейка, которая содержит ошибку, вернет строку ошибки. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные индексом строки 0 и индексом столбца 0).

getValue(): string | number | boolean;

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

string | number | boolean

Примеры

/**
 * This sample reads the value of A1 and prints it to the console.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the value of cell A1.
  let range = selectedSheet.getRange("A1");
  
  // Print the value of A1.
  console.log(range.getValue());
}

getValues()

Представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строковыми, числовыми или логическими. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.

getValues(): (string | number | boolean)[][];

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

(string | number | boolean)[][]

getValueType()

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

getValueType(): RangeValueType;

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

ExcelScript.RangeValueType

Примеры

/**
 * This script formats rows in a worksheet based on the first value in that row. 
 * If it's the boolean value TRUE, the row is bolded. 
 * If it's FALSE, nothing is changed. 
 * If the value type isn't a boolean, the row is italicized.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range in the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const usedRange = sheet.getUsedRange();

  // Get the values in the first column.
  const firstColumnValues = usedRange.getColumn(0).getValues();

  // Look at the first cell in each row.
  const rowCount = usedRange.getRowCount();
  for (let i = 0; i < rowCount; i++) {
    // Get the type of the first cell to make sure it's a boolean.
    let firstValueType = usedRange.getCell(i, 0).getValueType();

    // Set the bold or italic of the row as described earlier.
    if (firstValueType === ExcelScript.RangeValueType.boolean) {
      if (firstColumnValues[i][0] as boolean === true) {
        usedRange.getRow(i).getFormat().getFont().setBold(true);
      } else {
        usedRange.getRow(i).getFormat().getFont().setBold(false);
      }
    } else {
      usedRange.getRow(i).getFormat().getFont().setItalic(true);
    }
  }
}

getValueTypes()

Указывает тип данных в каждой ячейке.

getValueTypes(): RangeValueType[][];

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

ExcelScript.RangeValueType[][]

getVisibleView()

Представляет видимые строки текущего диапазона.

getVisibleView(): RangeView;

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

ExcelScript.RangeView

Примеры

/**
 * This script copies values and formatting from the 
 * visible range of a table in Sheet1 into Sheet2.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the filtered data from Sheet1.
  const currentSheet = workbook.getWorksheet("Sheet1");
  const table = currentSheet.getTables()[0];
  const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
  const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());

  // Copy the data into the other sheet.
  const otherSheet = workbook.getWorksheet("Sheet2");
  const otherRangeCorner = otherSheet.getRange("A1");
  otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
}

getWidth()

Возвращает расстояние в точках для 100 %-го увеличения от левого края диапазона до правого края диапазона.

getWidth(): number;

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

number

getWorksheet()

Лист, содержащий текущий диапазон.

getWorksheet(): Worksheet;

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

ExcelScript.Worksheet

group(groupOption)

Группы столбцы и строки для структуры.

group(groupOption: GroupOption): void;

Параметры

groupOption

ExcelScript.GroupOption

Указывает, как можно группировать диапазон по строкам или столбцам. Ошибка InvalidArgument возникает, если параметр группы отличается от свойства диапазона isEntireRow или isEntireColumn (т. е. имеет значение true и range.isEntireRowgroupOption имеет значение "ByColumns" или range.isEntireColumn true и groupOption имеет значение "ByRows").

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

void

Примеры

/**
 * This script creates a two-level column-based outline on Sheet1.
 */
function main(workbook: ExcelScript.Workbook) {
  // Group columns A-F in the worksheet named Sheet1.
  const sheet = workbook.getWorksheet("Sheet1");
  const firstLevel = sheet.getRange("A:F");
  firstLevel.group(ExcelScript.GroupOption.byColumns);
  
  // Create a second level to the outline by grouping subsections.
  sheet.getRange("A:B").group(ExcelScript.GroupOption.byColumns);
  sheet.getRange("D:E").group(ExcelScript.GroupOption.byColumns);
}

hideGroupDetails(groupOption)

Скрывает сведения о группе строк или столбцов.

hideGroupDetails(groupOption: GroupOption): void;

Параметры

groupOption

ExcelScript.GroupOption

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

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

void

insert(shift)

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

insert(shift: InsertShiftDirection): Range;

Параметры

shift

ExcelScript.InsertShiftDirection

Определяет способ сдвига ячеек. Дополнительные сведения см. в этой ExcelScript.InsertShiftDirection статье.

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

ExcelScript.Range

Примеры

/**
 * This script inserts headers at the top of the worksheet.
 */
function main(workbook: ExcelScript.Workbook)
{
  let currentSheet = workbook.getActiveWorksheet();

  // Create headers for 3 columns.
  let myHeaders = [["NAME", "ID", "ROLE"]];

  // Add a blank first row and push existing data down a row.
  let firstRow = currentSheet.getRange("1:1");
  firstRow.insert(ExcelScript.InsertShiftDirection.down);

  // Add the headers.
  currentSheet.getRange("A1:C1").setValues(myHeaders);
}

merge(across)

Объединяет ячейки диапазона в одну область на листе.

merge(across?: boolean): void;

Параметры

across

boolean

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

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

void

Примеры

/**
 * This script merges a group of cells into a single region.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active worksheet.
  const selectedSheet = workbook.getActiveWorksheet();

  // Merge cells A1 through A4.
  const range = selectedSheet.getRange("A1:A4");
  range.merge();
}

moveTo(destinationRange)

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

moveTo(destinationRange: Range | string): void;

Параметры

destinationRange

ExcelScript.Range | string

destinationRange Указывает диапазон, в который будут перемещены сведения в этом диапазоне.

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

void

removeDuplicates(columns, includesHeader)

Удаляет повторяющиеся значения из диапазона, заданного столбцами.

removeDuplicates(
            columns: number[],
            includesHeader: boolean
        ): RemoveDuplicatesResult;

Параметры

columns

number[]

Столбцы внутри диапазона, которые могут содержать дубликаты. Необходимо указать по крайней мере один столбец. Используется нулевой индекс.

includesHeader

boolean

Значение true, если входные данные содержат заголовок. Значение по умолчанию: false.

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

ExcelScript.RemoveDuplicatesResult

Примеры

/**
 * This script removes duplicate rows from a range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range of the active worksheet.
  const usedRange = workbook.getActiveWorksheet().getUsedRange();

  // Remove any row that has a same value in the 0-indexed column as a previous row.
  const removedResults = usedRange.removeDuplicates([0], true);

  // Log the count of removed rows.
  console.log(`Rows removed: ${removedResults.getRemoved()}.`);
}

replaceAll(text, replacement, criteria)

Находит и заменяет определенную строку на основе условий, указанных в текущем диапазоне.

replaceAll(
            text: string,
            replacement: string,
            criteria: ReplaceCriteria
        ): number;

Параметры

text

string

Строка для поиска.

replacement

string

Строка, которая заменяет исходную строку.

criteria

ExcelScript.ReplaceCriteria

Дополнительные условия замены.

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

number

Примеры

/**
 * This script searches through a table column and replaces  
 * cells marked "monthly special" with "parsnip".
 * This script uses Range.replaceAll instead of Worksheet.replaceAll
 * to limit the search to a specific range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range of a table named "Orders".
  let table = workbook.getTable("Orders");
  let range = table.getColumnByName("Vegetable").getRange();
  
  // Change the value of any cells with the value "monthly special".
  range.replaceAll("monthly special", "parsnip", {completeMatch: true});
}

select()

Выбирает указанный диапазон в пользовательском интерфейсе Excel.

select(): void;

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

void

Примеры

/**
 * This script selects the first row of a table.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table on the current worksheet.
  const sheet = workbook.getActiveWorksheet()
  const table = sheet.getTables()[0];

  // Get the first data row in the table.
  const row = table.getRangeBetweenHeaderAndTotal().getRow(0);

  // Select the first data row.
  row.select();
}

setColumnHidden(columnHidden)

Представляет, если все столбцы в текущем диапазоне скрыты. Значение — это true , когда все столбцы в диапазоне скрыты. Значение имеет значение, false если столбцы в диапазоне не скрыты. Значением считается, null когда некоторые столбцы в диапазоне скрыты, а другие столбцы в том же диапазоне не скрыты.

setColumnHidden(columnHidden: boolean): void;

Параметры

columnHidden

boolean

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

void

setDirty()

Устанавливает диапазон, предназначенный для пересчета при выполнении следующего пересчета.

setDirty(): void;

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

void

setFormula(formula)

Задает формулу ячейки в нотации в стиле A1. Если диапазон содержит несколько ячеек, каждая ячейка в заданном диапазоне будет обновлена с помощью входных данных.

setFormula(formula: string): void;

Параметры

formula

string

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

void

Примеры

/*
 * This script sets a cell's formula, 
 * then displays how Excel stores the cell's formula and value separately.
 */
function main(workbook: ExcelScript.Workbook) {
  let selectedSheet = workbook.getActiveWorksheet();

  // Set A1 to 2.
  let a1 = selectedSheet.getRange("A1");
  a1.setValue(2);

  // Set B1 to the formula =(2*A1), which should equal 4.
  let b1 = selectedSheet.getRange("B1")
  b1.setFormula("=(2*A1)");

  // Log the current results for `getFormula` and `getValue` at B1.
  console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
}

setFormulaLocal(formulaLocal)

Задайте формулу ячейки в нотации в стиле A1 на языке пользователя и языковом стандарте форматирования чисел. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если диапазон содержит несколько ячеек, каждая ячейка в заданном диапазоне будет обновлена с помощью входных данных.

setFormulaLocal(formulaLocal: string): void;

Параметры

formulaLocal

string

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

void

setFormulaR1C1(formulaR1C1)

Задает формулу ячейки в нотации в стиле R1C1. Если диапазон содержит несколько ячеек, каждая ячейка в заданном диапазоне будет обновлена с помощью входных данных.

setFormulaR1C1(formulaR1C1: string): void;

Параметры

formulaR1C1

string

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

void

setFormulas(formulas)

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

setFormulas(formulas: string[][]): void;

Параметры

formulas

string[][]

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

void

Примеры

/**
 * This script sets the values of a range, then adds SUM formulas to calculate
 * the totals for each row of that range. 
 */
function main(workbook: ExcelScript.Workbook)
{
  let currentSheet = workbook.getActiveWorksheet();

  // Set the values of a range.
  let values = [[1, 2, 4], [8, 16, 32], [64, 128, 256]];
  let valueRange = currentSheet.getRange("A1:C3");
  valueRange.setValues(values);

  // Set the formulas of a range.
  let formulas = [["=SUM(A1:C1)"], ["=SUM(A2:C2)"], ["=SUM(A3:C3)"]];
  let formulaRange = currentSheet.getRange("D1:D3");
  formulaRange.setFormulas(formulas);
}

setFormulasLocal(formulasLocal)

Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.

setFormulasLocal(formulasLocal: string[][]): void;

Параметры

formulasLocal

string[][]

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

void

setFormulasR1C1(formulasR1C1)

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

setFormulasR1C1(formulasR1C1: string[][]): void;

Параметры

formulasR1C1

string[][]

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

void

setHyperlink(hyperlink)

Представляет гиперссылку для текущего диапазона.

setHyperlink(hyperlink: RangeHyperlink): void;

Параметры

hyperlink

ExcelScript.RangeHyperlink

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

void

Примеры

/** 
 * This script inserts a hyperlink to the first cell of the last worksheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  let cell = workbook.getActiveCell();

  // Get the last worksheet in the workbook.
  // Note that this might be the current sheet if there's only one worksheet.
  let lastSheet = workbook.getLastWorksheet();

  // Get sheet name. 
  let linkedSheetName = lastSheet.getName();
  console.log(`Setting hyperlink of ${cell.getAddress()} to the ${linkedSheetName} sheet's A1 cell`);

  // Set the text for the hyperlink.
  let value = `Click to go to: ${linkedSheetName}`;

  // Create the hyperlink using that cell's value.
  cell.setHyperlink({
    textToDisplay: value.toString(),
    screenTip: `Navigate to ${linkedSheetName}`,
    documentReference: `${linkedSheetName}!A1`
  });
}

setNumberFormat(numberFormat)

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

setNumberFormat(numberFormat: string): void;

Параметры

numberFormat

string

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

void

Примеры

/**
 * This script sets the number format in column C to show the data as a percentage.
 */
function main(workbook: ExcelScript.Workbook) {
  const  selectedSheet = workbook.getActiveWorksheet();
  
  // Set number format for column C to a percentage that rounds to the nearest percentage point.
  selectedSheet.getRange("C:C").setNumberFormat("0%");
}

setNumberFormatLocal(numberFormatLocal)

Задает код формата чисел excel ячейки для заданного диапазона на основе языковых параметров пользователя. Excel не выполняет приведение языка или формата при получении или задании numberFormatLocal свойства. Любой возвращаемый текст использует строки в локальном формате на основе языка, указанного в параметрах системы. Если диапазон содержит несколько ячеек, каждая ячейка в заданном диапазоне будет обновлена с помощью входных данных.

setNumberFormatLocal(numberFormatLocal: string): void;

Параметры

numberFormatLocal

string

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

void

Примеры

/**
 * This script sets the number format in column D to show the data as a percentage with a decimal.
 */
function main(workbook: ExcelScript.Workbook) {
  const  selectedSheet = workbook.getActiveWorksheet();
  
  // Set number format for column D to a percentage that rounds to the nearest tenth of a percentage.
  selectedSheet.getRange("D:D").setNumberFormatLocal("0.0%");
}

setNumberFormats(numberFormats)

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

setNumberFormats(numberFormats: string[][]): void;

Параметры

numberFormats

string[][]

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

void

setNumberFormatsLocal(numberFormatsLocal)

Представляет код числового формата Excel для заданного диапазона на основе языковых параметров пользователя. Excel не выполняет приведение языка или формата при получении или задании numberFormatLocal свойства. Любой возвращаемый текст использует строки в локальном формате на основе языка, указанного в параметрах системы.

setNumberFormatsLocal(numberFormatsLocal: string[][]): void;

Параметры

numberFormatsLocal

string[][]

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

void

setPredefinedCellStyle(predefinedCellStyle)

Представляет стиль текущего диапазона.

setPredefinedCellStyle(predefinedCellStyle: string): void;

Параметры

predefinedCellStyle

string

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

void

setRowHidden(rowHidden)

Представляет, скрыты ли все строки в текущем диапазоне. Значение — это true , когда все строки в диапазоне скрыты. Значение — это значение false , когда строки в диапазоне не скрыты. Значением является, null когда некоторые строки в диапазоне скрыты, а другие строки в том же диапазоне не скрыты.

setRowHidden(rowHidden: boolean): void;

Параметры

rowHidden

boolean

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

void

setValue(value)

Задает необработанное значение указанного диапазона. Заданные данные могут быть типа string, number или boolean. null значение будет игнорироваться (не задано или перезаписывается в Excel). Если диапазон содержит несколько ячеек, каждая ячейка в заданном диапазоне будет обновлена с помощью входных данных.

setValue(value: any): void;

Параметры

value

any

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

void

setValues(values)

Задает необработанные значения указанного диапазона. Предоставленные данные могут быть строковыми, числовыми или логическими. Если указанное значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.

setValues(values: (string | number | boolean)[][]): void;

Параметры

values

(string | number | boolean)[][]

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

void

Примеры

/**
 * This sample inserts some pre-loaded data into a range.
 * It also shows how to get a range that fits the data.
 */
 function main(workbook: ExcelScript.Workbook) {
   // Get the active cell.
   let currentCell = workbook.getActiveCell();
   
   // Calculate the range needed to fit the given data.
   let targetRange = currentCell.getResizedRange(DATA.length - 1, DATA[0].length - 1);

   // Set range values to the data.
   targetRange.setValues(DATA);

   // Autofit the columns so the worksheet is readable. 
   targetRange.getFormat().autofitColumns();
 }

 /* 
  * This sample's data is in a static 2-dimensional array.
  * You could also get the input from other ranges or sources.
  * Note that each row must have the same number of columns to be valid. 
  */
 const DATA = [
   ['Date', 'Salesperson', 'Product', 'Amount']
   , ['3/2/2020', 'Anne', 'Pizza', '$1400']
   , ['3/2/2020', 'Mariya', 'Pizza', '$1700']
   , ['3/7/2020', 'Mark', 'Sandwiches', '$1010']
   , ['3/24/2020', 'Anne', 'Pizza', '$750']
   , ['3/28/2020', 'Mark', 'Salads', '$510']
   , ['4/17/2020', 'Laura', 'Salads', '$900']
   , ['4/17/2020', 'Mariya', 'Salads', '$1600']
   , ['4/28/2020', 'Laura', 'Sandwiches', '$680']
 ];

showCard()

Отображает карточку для активной ячейки, если она имеет содержимое c форматированным значением.

showCard(): void;

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

void

showGroupDetails(groupOption)

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

showGroupDetails(groupOption: GroupOption): void;

Параметры

groupOption

ExcelScript.GroupOption

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

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

void

ungroup(groupOption)

Разгруппирует столбцы и строки для структуры.

ungroup(groupOption: GroupOption): void;

Параметры

groupOption

ExcelScript.GroupOption

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

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

void

unmerge()

Разъединяет ячейки диапазона на отдельные ячейки.

unmerge(): void;

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

void

Примеры

/**
 * This script unmerges every used cell in the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active worksheet.
  const selectedSheet = workbook.getActiveWorksheet();

  // Separate all regions into single cells in the currently used range.
  const range = selectedSheet.getUsedRange();
  range.unmerge();
}