Excel.RangeAreas class

Пакет:

excel

RangeAreas Представляет набор из одного или нескольких прямоугольных диапазонов на одном листе. Чтобы узнать, как использовать несмежные диапазоны, ознакомьтесь со статьей "Работа с несколькими диапазонами одновременно в надстройках Excel".

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi 1.9

Используется

• Excel.Application: union
• Excel.ConditionalFormat: getRanges, setRanges
• Excel.DataValidation: getInvalidCells, getInvalidCellsOrNullObject
• Excel.PageLayout: getPrintArea, getPrintAreaOrNullObject, setPrintArea
• Excel.Range: copyFrom, getMergedAreasOrNullObject, getSpecialCells, getSpecialCellsOrNullObject
• Excel.RangeAreasCollection: getItemAt, items
• Excel.Window: rangeSelection
• Excel.Workbook: getSelectedRanges
• Excel.WorkbookRangeAreas: getRangeAreasBySheet, getRangeAreasOrNullObjectBySheet
• Рабочий лист Excel:findAll, findAllOrNullObject, getRanges

Свойства

address	Возвращает RangeAreas ссылку в стиле А1. Address value будет содержать имя листа для каждого прямоугольного блока ячеек (например, "Лист1! A1:B4, Лист1! D1:D4").
addressLocal	Возвращает RangeAreas ссылку в языковом стандарте пользователя.
areaCount	Возвращает число прямоугольных диапазонов, составляющих этот RangeAreas объект.
areas	Возвращает коллекцию прямоугольных диапазонов, составляющих этот RangeAreas объект.
cellCount	Возвращает количество ячеек в RangeAreas объекте, суммируя количество ячеек во всех отдельных прямоугольных диапазонах. Возвращает значение -1, если количество ячеек превышает 2^31-1 (2 147 483 647).
conditionalFormats	Возвращает коллекцию условных форматов, которые пересекаются с любыми ячейками в этом RangeAreas объекте.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
dataValidation	Возвращает объект проверки данных для всех диапазонов в .RangeAreas
format	Возвращает RangeFormat объект, инкапсулируя шрифт, заливку, границы, выравнивание и другие свойства для всех диапазонов в объекте RangeAreas .
isEntireColumn	Указывает, что все диапазоны этого RangeAreas объекта представляют собой целые столбцы (например, "A:C, Q:Z").
isEntireRow	Указывает, что все диапазоны этого RangeAreas объекта представляют собой целые строки (например, "1:3, 5:7").
style	Представляет стиль для всех диапазонов в этом RangeAreas объекте. Если стили ячеек не согласованы, null будет возвращен. Для пользовательских стилей возвращается имя стиля. Для встроенных стилей будет возвращена строка, представляющая значение в перечислении BuiltInStyle .
worksheet	Возвращает лист для текущего RangeAreasфайла .

Методы

