Objet NamedItem (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 un nom défini pour une plage de cellules ou une valeur. Les noms peuvent être des objets nommés primitifs (comme dans le type ci-dessous), un objet de plage et une référence à une plage. Cet objet peut être utilisé pour obtenir un objet de plage associé aux noms.

PropriétéTypeDescription
namestringNom de l’objet. En lecture seule.
typestringIndique le type de référence associé au nom. En lecture seule. Les valeurs possibles sont les suivantes : String, Integer, Double, Boolean, Range.
valueobjectReprésente la formule à laquelle le nom doit faire référence. Par exemple, =Sheet14!$B2 : H$12, =4.75, etc. En lecture seule.
visibleboolIndique si l’objet est visible ou non.

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

Aucun

MéthodeType renvoyéDescription
getRange()RangeRenvoie l’objet de plage qui est associé au nom. Renvoie une exception si le type de l’élément nommé n’est pas une plage.
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 l’objet de plage qui est associé au nom. Renvoie une exception si le type de l’élément nommé n’est pas une plage.

Syntaxe

jsnamedItemObject.getRange();

Paramètres

Aucun

Retourne

Range

Exemples

Renvoie l’objet de plage qui est associé au nom. Renvoie null si le nom n’est pas du type Range. Remarque : actuellement, cette API prend uniquement en charge les éléments de classeur inclus dans l’étendue.


Excel.run(function (ctx) { 
    var names = ctx.workbook.names;
    var range = names.getItem('MyRange').getRange();
    range.load('address');
    return ctx.sync().then(function() {
            console.log(range.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


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

Afficher: