Excel.NamedItemCollection class
A collection of all the NamedItem objects that are part of the workbook or worksheet, depending on how it was reached.
- Extends
Remarks
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| items | Gets the loaded child items in this collection. |
Methods
| add(name, reference, comment) | Adds a new name to the collection of the given scope. |
| add |
Adds a new name to the collection of the given scope using the user's locale for the formula. |
| get |
Gets the number of named items in the collection. |
| get |
Gets a |
| get |
Gets a |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
items
Gets the loaded child items in this collection.
readonly items: Excel.NamedItem[];Property Value
Method Details
add(name, reference, comment)
Adds a new name to the collection of the given scope.
add(name: string, reference: Range | string, comment?: string): Excel.NamedItem;Parameters
- name
-
string
The name of the named item.
- reference
-
Excel.Range | string
The formula or the range that the name will refer to.
- comment
-
string
Optional. The comment associated with the named item.
Returns
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const headerRange = sheet.getRange("A1:D1");
sheet.names.add("ExpensesHeader", headerRange);
const namedItems = sheet.names.load("name, type");
await context.sync();
});
addFormulaLocal(name, formula, comment)
Adds a new name to the collection of the given scope using the user's locale for the formula.
addFormulaLocal(name: string, formula: string, comment?: string): Excel.NamedItem;Parameters
- name
-
string
The name of the named item.
- formula
-
string
The formula in the user's locale that the name will refer to.
- comment
-
string
Optional. The comment associated with the named item.
Returns
Remarks
getCount()
Gets the number of named items in the collection.
getCount(): OfficeExtension.ClientResult<number>;Returns
OfficeExtension.ClientResult<number>
Remarks
getItem(name)
Gets a NamedItem object using its name.
getItem(name: string): Excel.NamedItem;Parameters
- name
-
string
Nameditem name.
Returns
Remarks
Examples
await Excel.run(async (context) => {
const sheetName = 'Sheet1';
const nameditem = context.workbook.names.getItem(sheetName);
nameditem.load('type');
await context.sync();
console.log(nameditem.type);
});
getItemOrNullObject(name)
Gets a NamedItem object using its name. If the object does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getItemOrNullObject(name: string): Excel.NamedItem;Parameters
- name
-
string
Nameditem name.
Returns
Remarks
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedItemCollection;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.NamedItemCollection;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
Examples
await Excel.run(async (context) => {
const nameditems = context.workbook.names;
nameditems.load('items');
await context.sync();
for (let i = 0; i < nameditems.items.length; i++) {
console.log(nameditems.items[i].name);
}
});
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NamedItemCollection;Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.NamedItemCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.NamedItemCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Excel.Interfaces.NamedItemCollectionData;