calculate()	Вычисляет все ячейки в формате RangeAreas.
clear(applyTo)	Очищает значения, формат, заливку, границу и другие свойства в каждой из областей, составляющих этот RangeAreas объект.
clear(applyTo)	Очищает значения, формат, заливку, границу и другие свойства в каждой из областей, составляющих этот RangeAreas объект.
clearOrResetContents()	Очищает значения ячеек в диапазонах, при этом особое внимание уделяется ячейкам, содержащим элементы управления. Если диапазоны содержат только пустые значения и элементы управления с установленными значениями по умолчанию, то значения и форматирование элементов управления удаляются. В противном случае эта политика устанавливает значения по умолчанию для ячеек с элементами управления и удаляет значения в других ячейках в диапазонах.
convertDataTypeToText()	Преобразует все ячейки в типах RangeAreas данных "В" в текст.
convertToLinkedDataType(serviceID, languageCulture)	Преобразует все ячейки в связанных типах RangeAreas данных.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Копирует данные или форматирование ячеек из исходного диапазона или RangeAreas в текущий RangeAreasдиапазон. Целевой объект RangeAreas может иметь размер, отличный от исходного диапазона или RangeAreas Назначение расширяется автоматически, если оно меньше источника.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Копирует данные или форматирование ячеек из исходного диапазона или RangeAreas в текущий RangeAreasдиапазон. Целевой объект RangeAreas может иметь размер, отличный от исходного диапазона или RangeAreas Назначение расширяется автоматически, если оно меньше источника.
getEntireColumn()	Возвращает RangeAreas объект, представляющий целые столбцы ячейки RangeAreas (например, если ток RangeAreas представляет ячейки "B4:E11, H2", он возвращает ячейку RangeAreas , представляющую столбцы "B:E, Ч:Ч").
getEntireRow()	Возвращает RangeAreas объект, представляющий целые строки ячейки RangeAreas (например, если ток RangeAreas представляет ячейки "B4:E11", он возвращает ячейку RangeAreas , представляющую строки "4:11").
getIntersection(anotherRange)	Возвращает RangeAreas объект, представляющий пересечение заданных диапазонов или RangeAreas. Если пересечение не найдено, будет выдана ItemNotFound ошибка.
getIntersectionOrNullObject(anotherRange)	Возвращает RangeAreas объект, представляющий пересечение заданных диапазонов или RangeAreas. Если пересечение не найдено, этот метод возвращает объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getOffsetRangeAreas(rowOffset, columnOffset)	Возвращает объект, смещенный RangeAreas на определенное смещение строки и столбца. Размерность возвращаемого RangeAreas объекта будет соответствовать исходному объекту. Если результирующий RangeAreas результат принудительно выйти за пределы сетки листа, будет выброшена ошибка.
getSpecialCells(cellType, cellValueType)	Возвращает объект, RangeAreas представляющий все ячейки, соответствующие указанному типу и значению. Выдает ошибку, если не найдено специальных ячеек, соответствующих условиям.
getSpecialCells(cellType, cellValueType)	Возвращает объект, RangeAreas представляющий все ячейки, соответствующие указанному типу и значению. Выдает ошибку, если не найдено специальных ячеек, соответствующих условиям.
getSpecialCellsOrNullObject(cellType, cellValueType)	Возвращает объект, RangeAreas представляющий все ячейки, соответствующие указанному типу и значению. Если специальные ячейки, соответствующие условию, не найдены, возвращается объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getSpecialCellsOrNullObject(cellType, cellValueType)	Возвращает объект, RangeAreas представляющий все ячейки, соответствующие указанному типу и значению. Если специальные ячейки, соответствующие условию, не найдены, возвращается объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getTables(fullyContained)	Возвращает коллекцию таблиц, которые перекрываются с любым диапазоном в этом RangeAreas объекте.
getUsedRangeAreas(valuesOnly)	Возвращает использованные RangeAreas значения, включающие все области отдельных прямоугольных диапазонов в объекте RangeAreas . Если в ячейке RangeAreasне будет использованных ячеек, будет выведена ItemNotFound ошибка.
getUsedRangeAreasOrNullObject(valuesOnly)	Возвращает использованные RangeAreas значения, включающие все области отдельных прямоугольных диапазонов в объекте RangeAreas . Если внутри RangeAreasкнопки не используются ячейки, этот метод возвращает объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
select()	Выделение указанных областей диапазона в пользовательском интерфейсе Excel.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
setDirty()	Пересчитывается при RangeAreas следующем пересчете.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.RangeAreas объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.RangeAreasData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

Сведения о свойстве

address

Возвращает RangeAreas ссылку в стиле А1. Address value будет содержать имя листа для каждого прямоугольного блока ячеек (например, "Лист1! A1:B4, Лист1! D1:D4").

readonly address: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.9

addressLocal

Возвращает RangeAreas ссылку в языковом стандарте пользователя.

readonly addressLocal: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.9

areaCount

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

readonly areaCount: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.9

areas

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

readonly areas: Excel.RangeCollection;

Значение свойства

Excel.RangeCollection

Комментарии

Набор API: ExcelApi 1.9

cellCount

Возвращает количество ячеек в RangeAreas объекте, суммируя количество ячеек во всех отдельных прямоугольных диапазонах. Возвращает значение -1, если количество ячеек превышает 2^31-1 (2 147 483 647).

readonly cellCount: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.9

conditionalFormats

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

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Значение свойства

Excel.ConditionalFormatCollection

Комментарии

Набор API: ExcelApi 1.9

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

dataValidation

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

readonly dataValidation: Excel.DataValidation;

Значение свойства

Excel.DataValidation

Комментарии

Набор API: ExcelApi 1.9

format

Возвращает RangeFormat объект, инкапсулируя шрифт, заливку, границы, выравнивание и другие свойства для всех диапазонов в объекте RangeAreas .

