Excel.RangeAreas interface

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

Свойства

address

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

addressLocal

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

areaCount

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

areas

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

cellCount

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

conditionalFormats

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

dataValidation

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

format

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

isEntireColumn

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

isEntireRow

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

style

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

worksheet

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

Методы

calculate()

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

clear(applyTo)

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

convertDataTypeToText()

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

convertToLinkedDataType(serviceID, languageCulture)

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

copyFrom(sourceRange, copyType, skipBlanks, transpose)

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

getEntireColumn()

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

getEntireRow()

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

getIntersection(anotherRange)

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

getIntersectionOrNullObject(anotherRange)

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

getOffsetRangeAreas(rowOffset, columnOffset)

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

getSpecialCells(cellType, cellValueType)

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

getSpecialCellsOrNullObject(cellType, cellValueType)

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

getTables(fullyContained)

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

getUsedRangeAreas(valuesOnly)

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

getUsedRangeAreasOrNullObject(valuesOnly)

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

load(propertyNames)

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

setDirty()

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

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

address

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

readonly address: string;

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

string

addressLocal

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

readonly addressLocal: string;

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

string

areaCount

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

readonly areaCount: number;

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

number

areas

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

readonly areas: RangeCollection;

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

cellCount

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

readonly cellCount: number;

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

number

conditionalFormats

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

readonly conditionalFormats: ConditionalFormatCollection;

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

dataValidation

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

readonly dataValidation: DataValidation;

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

format

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

readonly format: RangeFormat;

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

Примеры

async function main(context: Excel.RequestContext) {

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

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

    await context.sync();
}

isEntireColumn

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

readonly isEntireColumn: boolean;

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

boolean

isEntireRow

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

readonly isEntireRow: boolean;

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

boolean

style

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

style: string;

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

string

worksheet

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

readonly worksheet: Worksheet;

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

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

calculate()

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

calculate(): void;

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

void

clear(applyTo)

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

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

Параметры

applyTo
| ClearApplyTo | "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"

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

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

void

convertDataTypeToText()

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

convertDataTypeToText(): void;

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

void

convertToLinkedDataType(serviceID, languageCulture)

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

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

Параметры

serviceID
number

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

languageCulture
string

Язык и региональные параметры для запроса службы.

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

void

copyFrom(sourceRange, copyType, skipBlanks, transpose)

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

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

Параметры

sourceRange
Range | RangeAreas | string

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

copyType
| RangeCopyType | "All" | "Formulas" | "Values" | "Formats"

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

skipBlanks
boolean

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

transpose
boolean

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

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

void

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;

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

getIntersection(anotherRange)

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

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

Параметры

anotherRange
Range | RangeAreas | string

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

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

getIntersectionOrNullObject(anotherRange)

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

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

Параметры

anotherRange
Range | RangeAreas | string

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

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

getOffsetRangeAreas(rowOffset, columnOffset)

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

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

Параметры

rowOffset
number

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

columnOffset
number

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

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

getSpecialCells(cellType, cellValueType)

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

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

Параметры

cellType
| SpecialCellType | "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

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

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

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

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

getSpecialCellsOrNullObject(cellType, cellValueType)

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

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

Параметры

cellType
| SpecialCellType | "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

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

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

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

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

getTables(fullyContained)

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

getTables(fullyContained?: boolean): TableScopedCollection;

Параметры

fullyContained
boolean

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

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

getUsedRangeAreas(valuesOnly)

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

getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;

Параметры

valuesOnly
boolean

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

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

getUsedRangeAreasOrNullObject(valuesOnly)

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

getUsedRangeAreasOrNullObject(valuesOnly?: boolean): RangeAreas;

Параметры

valuesOnly
boolean

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

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

load(propertyNames)

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

load(propertyNames?: string | string[]): void;

Параметры

propertyNames
string | string[]

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

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

void

setDirty()

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

setDirty(): void;

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

void