Excel.LinkedWorkbook class

  • Référence
Paquet:
excel

Contient des informations sur un classeur lié. Si un classeur a des liens pointant vers des données dans un autre classeur, le deuxième classeur est lié au premier classeur. Dans ce scénario, le deuxième classeur est appelé « classeur lié ».

Extends
OfficeExtension.ClientObject

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

URL d’origine pointant vers le classeur lié. Il est unique dans tous les classeurs liés de la collection.

Méthodes

breakLinks()

Effectue une demande pour arrêter les liens pointant vers le classeur lié. Les liens dans les formules sont remplacés par les données extraites les plus récentes. L’objet actuel LinkedWorkbook est invalidé et supprimé de LinkedWorkbookCollection.
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.
refresh()

Effectue une demande d’actualisation des données récupérées à partir du classeur lié.
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.LinkedWorkbook est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.LinkedWorkbookDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

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é

Excel.RequestContext

id

URL d’origine pointant vers le classeur lié. Il est unique dans tous les classeurs liés de la collection.

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

Détails de la méthode

Effectue une demande pour arrêter les liens pointant vers le classeur lié. Les liens dans les formules sont remplacés par les données extraites les plus récentes. L’objet actuel LinkedWorkbook est invalidé et supprimé de LinkedWorkbookCollection.

breakLinks(): void;

Retours

void

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.LinkedWorkbookLoadOptions): Excel.LinkedWorkbook;

Paramètres

options
Excel.Interfaces.LinkedWorkbookLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.LinkedWorkbook

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

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

Excel.LinkedWorkbook

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?: {
            select?: string;
            expand?: string;
        }): Excel.LinkedWorkbook;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

Excel.LinkedWorkbook

refresh()

Effectue une demande d’actualisation des données récupérées à partir du classeur lié.

refresh(): 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.LinkedWorkbook est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.LinkedWorkbookDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.LinkedWorkbookData;

Retours

Excel.Interfaces.LinkedWorkbookData