Objet Workbook (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

Le classeur est l’objet de niveau supérieur qui contient des objets connexes tels que des feuilles de calcul, des tableaux, des plages, etc.

Aucun

RelationTypeDescription
applicationApplicationReprésente une instance de l’application Excel contenant ce classeur. En lecture seule.
bindingsBindingCollectionReprésente une collection de liaisons appartenant au classeur. En lecture seule.
namesNamedItemCollectionReprésente une collection d’éléments nommés portant sur le classeur (appelés plages et constantes). En lecture seule.
tablesTableCollectionReprésente une collection de tableaux associés au classeur. En lecture seule.
WorksheetsWorksheetCollectionReprésente une collection de feuilles de calcul associées au classeur. En lecture seule.
MéthodeType renvoyéDescription
getSelectedRange()RangeObtient la plage sélectionnée dans le classeur.
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.

Obtient la plage sélectionnée dans le classeur.

Syntaxe

jsworkbookObject.getSelectedRange();

Paramètres

Aucun

Retourne

Range

Exemples


Excel.run(function (ctx) { 
    var selectedRange = ctx.workbook.getSelectedRange();
    selectedRange.load('address');
    return ctx.sync().then(function() {
            console.log(selectedRange.address);
    });
}).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, indiquez l’objet loadOption.

Renvoie

void

Afficher: