Partager via


Excel.LinkedWorkbookCollection class

Représente une collection d’objets classeur liés.

Extends

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

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.

workbookLinksRefreshMode

Représente le mode de mise à jour des liens de classeur. Le mode est le même pour tous les liens de classeur présents dans le classeur.

Méthodes

breakAllLinks()

Interrompt tous les liens vers les classeurs liés. Une fois les liens rompus, toutes les formules référençant des liens de classeur sont entièrement supprimées et remplacées par les dernières valeurs récupérées.

getItem(key)

Obtient des informations sur un classeur lié par son URL.

getItemOrNullObject(key)

Obtient des informations sur un classeur lié par son URL. Si le classeur 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.

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(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(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.

refreshAll()

Effectue une demande d’actualisation de tous les liens de classeur.

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.LinkedWorkbookCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.LinkedWorkbookCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

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.LinkedWorkbook[];

Valeur de propriété

workbookLinksRefreshMode

Représente le mode de mise à jour des liens de classeur. Le mode est le même pour tous les liens de classeur présents dans le classeur.

workbookLinksRefreshMode: Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic";

Valeur de propriété

Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic"

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

Détails de la méthode

Interrompt tous les liens vers les classeurs liés. Une fois les liens rompus, toutes les formules référençant des liens de classeur sont entièrement supprimées et remplacées par les dernières valeurs récupérées.

breakAllLinks(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

getItem(key)

Obtient des informations sur un classeur lié par son URL.

getItem(key: string): Excel.LinkedWorkbook;

Paramètres

key

string

URL du classeur lié.

Retours

Classeur lié avec l’URL donnée.

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

Obtient des informations sur un classeur lié par son URL. Si le classeur 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(key: string): Excel.LinkedWorkbook;

Paramètres

key

string

URL du classeur lié.

Retours

Classeur lié avec l’URL donnée.

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

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.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedWorkbookCollection;

Paramètres

options

Excel.Interfaces.LinkedWorkbookCollectionLoadOptions & 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.LinkedWorkbookCollection;

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.LinkedWorkbookCollection;

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()

Effectue une demande d’actualisation de tous les liens de classeur.

refreshAll(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.LinkedWorkbookCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.LinkedWorkbookCollectionDataque ) 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.LinkedWorkbookCollectionData;

Retours