Excel.LinkedWorkbook class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
id	Исходный URL-адрес, указывающий на связанную книгу. Он уникален для всех связанных книг в коллекции.

Методы

breakLinks()	Выполняет запрос на разрыв ссылок, указывающих на связанную книгу. Ссылки в формулах заменяются последними извлекаемых данных. Текущий LinkedWorkbook объект становится недействительным и удаляется из LinkedWorkbookCollection.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
refresh()	Выполняет запрос на обновление данных, полученных из связанной книги.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.LinkedWorkbook объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.LinkedWorkbookData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

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

context: RequestContext;

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

Excel.RequestContext

id

Исходный URL-адрес, указывающий на связанную книгу. Он уникален для всех связанных книг в коллекции.

readonly id: string;

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

string

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

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

breakLinks()

Выполняет запрос на разрыв ссылок, указывающих на связанную книгу. Ссылки в формулах заменяются последними извлекаемых данных. Текущий LinkedWorkbook объект становится недействительным и удаляется из LinkedWorkbookCollection.

breakLinks(): void;

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

void

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

load(options)

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

load(options?: Excel.Interfaces.LinkedWorkbookLoadOptions): Excel.LinkedWorkbook;

Параметры

options

Excel.Interfaces.LinkedWorkbookLoadOptions

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

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

Excel.LinkedWorkbook

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.LinkedWorkbook

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.LinkedWorkbook

refresh()

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

refresh(): void;

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

void

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

toJSON()

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

toJSON(): Excel.Interfaces.LinkedWorkbookData;

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

Excel.Interfaces.LinkedWorkbookData