Excel.WorkbookRangeAreas class

Ссылка

Пакет:: excel

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

Extends: OfficeExtension.ClientObject

Свойства

addresses	Возвращает массив адресов в стиле A1. Значения адресов содержат имя листа для каждого прямоугольного блока ячеек (например, "Лист1! A1:B4, Лист1! D1:D4"). Только для чтения.
areas	`RangeAreasCollection` Возвращает объект . Каждый из них `RangeAreas` в коллекции представляет один или несколько диапазонов прямоугольника на одном листе.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
ranges	Возвращает диапазоны, составляющие этот объект в объекте `RangeCollection` .

Методы

getRangeAreasBySheet(key)	Возвращает объект на основе идентификатора `RangeAreas` листа или имени в коллекции.
getRangeAreasOrNullObjectBySheet(key)	Возвращает объект на `RangeAreas` основе имени листа или идентификатора в коллекции. Если лист не существует, этот метод возвращает объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный объект Excel.WorkbookRangeAreas является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.WorkbookRangeAreasData`), который содержит мелкие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах `.sync` и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить `context.sync()` до того, как выпуск памяти вступит в силу.

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

addresses

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

readonly addresses: string[];

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

string[]

areas

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

readonly areas: Excel.RangeAreasCollection;

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

Excel.RangeAreasCollection

Примеры

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

await Excel.run(async (context) => {
  // Precedents are cells referenced by the formula in a cell.
  // A "direct precedent" is a cell directly referenced by the selected formula.
  let range = context.workbook.getActiveCell();
  let directPrecedents = range.getDirectPrecedents();
  range.load("address");
  directPrecedents.areas.load("address");
  await context.sync();

  console.log(`Direct precedent cells of ${range.address}:`);

  // Use the direct precedents API to loop through precedents of the active cell.
  for (let i = 0; i < directPrecedents.areas.items.length; i++) {
    // Highlight and console the address of each precedent cell.
    directPrecedents.areas.items[i].format.fill.color = "Yellow";
    console.log(`  ${directPrecedents.areas.items[i].address}`);
  }
  await context.sync();
});

context

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

context: RequestContext;

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

Excel.RequestContext

ranges

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

readonly ranges: Excel.RangeCollection;

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

Excel.RangeCollection

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

getRangeAreasBySheet(key)

Возвращает объект на основе идентификатора RangeAreas листа или имени в коллекции.

getRangeAreasBySheet(key: string): Excel.RangeAreas;

Параметры

key: string

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

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

Excel.RangeAreas

getRangeAreasOrNullObjectBySheet(key)

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

getRangeAreasOrNullObjectBySheet(key: string): Excel.RangeAreas;

Параметры

key: string

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

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

Excel.RangeAreas

load(options)

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

load(options?: Excel.Interfaces.WorkbookRangeAreasLoadOptions): Excel.WorkbookRangeAreas;

Параметры

options: Excel.Interfaces.WorkbookRangeAreasLoadOptions

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

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

Excel.WorkbookRangeAreas

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.WorkbookRangeAreas

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Excel.WorkbookRangeAreas

toJSON()

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

toJSON(): Excel.Interfaces.WorkbookRangeAreasData;

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

Excel.Interfaces.WorkbookRangeAreasData

track()

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

track(): Excel.WorkbookRangeAreas;

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

Excel.WorkbookRangeAreas

untrack()

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

untrack(): Excel.WorkbookRangeAreas;

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

Excel.WorkbookRangeAreas

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

Excel.WorkbookRangeAreas class

Комментарии

Свойства

Методы

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

addresses

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

Комментарии

areas

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

Комментарии

Примеры

context

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

ranges

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

Комментарии

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

getRangeAreasBySheet(key)

Параметры

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

Комментарии

getRangeAreasOrNullObjectBySheet(key)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

toJSON()

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

track()

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

untrack()

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

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