readonly format: Excel.RangeFormat;

Значение свойства

Excel.RangeFormat

Комментарии

Набор API: ExcelApi 1.9

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml

await Excel.run(async (context) => {

    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const usedRange = sheet.getUsedRange();

    // Find the ranges with formulas.
    const formulaRanges = usedRange.getSpecialCells("Formulas");
    formulaRanges.format.fill.color = "lightgreen";

    await context.sync();
});

isEntireColumn

Указывает, что все диапазоны этого RangeAreas объекта представляют собой целые столбцы (например, "A:C, Q:Z").

readonly isEntireColumn: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.9

isEntireRow

Указывает, что все диапазоны этого RangeAreas объекта представляют собой целые строки (например, "1:3, 5:7").

readonly isEntireRow: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.9

style

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

style: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.9

worksheet

Возвращает лист для текущего RangeAreasфайла .

readonly worksheet: Excel.Worksheet;

Значение свойства

Excel.Worksheet

Комментарии

Набор API: ExcelApi 1.9

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

calculate()

Вычисляет все ячейки в формате RangeAreas.

calculate(): void;

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

void

Комментарии

Набор API: ExcelApi 1.9

clear(applyTo)

Очищает значения, формат, заливку, границу и другие свойства в каждой из областей, составляющих этот RangeAreas объект.

clear(applyTo?: Excel.ClearApplyTo): void;

Параметры

applyTo

Excel.ClearApplyTo

Необязательный параметр. Определяет тип действия очистки. См. Excel.ClearApplyTo дополнительные сведения. По умолчанию используется значение "All".

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

void

Комментарии

Набор API: ExcelApi 1.9

clear(applyTo)

Очищает значения, формат, заливку, границу и другие свойства в каждой из областей, составляющих этот RangeAreas объект.

clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;

Параметры

applyTo

"All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"

Необязательный параметр. Определяет тип действия очистки. См. Excel.ClearApplyTo дополнительные сведения. По умолчанию используется значение "All".

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

void

Комментарии

Набор API: ExcelApi 1.9

clearOrResetContents()

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

clearOrResetContents(): void;

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

void

Комментарии

Набор API: ExcelApi 1.18

convertDataTypeToText()

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

convertDataTypeToText(): void;

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

void

Комментарии

Набор API: ExcelApi 1.9

convertToLinkedDataType(serviceID, languageCulture)

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

convertToLinkedDataType(serviceID: number, languageCulture: string): void;

Параметры

serviceID

number

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

languageCulture

string

Языковая культура, о которой нужно узнать в службе.

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

void

Комментарии

Набор API: ExcelApi 1.9

copyFrom(sourceRange, copyType, skipBlanks, transpose)

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

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

Параметры

sourceRange

Excel.Range | Excel.RangeAreas | string

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

copyType

Excel.RangeCopyType

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

skipBlanks

boolean

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

transpose

boolean

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

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

void

Комментарии

Набор API: ExcelApi 1.9

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-auto-fill.yaml

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const sumRange = sheet.getRange("F4");
  sumRange.formulas = [["=SUM(B4:E4)"]];
  sumRange.format.fill.color = "LightBlue";
  sumRange.format.font.bold = true;
  sheet.getRanges("K4,P4").copyFrom("F4", Excel.RangeCopyType.all);
  sheet.getRanges("F4,K4,P4").format.autofitColumns();
  await context.sync();
});

copyFrom(sourceRange, copyType, skipBlanks, transpose)

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

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths", skipBlanks?: boolean, transpose?: boolean): void;

Параметры

sourceRange

Excel.Range | Excel.RangeAreas | string

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

copyType

"All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths"

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

skipBlanks

boolean

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

transpose

boolean

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

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

void

Комментарии

Набор API: ExcelApi 1.9

getEntireColumn()

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

getEntireColumn(): Excel.RangeAreas;

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

Excel.RangeAreas

Комментарии

Набор API: ExcelApi 1.9

getEntireRow()

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

getEntireRow(): Excel.RangeAreas;

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

Excel.RangeAreas

Комментарии

Набор API: ExcelApi 1.9

getIntersection(anotherRange)

Возвращает RangeAreas объект, представляющий пересечение заданных диапазонов или RangeAreas. Если пересечение не найдено, будет выдана ItemNotFound ошибка.

