Excel.LinkedEntityDataDomainCollection class
Représente une collection d’objets LinkedEntityDataDomain . La collection peut contenir des domaines de données d’entité liés tels que des actions, une géographie ou des devises définies par des fournisseurs de données de service, tels que Bing ou Power BI, ou des domaines de données d’entité liés définis par Compléments Office.
- Extends
Remarques
[Jeu d’API : ExcelApi 1.19]
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| add(options) | Ajoute à la collection un objet de domaine de données d’entité lié défini par le complément Office. Une fois le domaine de données d’entité lié ajouté, il peut être utilisé pour créer |
| get |
Obtient le nombre de domaines de données d’entité liés dans la collection. |
| get |
Obtient une entité liée domaine de données par son |
| get |
Obtient un domaine de données d’entité lié par son index dans la collection. |
| get |
Obtient une entité liée domaine de données par son |
| get |
Obtient une entité liée domaine de données par son |
| get |
Obtient une entité liée domaine de données par son |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load |
Envoie une demande de chargement de l’objet |
| refresh |
Actualise tous les |
| toJSON() | Remplace la méthode JavaScript |
Événements
| on |
Se produit lorsque la demande de chargement d’un |
| on |
Se produit lorsqu’un nouveau domaine de données d’entité liée est ajouté au classeur. |
| on |
Se produit lorsque la demande d’actualisation |
| on |
Se produit lorsque le |
Détails de la propriété
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;Valeur de propriété
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Excel.LinkedEntityDataDomain[];Valeur de propriété
Détails de la méthode
add(options)
Ajoute à la collection un objet de domaine de données d’entité lié défini par le complément Office. Une fois le domaine de données d’entité lié ajouté, il peut être utilisé pour créer LinkedEntityCellValue des objets.
add(options: Excel.LinkedEntityDataDomainCreateOptions): void;Paramètres
Options utilisées pour créer le domaine de données d’entité lié à ajouter.
Retours
void
Remarques
[Jeu d’API : ExcelApi 1.19]
getCount()
Obtient le nombre de domaines de données d’entité liés dans la collection.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
[Jeu d’API : ExcelApi 1.19]
getItem(id)
Obtient une entité liée domaine de données par son id.
getItem(id: string): Excel.LinkedEntityDataDomain;Paramètres
- id
-
string
L’objet idLinkedEntityDataDomain à récupérer.
Retours
L’entité liée au domaine de données avec le .id S’il existe plusieurs domaines de données d’entité liés avec le même id, celui défini par ce complément Office sera renvoyé.
Remarques
[Jeu d’API : ExcelApi 1.19]
getItemAt(index)
Obtient un domaine de données d’entité lié par son index dans la collection.
getItemAt(index: number): Excel.LinkedEntityDataDomain;Paramètres
- index
-
number
Index du domaine de données de l’entité liée dans la collection.
Retours
Domaine de données de l’entité liée à l’index donné.
Remarques
[Jeu d’API : ExcelApi 1.19]
getItemByName(name)
Obtient une entité liée domaine de données par son name.
getItemByName(name: string): Excel.LinkedEntityDataDomain;Paramètres
- name
-
string
L’objet nameLinkedEntityDataDomain à récupérer.
Retours
L’entité liée au domaine de données avec le .name S’il existe plusieurs domaines de données d’entité liés avec le même name, celui défini par ce complément Office sera renvoyé.
Remarques
[Jeu d’API : ExcelApi 1.19]
getItemByNameOrNullObject(name)
Obtient une entité liée domaine de données par son name. Si le domaine de données de l’entité liée n’existe pas, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;Paramètres
- name
-
string
L’objet nameLinkedEntityDataDomain à récupérer.
Retours
L’entité liée au domaine de données avec le .name S’il existe plusieurs domaines de données d’entité liés avec le même name, celui défini par ce complément Office sera renvoyé.
Remarques
[Jeu d’API : ExcelApi 1.19]
getItemOrNullObject(id)
Obtient une entité liée domaine de données par son id. Si le domaine de données de l’entité liée n’existe pas, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;Paramètres
- id
-
string
L’objet idLinkedEntityDataDomain à récupérer.
Retours
L’entité liée au domaine de données avec le .id S’il existe plusieurs domaines de données d’entité liés avec le même id, celui défini par ce complément Office sera renvoyé.
Remarques
[Jeu d’API : ExcelApi 1.19]
load(options)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(options?: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedEntityDataDomainCollection;Paramètres
- options
-
Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomainCollection;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.
Retours
load(propertyNamesAndPaths)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection;Paramètres
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
loadLinkedEntityCellValue(id)
Envoie une demande de chargement de l’objet LinkedEntityCellValue avec le fichier LinkedEntityId. S’il est trouvé, l’objet LinkedEntityCellValue est renvoyé par le biais de l’événement LinkedEntityCellValueLoaded .
loadLinkedEntityCellValue(id: LinkedEntityId): void;Paramètres
Un point de terminaison spécifique LinkedEntityId
Retours
void
Remarques
[Jeu d’API : ExcelApi 1.21]
refreshAll()
Actualise tous les LinkedEntityCellValue objets de tous les domaines de données d’entité liés dans cette collection. La demande d’actualisation peut échouer si les fournisseurs de données sont occupés ou temporairement inaccessibles.
refreshAll(): void;Retours
void
Remarques
[Jeu d’API : ExcelApi 1.19]
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.LinkedEntityDataDomainCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.LinkedEntityDataDomainCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;Retours
Détails de l’événement
onLinkedEntityCellValueLoaded
Se produit lorsque la demande de chargement d’un LinkedEntityCellValue est terminée.
readonly onLinkedEntityCellValueLoaded: OfficeExtension.EventHandlers<Excel.LinkedEntityCellValueLoadedEventArgs>;Type d’événement
Remarques
[Jeu d’API : ExcelApi 1.21]
Cet événement n’est pas pris en charge dans Excel sur le Web.
onLinkedEntityDataDomainAdded
Se produit lorsqu’un nouveau domaine de données d’entité liée est ajouté au classeur.
readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>;Type d’événement
Remarques
[Jeu d’API : ExcelApi 1.19]
onRefreshCompleted
Se produit lorsque la demande d’actualisation LinkedEntityCellValue des objets d’un domaine de données d’entité lié est terminée.
readonly onRefreshCompleted: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>;Type d’événement
Remarques
[Jeu d’API : ExcelApi 1.19]
onRefreshModeChanged
Se produit lorsque le refreshMode d’un domaine de données d’entité liée est modifié.
readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;Type d’événement
Remarques
[Jeu d’API : ExcelApi 1.19]