ExcelScript.RangeAreas interface

Ссылка

Пакет:: ExcelScript

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

/**
 * This script clears all the cells in the current worksheet that are displaying errors.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range on the current sheet.
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Get the RangeAreas object for each cell with a formula error.
  const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);

  // If there are any error cells, clear them.
  if (errorCells) {
    errorCells.clear();
  }
}

Методы

addConditionalFormat(type)	Добавляет новый условный формат в коллекцию с первым или верхним приоритетом.
calculate()	Вычисляет все ячейки `RangeAreas`в .
clear(applyTo)	Очищает значения, формат, заливку, границу и другие свойства в каждой из областей, составляющих этот `RangeAreas` объект.
clearAllConditionalFormats()	Полное удаление условного форматирование в указанном диапазоне.
convertDataTypeToText()	Преобразует все ячейки в `RangeAreas` с типами данных в текст.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Копирует данные ячейки или форматирование из исходного диапазона или `RangeAreas` в текущий `RangeAreas`. Размер назначения `RangeAreas` может отличаться от исходного диапазона или `RangeAreas`. Назначение будет развернуто автоматически, если оно меньше исходного.
getAddress()	Возвращает ссылку `RangeAreas` в стиле A1. Значение адреса будет содержать имя листа для каждого прямоугольного блока ячеек (например, "Лист1! A1:B4, Лист1! D1:D4").
getAddressLocal()	Возвращает ссылку `RangeAreas` в языковом стандарте пользователя.
getAreaCount()	Возвращает количество прямоугольных диапазонов, составляющих этот `RangeAreas` объект.
getAreas()	Возвращает коллекцию прямоугольных диапазонов, составляющих этот `RangeAreas` объект.
getCellCount()	Возвращает количество ячеек в объекте `RangeAreas` , суммируя количество ячеек всех отдельных прямоугольных диапазонов. Возвращает значение -1, если количество ячеек превышает 2^31-1 (2 147 483 647).
getConditionalFormat(id)	Возвращает условный формат, определяемый идентификатором. Если объект условного формата не существует, этот метод возвращает `undefined`.
getConditionalFormats()	Возвращает коллекцию условных форматов, пересекающихся с любыми ячейками в этом `RangeAreas` объекте.
getDataValidation()	Возвращает объект проверки данных для всех диапазонов в `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`. Если пересечение не найдено, этот метод возвращает `undefined`.
getIsEntireColumn()	Указывает, представляют ли все диапазоны этого `RangeAreas` объекта целые столбцы (например, "A:C, Q:Z").
getIsEntireRow()	Указывает, представляют ли все диапазоны этого `RangeAreas` объекта целые строки (например, "1:3, 5:7").
getOffsetRangeAreas(rowOffset, columnOffset)	`RangeAreas` Возвращает объект, смещенный на определенное смещение строк и столбцов. Измерение возвращаемого `RangeAreas` объекта будет соответствовать исходному объекту. Если результирующий объект `RangeAreas` принудительно выходит за пределы сетки листа, будет выдана ошибка.
getPredefinedCellStyle()	Представляет стиль для всех диапазонов в этом `RangeAreas` объекте. Если стили ячеек несогласованны, `null` возвращается. Для пользовательских стилей будет возвращено имя стиля. Для встроенных стилей возвращается строка, представляющая значение в перечислении `BuiltInStyle` .
getSpecialCells(cellType, cellValueType)	`RangeAreas` Возвращает объект , представляющий все ячейки, соответствующие указанному типу и значению. Если не найдены специальные ячейки, соответствующие условиям, этот метод возвращает `undefined`.
getTables(fullyContained)	Возвращает коллекцию таблиц с заданной областью, перекрывающуюся с любым диапазоном в этом `RangeAreas` объекте.
getUsedRangeAreas(valuesOnly)	Возвращает объект `RangeAreas` , который содержит все используемые области отдельных прямоугольных диапазонов в объекте `RangeAreas` . Если в `RangeAreas`объекте нет используемых ячеек, этот метод возвращает `undefined`.
getWorksheet()	Возвращает лист для текущего `RangeAreas`.
setDirty()	Задает объект для пересчета `RangeAreas` при следующем пересчете.
setPredefinedCellStyle(predefinedCellStyle)	Представляет стиль для всех диапазонов в этом `RangeAreas` объекте. Если стили ячеек несогласованны, `null` возвращается. Для пользовательских стилей будет возвращено имя стиля. Для встроенных стилей возвращается строка, представляющая значение в перечислении `BuiltInStyle` .

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

addConditionalFormat(type)

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

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Параметры

type: ExcelScript.ConditionalFormatType

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

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

ExcelScript.ConditionalFormat

calculate()

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

calculate(): void;

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

void

clear(applyTo)

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

clear(applyTo?: ClearApplyTo): void;

Параметры

applyTo: ExcelScript.ClearApplyTo

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

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

void

Примеры

/**
 * This script clears all the cells in the current worksheet that are displaying errors.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range on the current sheet.
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Get the RangeAreas object for each cell with a formula error.
  const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);

  // If there are any error cells, clear them.
  if (errorCells) {
    errorCells.clear();
  }
}

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: ExcelScript.Range | ExcelScript.RangeAreas | string

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

copyType: ExcelScript.RangeCopyType

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

skipBlanks: boolean

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

transpose: boolean

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

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

void

getAddress()

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

getAddress(): string;

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

string

getAddressLocal()

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

getAddressLocal(): string;

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

string

getAreaCount()

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

getAreaCount(): number;

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

number

getAreas()

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

getAreas(): Range[];

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

ExcelScript.Range[]

getCellCount()

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

getCellCount(): number;

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

number

getConditionalFormat(id)

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

getConditionalFormat(id: string): ConditionalFormat | undefined;

Параметры

id: string

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

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

ExcelScript.ConditionalFormat | undefined

getConditionalFormats()

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

getConditionalFormats(): ConditionalFormat[];

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

ExcelScript.ConditionalFormat[]

getDataValidation()

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

getDataValidation(): DataValidation;

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

ExcelScript.DataValidation

getEntireColumn()

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

getEntireColumn(): RangeAreas;

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

ExcelScript.RangeAreas

getEntireRow()

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

getEntireRow(): RangeAreas;

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

ExcelScript.RangeAreas

getFormat()

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

getFormat(): RangeFormat;

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

ExcelScript.RangeFormat

Примеры

/**
 * This script finds and highlights all the cells in the current worksheet that contain a formula.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range on the current sheet.
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Get the RangeAreas object for each cell with a formula.
  const formulaCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas);

  // Add a light blue background to the cells containing formulas.
  formulaCells.getFormat().getFill().setColor("#ADD8E6");
}

getIntersection(anotherRange)

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

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

Параметры

anotherRange: ExcelScript.Range | ExcelScript.RangeAreas | string

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

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

ExcelScript.RangeAreas

getIsEntireColumn()

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

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 . Положительные значения соответствуют смещению вправо, а отрицательные — влево.

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

ExcelScript.RangeAreas

getPredefinedCellStyle()

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

getPredefinedCellStyle(): string;

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

string

getSpecialCells(cellType, cellValueType)

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

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

Параметры

cellType: ExcelScript.SpecialCellType

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

cellValueType: ExcelScript.SpecialCellValueType

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

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

ExcelScript.RangeAreas

getTables(fullyContained)

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

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

Параметры

fullyContained: boolean

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

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

ExcelScript.Table[]

getUsedRangeAreas(valuesOnly)

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

getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;

Параметры

valuesOnly: boolean

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

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

ExcelScript.RangeAreas

getWorksheet()

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

getWorksheet(): Worksheet;

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

ExcelScript.Worksheet

setDirty()

Задает объект для пересчета RangeAreas при следующем пересчете.

setDirty(): void;

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

void

setPredefinedCellStyle(predefinedCellStyle)

setPredefinedCellStyle(predefinedCellStyle: string): void;

Параметры

predefinedCellStyle: string

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

void

Примеры

/**
 * This script sets the cell style to "warning text"
 * on every cell with a formula error.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the used range in the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const usedRange = sheet.getUsedRange();

  // Get any cells that are displaying errors.
  const errorCells = usedRange.getSpecialCells(
    ExcelScript.SpecialCellType.formulas,
    ExcelScript.SpecialCellValueType.errors
  );

  // Check if there are error cells before proceeding.
  if (errorCells) {
    // Use the built-in warning text style on the error cells.
    errorCells.setPredefinedCellStyle(
      ExcelScript.BuiltInStyle.warningText.toString()
    );
  } else {
    console.log("No formula errors in the worksheet.");
  }
}

Поделиться через

ExcelScript.RangeAreas interface

Комментарии

Примеры

Методы

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

addConditionalFormat(type)

Параметры

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

calculate()

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

clear(applyTo)

Параметры

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

Примеры

clearAllConditionalFormats()

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

convertDataTypeToText()

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

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Параметры

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

getAddress()

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

getAddressLocal()

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

getAreaCount()

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

getAreas()

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

getCellCount()

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

getConditionalFormat(id)

Параметры

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

getConditionalFormats()

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

getDataValidation()

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

getEntireColumn()

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

getEntireRow()

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

getFormat()

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

Примеры

getIntersection(anotherRange)

Параметры

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

getIsEntireColumn()

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

getIsEntireRow()

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

getOffsetRangeAreas(rowOffset, columnOffset)

Параметры

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

getPredefinedCellStyle()

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

getSpecialCells(cellType, cellValueType)

Параметры

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

getTables(fullyContained)

Параметры

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

getUsedRangeAreas(valuesOnly)

Параметры

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

getWorksheet()

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

setDirty()

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

setPredefinedCellStyle(predefinedCellStyle)

Параметры

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

Примеры

Дополнительные ресурсы