Excel.BindingCollection class

Référence

Paquet:: excel

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

Extends: OfficeExtension.ClientObject

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

Méthodes

add(range, bindingType, id)	Ajoute une nouvelle liaison à une plage spécifique.
add(range, bindingTypeString, id)	Ajoute une nouvelle liaison à une plage spécifique.
addFromNamedItem(name, bindingType, id)	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 retournée.
addFromNamedItem(name, bindingTypeString, id)	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 retournée.
addFromSelection(bindingType, id)	Ajoute une nouvelle liaison basée sur la sélection en cours. Si la sélection comporte plusieurs zones, l’erreur `InvalidReference` est retournée.
addFromSelection(bindingTypeString, id)	Ajoute une nouvelle liaison basée sur la sélection en cours. Si la sélection comporte plusieurs zones, l’erreur `InvalidReference` est retournée.
getCount()	Obtient le nombre de liaisons de la collection.
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.
getItemOrNullObject(id)	Obtient un objet de liaison par ID. Si l’objet de liaison 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.
toJSON()	Remplace la méthode JavaScript `toJSON()` afin de fournir une sortie plus utile lorsqu’un objet API est passé à `JSON.stringify()`. (`JSON.stringify`appelle à 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.BindingCollectionData`que ) 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

add(range, bindingType, id)

Ajoute une nouvelle liaison à une plage spécifique.

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

Paramètres

range: Excel.Range | string

Plage à laquelle lier la liaison. Il peut s’agir d’un Range objet ou d’une chaîne. Si c’est une chaîne, elle doit contenir l’adresse complète, y compris le nom de la feuille.

bindingType: Excel.BindingType

Type de liaison. Voir Excel.BindingType (en anglais).

id: string

Nom de la liaison.

Retours

Excel.Binding

Remarques

[ Ensemble d’API : ExcelApi 1.3 ]

add(range, bindingTypeString, id)

Ajoute une nouvelle liaison à une plage spécifique.

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

Paramètres

range: Excel.Range | string

Plage à laquelle lier la liaison. Il peut s’agir d’un Range objet ou d’une chaîne. Si c’est une chaîne, elle doit contenir l’adresse complète, y compris le nom de la feuille.

bindingTypeString: "Range" | "Table" | "Text"

Type de liaison. Voir Excel.BindingType (en anglais).

id: string

Nom de la liaison.

Retours

Excel.Binding

Remarques

[ Ensemble d’API : ExcelApi 1.3 ]

addFromNamedItem(name, bindingType, id)

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 retournée.

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

Paramètres

name: string

Nom à partir duquel créer la liaison.

bindingType: Excel.BindingType

Type de liaison. Voir Excel.BindingType (en anglais).

id: string

Nom de la liaison.

Retours

Excel.Binding

Remarques

[ Ensemble d’API : ExcelApi 1.3 ]

addFromNamedItem(name, bindingTypeString, id)

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 retournée.

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

Paramètres

name: string

Nom à partir duquel créer la liaison.

bindingTypeString: "Range" | "Table" | "Text"

Type de liaison. Voir Excel.BindingType (en anglais).

id: string

Nom de la liaison.

Retours

Excel.Binding

Remarques

[ Ensemble d’API : ExcelApi 1.3 ]

addFromSelection(bindingType, id)

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

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

Paramètres

bindingType: Excel.BindingType

Type de liaison. Voir Excel.BindingType (en anglais).

id: string

Nom de la liaison.

Retours

Excel.Binding

Remarques

[ Ensemble d’API : ExcelApi 1.3 ]

addFromSelection(bindingTypeString, id)

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

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

Paramètres

bindingTypeString: "Range" | "Table" | "Text"

Type de liaison. Voir Excel.BindingType (en anglais).

id: string

Nom de la liaison.

Retours

Excel.Binding

Remarques

[ Ensemble d’API : ExcelApi 1.3 ]

getCount()

Obtient le nombre de liaisons de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

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

getItemOrNullObject(id)

Obtient un objet de liaison par ID. Si l’objet de liaison 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.Binding;

Paramètres

id: string

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

Retours

Excel.Binding

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

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

Partager via

Excel.BindingCollection class

Remarques

Propriétés

Méthodes

Détails de la propriété

context

Valeur de propriété

count

Valeur de propriété

Remarques

items

Valeur de propriété

Détails de la méthode

add(range, bindingType, id)

Paramètres

Retours

Remarques

add(range, bindingTypeString, id)

Paramètres

Retours

Remarques

addFromNamedItem(name, bindingType, id)

Paramètres

Retours

Remarques

addFromNamedItem(name, bindingTypeString, id)

Paramètres

Retours

Remarques

addFromSelection(bindingType, id)

Paramètres

Retours

Remarques

addFromSelection(bindingTypeString, id)

Paramètres

Retours

Remarques

getCount()

Retours

Remarques

getItem(id)

Paramètres

Retours

Remarques

Exemples

getItemAt(index)

Paramètres

Retours

Remarques

Exemples

getItemOrNullObject(id)

Paramètres

Retours

Remarques

load(options)

Paramètres

Retours

load(propertyNames)

Paramètres

Retours

Exemples

load(propertyNamesAndPaths)

Paramètres

Retours

toJSON()

Retours

Ressources supplémentaires