Excel.BindingCollection class

Paquet:

excel

Représente la collection de l’ensemble des objets de liaison qui font partie du classeur.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 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.
count	Renvoie le nombre de liaisons de la collection.
items	Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

getItem(id)	Obtient un objet de liaison par ID.
getItemAt(index)	Obtient un objet de liaison en fonction de sa position dans le tableau d’éléments.
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.
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.BindingCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.BindingCollectionDataque ) 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é

Excel.RequestContext

count

Renvoie le nombre de liaisons de la collection.

readonly count: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

items

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.Binding[];

Valeur de propriété

Excel.Binding[]

Détails de la méthode

getItem(id)

Obtient un objet de liaison par ID.

getItem(id: string): Excel.Binding;

Paramètres

id

string

ID de l’objet de liaison à récupérer.

Retours

Excel.Binding

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

async function onBindingDataChanged(eventArgs) {
    await Excel.run(async (context) => { 
        // Highlight the table related to the binding in orange to indicate data has been changed.
        context.workbook.bindings.getItem(eventArgs.binding.id).getTable().getDataBodyRange().format.fill.color = "Orange";
        await context.sync();
        
        console.log("The value in this table got changed!");
    });
}

getItemAt(index)

Obtient un objet de liaison en fonction de sa position dans le tableau d’éléments.

getItemAt(index: number): Excel.Binding;

Paramètres

index

number

Valeur d’indice de l’objet à récupérer. Avec indice zéro.

Retours

Excel.Binding

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

await Excel.run(async (context) => { 
    const lastPosition = context.workbook.bindings.count - 1;
    const binding = context.workbook.bindings.getItemAt(lastPosition);
    binding.load('type')
    await context.sync();

    console.log(binding.type);
});

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

Paramètres

options

Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Retours

Excel.BindingCollection

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

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

Exemples

await Excel.run(async (context) => { 
    const bindings = context.workbook.bindings;
    bindings.load('items');
    await context.sync();

    for (let i = 0; i < bindings.items.length; i++) {
        console.log(bindings.items[i].id);
    }
});

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

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

Excel.BindingCollection

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.BindingCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.BindingCollectionDataque ) 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.BindingCollectionData;

Retours

Excel.Interfaces.BindingCollectionData