Excel.LinkedEntityDataDomainCollection class

Пакет:: excel

Представляет коллекцию LinkedEntityDataDomain объектов. Коллекция может содержать связанные домены данных сущностей, такие как акции, география или валюты, определенные поставщиками данных служб, такими как Bing или Power BI, или домены данных связанных сущностей, определенные надстройками Office.

Extends: OfficeExtension.ClientObject

Свойства

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

Методы

add(options)	Добавляет в коллекцию объект домена данных связанной сущности, определенный надстройкой Office. После добавления домена данных связанной сущности его можно использовать для создания `LinkedEntityCellValue` объектов.
getCount()	Возвращает количество доменов данных связанных сущностей в коллекции.
getItem(id)	Получает домен данных связанной сущности по его `id`.
getItemAt(index)	Получает домен данных связанной сущности по индексу в коллекции.
getItemByName(name)	Получает домен данных связанной сущности по его `name`.
getItemByNameOrNullObject(name)	Получает домен данных связанной сущности по его `name`. Если домен данных связанной сущности не существует, то этот метод возвращает объект со свойством `isNullObject` , равным `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(id)	Получает домен данных связанной сущности по его `id`. Если домен данных связанной сущности не существует, то этот метод возвращает объект со свойством `isNullObject` , равным `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
refreshAll()	Обновляет все `LinkedEntityCellValue` объекты всех доменов данных связанных сущностей в этой коллекции. Запрос на обновление может завершиться ошибкой, если поставщики данных заняты или временно недоступны.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.LinkedEntityDataDomainCollection` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.LinkedEntityDataDomainCollectionData`), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

События

onLinkedEntityDataDomainAdded	Происходит при добавлении в книгу нового домена данных связанной сущности.
onRefreshCompleted	Происходит при выполнении запроса на обновление `LinkedEntityCellValue` объектов домена данных связанной сущности.
onRefreshModeChanged	Происходит при `refreshMode` изменении домена данных связанной сущности.

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

context

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

context: RequestContext;

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

Excel.RequestContext

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Excel.LinkedEntityDataDomain[];

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

Excel.LinkedEntityDataDomain[]

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

add(options)

Добавляет в коллекцию объект домена данных связанной сущности, определенный надстройкой Office. После добавления домена данных связанной сущности его можно использовать для создания LinkedEntityCellValue объектов.

add(options: Excel.LinkedEntityDataDomainCreateOptions): void;

Параметры

options: Excel.LinkedEntityDataDomainCreateOptions

Параметры, используемые для создания домена данных связанной сущности для добавления.

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

void

getCount()

Возвращает количество доменов данных связанных сущностей в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

getItem(id)

Получает домен данных связанной сущности по его id.

getItem(id: string): Excel.LinkedEntityDataDomain;

Параметры

id: string

Объект id извлекаемого LinkedEntityDataDomain объекта.

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

Excel.LinkedEntityDataDomain

Домен данных связанной сущности с заданным id. При наличии нескольких связанных доменов данных сущности с одним и тем же id, будет возвращен один, определенный этой надстройкой Office.

getItemAt(index)

Получает домен данных связанной сущности по индексу в коллекции.

getItemAt(index: number): Excel.LinkedEntityDataDomain;

Параметры

index: number

Индекс домена данных связанной сущности в коллекции.

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

Excel.LinkedEntityDataDomain

Домен данных связанной сущности по заданному индексу.

getItemByName(name)

Получает домен данных связанной сущности по его name.

getItemByName(name: string): Excel.LinkedEntityDataDomain;

Параметры

name: string

Объект name извлекаемого LinkedEntityDataDomain объекта.

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

Excel.LinkedEntityDataDomain

Домен данных связанной сущности с заданным name. При наличии нескольких связанных доменов данных сущности с одним и тем же name, будет возвращен один, определенный этой надстройкой Office.

getItemByNameOrNullObject(name)

Получает домен данных связанной сущности по его name. Если домен данных связанной сущности не существует, то этот метод возвращает объект со свойством isNullObject , равным true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;

Параметры

name: string

Объект name извлекаемого LinkedEntityDataDomain объекта.

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

Excel.LinkedEntityDataDomain

getItemOrNullObject(id)

Получает домен данных связанной сущности по его id. Если домен данных связанной сущности не существует, то этот метод возвращает объект со свойством isNullObject , равным true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;

Параметры

id: string

Объект id извлекаемого LinkedEntityDataDomain объекта.

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

Excel.LinkedEntityDataDomain

load(options)

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

load(options?: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedEntityDataDomainCollection;

Параметры

options: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.LinkedEntityDataDomainCollection

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.LinkedEntityDataDomainCollection

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection;

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

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

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

Excel.LinkedEntityDataDomainCollection

refreshAll()

Обновляет все LinkedEntityCellValue объекты всех доменов данных связанных сущностей в этой коллекции. Запрос на обновление может завершиться ошибкой, если поставщики данных заняты или временно недоступны.

refreshAll(): void;

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

void

toJSON()

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

toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;

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

Excel.Interfaces.LinkedEntityDataDomainCollectionData

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

onLinkedEntityDataDomainAdded

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

readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>

onRefreshCompleted

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

readonly onRefreshCompleted: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>

onRefreshModeChanged

Происходит при refreshMode изменении домена данных связанной сущности.

readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>

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

Excel.LinkedEntityDataDomainCollection class

Комментарии

Свойства

Методы

События

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

context

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

items

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

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

add(options)

Параметры

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

Комментарии

getCount()

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

Комментарии

getItem(id)

Параметры

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

Комментарии

getItemAt(index)

Параметры

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

Комментарии

getItemByName(name)

Параметры

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

Комментарии

getItemByNameOrNullObject(name)

Параметры

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

Комментарии

getItemOrNullObject(id)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

refreshAll()

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

Комментарии

toJSON()

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

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

onLinkedEntityDataDomainAdded

Тип события

Комментарии

onRefreshCompleted

Тип события

Комментарии

onRefreshModeChanged

Тип события

Комментарии

Обратная связь