Excel.LinkedWorkbookCollection class
Представляет коллекцию связанных объектов книг.
- Extends
Комментарии
[ Набор API: ExcelApiOnline 1.1 ]
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
| workbook |
Представляет режим обновления ссылок книги. Режим одинаков для всех ссылок книг, присутствующих в книге. |
Методы
| break |
Разрывает все ссылки на связанные книги. После разрыва ссылок все формулы, ссылающиеся на ссылки на книги, полностью удаляются и заменяются последними извлеченными значениями. |
| get |
Получает сведения о связанной книге по URL-адресу. |
| get |
Получает сведения о связанной книге по URL-адресу. Если книга не существует, этот метод возвращает объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| refresh |
Отправляет запрос на обновление всех ссылок книги. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Excel.LinkedWorkbook[];Значение свойства
workbookLinksRefreshMode
Представляет режим обновления ссылок книги. Режим одинаков для всех ссылок книг, присутствующих в книге.
workbookLinksRefreshMode: Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic";Значение свойства
Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic"
Комментарии
Сведения о методе
breakAllLinks()
Разрывает все ссылки на связанные книги. После разрыва ссылок все формулы, ссылающиеся на ссылки на книги, полностью удаляются и заменяются последними извлеченными значениями.
breakAllLinks(): void;Возвращаемое значение
void
Комментарии
getItem(key)
Получает сведения о связанной книге по URL-адресу.
getItem(key: string): Excel.LinkedWorkbook;Параметры
- key
-
string
URL-адрес связанной книги.
Возвращаемое значение
Связанная книга с заданным URL-адресом.
Комментарии
getItemOrNullObject(key)
Получает сведения о связанной книге по URL-адресу. Если книга не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(key: string): Excel.LinkedWorkbook;Параметры
- key
-
string
URL-адрес связанной книги.
Возвращаемое значение
Связанная книга с заданным URL-адресом.
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedWorkbookCollection;Параметры
- options
-
Excel.Interfaces.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.LinkedWorkbookCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedWorkbookCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
refreshAll()
Отправляет запрос на обновление всех ссылок книги.
refreshAll(): void;Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.LinkedWorkbookCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.LinkedWorkbookCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): Excel.Interfaces.LinkedWorkbookCollectionData;Возвращаемое значение
Office Add-ins