Excel.BindingCollection class

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é

Renvoie le nombre de liaisons de la collection.

readonly count: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

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

readonly items: Excel.Binding[];

Valeur de propriété

Ajoute une nouvelle liaison à une plage spécifique.

add(range: Range | string, bindingType: Excel.BindingType, id: string): Excel.Binding;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.3

Ajoute une nouvelle liaison à une plage spécifique.

add(range: Range | string, bindingType: "Range" | "Table" | "Text", id: string): Excel.Binding;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.3

Ajoute une nouvelle liaison basée sur un élément nommé dans le classeur. Si l’élément nommé fait référence à plusieurs zones, l’erreur InvalidReference est renvoyée.

addFromNamedItem(name: string, bindingType: Excel.BindingType, id: string): Excel.Binding;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.3

Ajoute une nouvelle liaison basée sur un élément nommé dans le classeur. Si l’élément nommé fait référence à plusieurs zones, l’erreur InvalidReference est renvoyée.

addFromNamedItem(name: string, bindingType: "Range" | "Table" | "Text", id: string): Excel.Binding;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.3

Ajoute une nouvelle liaison basée sur la sélection en cours. Si la sélection comporte plusieurs zones, l’erreur InvalidReference est renvoyée.

addFromSelection(bindingType: Excel.BindingType, id: string): Excel.Binding;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.3

Ajoute une nouvelle liaison basée sur la sélection en cours. Si la sélection comporte plusieurs zones, l’erreur InvalidReference est renvoyée.

addFromSelection(bindingType: "Range" | "Table" | "Text", id: string): Excel.Binding;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.3

Obtient le nombre de liaisons de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

Jeu d’API : ExcelApi 1.4

Obtient un objet de liaison par ID.

getItem(id: string): Excel.Binding;

Paramètres

Retours

Remarques

Jeu 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!");
    });
}

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

getItemAt(index: number): Excel.Binding;

Paramètres

Retours

Remarques

Jeu 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);
});

Obtient un objet de liaison par ID. Si l’objet de liaison n’existe pas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getItemOrNullObject(id: string): Excel.Binding;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.4

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

Retours

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

Retours

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);
    }
});

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

Retours

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.BindingCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.BindingCollectionDataqui 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