Excel.Workbook class

Ссылка

Пакет:: excel

Workbook — это объект верхнего уровня, содержащий связанные объекты книги, такие как листы, таблицы и диапазоны. Дополнительные сведения об объектной модели книг см. в статье Работа с книгами с помощью API JavaScript для Excel.

Extends: OfficeExtension.ClientObject

Свойства

application	Представляет экземпляр приложения Excel, содержащий эту книгу.
bindings	Представляет коллекцию привязок, включенных в книгу.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
customXmlParts	Представляет коллекцию настраиваемых XML-частей, содержащихся в этой книге.
functions	Представляет коллекцию функций листа, которые можно использовать для вычислений.
names	Представляет коллекцию именованных элементов с областью книги (именованные диапазоны и константы).
pivotTables	Представляет коллекцию сводных таблиц, сопоставленных с книгой.
settings	Представляет коллекцию параметров, связанных с книгой.
tables	Представляет коллекцию таблиц, сопоставленных с книгой.
worksheets	Представляет коллекцию листов, сопоставленных с книгой.

Методы

getSelectedRange()	Возвращает выбранный в данный момент один диапазон из книги. Если выбрано несколько диапазонов, этот метод вызовет ошибку.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.Workbook` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.WorkbookData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

События

onSelectionChanged

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

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

application

Представляет экземпляр приложения Excel, содержащий эту книгу.

readonly application: Excel.Application;

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

Excel.Application

bindings

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

readonly bindings: Excel.BindingCollection;

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

Excel.BindingCollection

context

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

context: RequestContext;

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

Excel.RequestContext

customXmlParts

Представляет коллекцию настраиваемых XML-частей, содержащихся в этой книге.

readonly customXmlParts: Excel.CustomXmlPartCollection;

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

Excel.CustomXmlPartCollection

functions

Представляет коллекцию функций листа, которые можно использовать для вычислений.

readonly functions: Excel.Functions;

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

Excel.Functions

names

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

readonly names: Excel.NamedItemCollection;

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

Excel.NamedItemCollection

pivotTables

Представляет коллекцию сводных таблиц, сопоставленных с книгой.

readonly pivotTables: Excel.PivotTableCollection;

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

Excel.PivotTableCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml

await Excel.run(async (context) => {
  // Get the names of all the PivotTables in the workbook.
  const pivotTables = context.workbook.pivotTables;
  pivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the workbook:")
  pivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

settings

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

readonly settings: Excel.SettingCollection;

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

Excel.SettingCollection

tables

Представляет коллекцию таблиц, сопоставленных с книгой.

readonly tables: Excel.TableCollection;

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

Excel.TableCollection

worksheets

Представляет коллекцию листов, сопоставленных с книгой.

readonly worksheets: Excel.WorksheetCollection;

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

Excel.WorksheetCollection

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

getSelectedRange()

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

getSelectedRange(): Excel.Range;

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

Excel.Range

Примеры

await Excel.run(async (context) => { 
    const selectedRange = context.workbook.getSelectedRange();
    selectedRange.load('address');
    await context.sync();
    console.log(selectedRange.address);
});

load(options)

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

load(options?: Excel.Interfaces.WorkbookLoadOptions): Excel.Workbook;

Параметры

options: Excel.Interfaces.WorkbookLoadOptions

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

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

Excel.Workbook

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.Workbook

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Excel.Workbook

set(properties, options)

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

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

Параметры

properties: Excel.Interfaces.WorkbookUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.Workbook): void;

Параметры

properties: Excel.Workbook

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

void

toJSON()

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

toJSON(): Excel.Interfaces.WorkbookData;

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

Excel.Interfaces.WorkbookData

Сведения о событии

onSelectionChanged

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

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>

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

Excel.Workbook class

Комментарии

Свойства

Методы

События

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

application

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

Комментарии

bindings

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

Комментарии

context

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

customXmlParts

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

Комментарии

functions

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

Комментарии

names

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

Комментарии

pivotTables

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

Комментарии

Примеры

settings

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

Комментарии

tables

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

Комментарии

worksheets

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

Комментарии

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

getSelectedRange()

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

Комментарии

Примеры

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

Сведения о событии

onSelectionChanged

Тип события

Комментарии

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