Objet Binding (interface API JavaScript pour Excel)

Office and SharePoint Add-ins

La dernière version de ce complément Office est disponible dans le référentiel GitHub des compléments.


S’applique à : Excel 2016, Excel Online, Office 2016

Représente une liaison Office.js définie dans le classeur.

PropriétéTypeDescription
idstringReprésente l’identificateur de liaison. En lecture seule.
typestringRenvoie le type de la liaison. En lecture seule. Les valeurs possibles sont les suivantes : Range, Table, Text.

Voir des exemples d’accès aux propriétés.

Aucun

MéthodeType renvoyéDescription
getRange()RangeRenvoie la plage représentée par la liaison. Génère une erreur si la liaison n’est pas du type approprié.
getTable()TableRenvoie le tableau représenté par la liaison. Génère une erreur si la liaison n’est pas du type approprié.
getText()stringRenvoie le texte représenté par la liaison. Génère une erreur si la liaison n’est pas du type approprié.
load(param: object)voidRemplit l’objet proxy créé dans le calque JavaScript avec des valeurs de propriété et d’objet spécifiées dans le paramètre.

Renvoie la plage représentée par la liaison. Génère une erreur si la liaison n’est pas du type approprié.

Syntaxe

jsbindingObject.getRange();

Paramètres

Aucun

Retourne

Range

Exemples

L’exemple ci-dessous utilise un objet de liaison pour obtenir la plage associée.


Excel.run(function (ctx) { 
    var binding = ctx.workbook.bindings.getItemAt(0);
    var range = binding.getRange();
    range.load('cellCount');
    return ctx.sync().then(function() {
        console.log(range.cellCount);
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

Renvoie le tableau représenté par la liaison. Génère une erreur si la liaison n’est pas du type approprié.

Syntaxe

jsbindingObject.getTable();

Paramètres

Aucun

Retourne

Table

Exemples


Excel.run(function (ctx) { 
    var binding = ctx.workbook.bindings.getItemAt(0);
    var table = binding.getTable();
    table.load('name');
    return ctx.sync().then(function() {
            console.log(table.name);
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

Renvoie le texte représenté par la liaison. Génère une erreur si la liaison n’est pas du type approprié.

Syntaxe

jsbindingObject.getText();

Paramètres

Aucun

Retourne

string

Exemples


Excel.run(function (ctx) { 
    var binding = ctx.workbook.bindings.getItemAt(0);
    var text = binding.getText();
    ctx.load('text');
    return ctx.sync().then(function() {
        console.log(text);
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

Remplit l’objet proxy créé dans le calque JavaScript avec des valeurs de propriété et d’objet spécifiées dans le paramètre.

Syntaxe

jsobject.load(param);

Paramètres

ParamètreTypeDescription
paramobjectFacultatif. Accepte les noms de paramètre et de relation sous forme de chaîne délimitée ou de tableau. Sinon, accepte un objet loadOption.

Renvoie

void


Excel.run(function (ctx) { 
    var binding = ctx.workbook.bindings.getItemAt(0);
    binding.load('type');
    return ctx.sync().then(function() {
        console.log(binding.type);
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

Afficher: