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, des zones géographiques 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ée définis par les compléments Office.
- Extends
Remarques
Propriétés
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus 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ée 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 un domaine de données d’entité liée par son |
| get |
Obtient un domaine de données d’entité liée par son index dans la collection. |
| get |
Obtient un domaine de données d’entité liée par son |
| get |
Obtient un domaine de données d’entité liée par son |
| get |
Obtient un domaine de données d’entité liée 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 |
| refresh |
Actualise tous les |
| toJSON() | Remplace la méthode JavaScript |
Événements
| 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 . Cela connecte le processus du complément au processus 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ée 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ée à ajouter.
Retours
void
Remarques
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
getItem(id)
Obtient un domaine de données d’entité liée par son id.
getItem(id: string): Excel.LinkedEntityDataDomain;Paramètres
- id
-
string
id de l’objet LinkedEntityDataDomain à récupérer.
Retours
Domaine de données d’entité liée avec le donné 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 est retourné.
Remarques
getItemAt(index)
Obtient un domaine de données d’entité liée par son index dans la collection.
getItemAt(index: number): Excel.LinkedEntityDataDomain;Paramètres
- index
-
number
Index du domaine de données d’entité liée dans la collection.
Retours
Domaine de données d’entité liée à l’index donné.
Remarques
getItemByName(name)
Obtient un domaine de données d’entité liée par son name.
getItemByName(name: string): Excel.LinkedEntityDataDomain;Paramètres
- name
-
string
name de l’objet LinkedEntityDataDomain à récupérer.
Retours
Domaine de données d’entité liée avec le donné 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 est retourné.
Remarques
getItemByNameOrNullObject(name)
Obtient un domaine de données d’entité liée par son name. Si le domaine de données d’entité liée n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;Paramètres
- name
-
string
name de l’objet LinkedEntityDataDomain à récupérer.
Retours
Domaine de données d’entité liée avec le donné 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 est retourné.
Remarques
getItemOrNullObject(id)
Obtient un domaine de données d’entité liée par son id. Si le domaine de données d’entité liée n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;Paramètres
- id
-
string
id de l’objet LinkedEntityDataDomain à récupérer.
Retours
Domaine de données d’entité liée avec le donné 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 est retourné.
Remarques
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 qui spécifient 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
refreshAll()
Actualise tous les LinkedEntityCellValue objets de tous les domaines de données d’entité liée 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
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 brut (typé en tant Excel.Interfaces.LinkedEntityDataDomainCollectionDataque ) qui 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
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
onRefreshCompleted
Se produit lorsque la demande d’actualisation LinkedEntityCellValue des objets d’un domaine de données d’entité liée est terminée.
readonly onRefreshCompleted: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>;Type d'événement
Remarques
onRefreshModeChanged
Se produit lorsque le refreshMode d’un domaine de données d’entité liée est modifié.
readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;