ExcelScript.RangeAreas interface

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

Методы

addConditionalFormat(type)

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

calculate()

Вычисляет все ячейки в объекте RangeAreas.

clear(applyTo)

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

clearAllConditionalFormats()

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

convertDataTypeToText()

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

copyFrom(sourceRange, copyType, skipBlanks, transpose)

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

getAddress()

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

getAddressLocal()

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

getAreaCount()

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

getAreas()

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

getCellCount()

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

getConditionalFormat(id)

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

getConditionalFormats()

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

getDataValidation()

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

getEntireColumn()

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

getEntireRow()

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

getFormat()

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

getIntersection(anotherRange)

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

getIsEntireColumn()

Указывает, являются ли все диапазоны этого объекта RangeAreas целыми столбцами (например, "А:К, К:З").

getIsEntireRow()

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

getOffsetRangeAreas(rowOffset, columnOffset)

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

getPredefinedCellStyle()

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

getSpecialCells(cellType, cellValueType)

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

getTables(fullyContained)

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

getUsedRangeAreas(valuesOnly)

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

getWorksheet()

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

setDirty()

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

setPredefinedCellStyle(predefinedCellStyle)

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

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

addConditionalFormat(type)

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

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Параметры

type
ConditionalFormatType

Тип добавляемого условного форматирования. Дополнительные сведения см. в статье Excel. Кондитионалформаттипе.

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

calculate()

Вычисляет все ячейки в объекте RangeAreas.

calculate(): void;

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

void

clear(applyTo)

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

clear(applyTo?: ClearApplyTo): void;

Параметры

applyTo
ClearApplyTo

Необязательный параметр. Определяет тип действия очистки. Дополнительные сведения см. в статье Excel. Клеарапплито. Значение по умолчанию — "ALL".

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

void

clearAllConditionalFormats()

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

clearAllConditionalFormats(): void;

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

void

convertDataTypeToText()

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

convertDataTypeToText(): void;

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

void

copyFrom(sourceRange, copyType, skipBlanks, transpose)

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

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

Параметры

sourceRange
Range | RangeAreas | string

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

copyType
RangeCopyType

Тип данных или форматирования ячеек, которые необходимо скопировать. Значение по умолчанию — "ALL".

skipBlanks
boolean

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

transpose
boolean

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

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

void

getAddress()

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

getAddress(): string;

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

string

getAddressLocal()

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

getAddressLocal(): string;

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

string

getAreaCount()

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

getAreaCount(): number;

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

number

getAreas()

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

getAreas(): Range[];

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

Range[]

getCellCount()

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

getCellCount(): number;

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

number

getConditionalFormat(id)

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

getConditionalFormat(id: string): ConditionalFormat;

Параметры

id
string

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

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

getConditionalFormats()

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

getConditionalFormats(): ConditionalFormat[];

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

getDataValidation()

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

getDataValidation(): DataValidation;

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

getEntireColumn()

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

getEntireColumn(): RangeAreas;

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

getEntireRow()

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

getEntireRow(): RangeAreas;

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

getFormat()

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

getFormat(): RangeFormat;

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

getIntersection(anotherRange)

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

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

Параметры

anotherRange
Range | RangeAreas | string

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

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

getIsEntireColumn()

Указывает, являются ли все диапазоны этого объекта RangeAreas целыми столбцами (например, "А:К, К:З").

getIsEntireColumn(): boolean;

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

boolean

getIsEntireRow()

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

getIsEntireRow(): boolean;

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

boolean

getOffsetRangeAreas(rowOffset, columnOffset)

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

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

Параметры

rowOffset
number

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

columnOffset
number

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

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

getPredefinedCellStyle()

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

getPredefinedCellStyle(): string;

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

string

getSpecialCells(cellType, cellValueType)

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

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

Параметры

cellType
SpecialCellType

Тип ячеек, которые необходимо включить в список.

cellValueType
SpecialCellValueType

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

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

getTables(fullyContained)

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

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

Параметры

fullyContained
boolean

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

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

Table[]

getUsedRangeAreas(valuesOnly)

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

getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;

Параметры

valuesOnly
boolean

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

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

getWorksheet()

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

getWorksheet(): Worksheet;

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

setDirty()

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

setDirty(): void;

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

void

setPredefinedCellStyle(predefinedCellStyle)

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

setPredefinedCellStyle(predefinedCellStyle: string): void;

Параметры

predefinedCellStyle
string

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

void