getIntersection(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;

Параметры

anotherRange

Excel.Range | Excel.RangeAreas | string

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

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

Excel.RangeAreas

Комментарии

Набор API: ExcelApi 1.9

getIntersectionOrNullObject(anotherRange)

Возвращает RangeAreas объект, представляющий пересечение заданных диапазонов или RangeAreas. Если пересечение не найдено, этот метод возвращает объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getIntersectionOrNullObject(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;

Параметры

anotherRange

Excel.Range | Excel.RangeAreas | string

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

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

Excel.RangeAreas

Комментарии

Набор API: ExcelApi 1.9

getOffsetRangeAreas(rowOffset, columnOffset)

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

getOffsetRangeAreas(rowOffset: number, columnOffset: number): Excel.RangeAreas;

Параметры

rowOffset

number

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

columnOffset

number

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

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

Excel.RangeAreas

Комментарии

Набор API: ExcelApi 1.9

getSpecialCells(cellType, cellValueType)

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

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

Параметры

cellType

Excel.SpecialCellType

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

cellValueType

Excel.SpecialCellValueType

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

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

Excel.RangeAreas

Комментарии

Набор API: ExcelApi 1.9

getSpecialCells(cellType, cellValueType)

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

getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible" | "DirtyFormulas", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Параметры

cellType

"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible" | "DirtyFormulas"

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

cellValueType

"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

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

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

Excel.RangeAreas

Комментарии

Набор API: ExcelApi 1.9

getSpecialCellsOrNullObject(cellType, cellValueType)

Возвращает объект, RangeAreas представляющий все ячейки, соответствующие указанному типу и значению. Если специальные ячейки, соответствующие условию, не найдены, возвращается объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Параметры

cellType

Excel.SpecialCellType

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

cellValueType

Excel.SpecialCellValueType

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

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

Excel.RangeAreas

Комментарии

Набор API: ExcelApi 1.9

getSpecialCellsOrNullObject(cellType, cellValueType)

Возвращает объект, RangeAreas представляющий все ячейки, соответствующие указанному типу и значению. Если специальные ячейки, соответствующие условию, не найдены, возвращается объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible" | "DirtyFormulas", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Параметры

cellType

"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible" | "DirtyFormulas"

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

cellValueType

"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

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

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

Excel.RangeAreas

Комментарии

Набор API: ExcelApi 1.9

getTables(fullyContained)

Возвращает коллекцию таблиц, которые перекрываются с любым диапазоном в этом RangeAreas объекте.

getTables(fullyContained?: boolean): Excel.TableScopedCollection;

Параметры

fullyContained

boolean

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

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

Excel.TableScopedCollection

Комментарии

Набор API: ExcelApi 1.9

getUsedRangeAreas(valuesOnly)

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

getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;

Параметры

valuesOnly

boolean

Следует ли считать используемыми только ячейки со значениями. Значение по умолчанию — false.

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

Excel.RangeAreas

Комментарии

Набор API: ExcelApi 1.9

getUsedRangeAreasOrNullObject(valuesOnly)

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

getUsedRangeAreasOrNullObject(valuesOnly?: boolean): Excel.RangeAreas;

Параметры

valuesOnly

boolean

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

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

Excel.RangeAreas

Комментарии

Набор API: ExcelApi 1.9

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.RangeAreasLoadOptions): Excel.RangeAreas;

Параметры

options

Excel.Interfaces.RangeAreasLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

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

Excel.RangeAreas

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.RangeAreas;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

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

Excel.RangeAreas

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.RangeAreas;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

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

Excel.RangeAreas

select()

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

select(): void;

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

void

Комментарии

Набор API: ExcelApi 1.18

set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

set(properties: Interfaces.RangeAreasUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties

Excel.Interfaces.RangeAreasUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Excel.RangeAreas): void;

Параметры

properties

Excel.RangeAreas

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

void

setDirty()

Пересчитывается при RangeAreas следующем пересчете.

setDirty(): void;

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

void

Комментарии

Набор API: ExcelApi 1.9

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.RangeAreas объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.RangeAreasData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Excel.Interfaces.RangeAreasData;

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

Excel.Interfaces.RangeAreasData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании.

track(): Excel.RangeAreas;

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

Excel.RangeAreas

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

untrack(): Excel.RangeAreas;

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

Excel.RangeAreas