Excel.NamedItemCollection class

属于工作簿或工作表的所有 NamedItem 对象的集合, 具体取决于它的访问方式。A collection of all the NamedItem objects that are part of the workbook or worksheet, depending on how it was reached.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

Extends

属性

context

与该对象关联的请求上下文。The request context associated with the object. 这会将加载项的进程连接到 Office 主机应用程序的进程。This connects the add-in's process to the Office host application's process.

items

获取此集合中已加载的子项。Gets the loaded child items in this collection.

方法

add(name, reference, comment)

将新名称添加到给定范围的集合。Adds a new name to the collection of the given scope.

[API 集: ExcelApi 1.4][ API set: ExcelApi 1.4 ]

addFormulaLocal(name, formula, comment)

使用用户的公式区域设置,将新名称添加到给定范围的集合。Adds a new name to the collection of the given scope using the user's locale for the formula.

[API 集: ExcelApi 1.4][ API set: ExcelApi 1.4 ]

getCount()

获取集合中已命名项的数量。Gets the number of named items in the collection.

[API 集: ExcelApi 1.4][ API set: ExcelApi 1.4 ]

getItem(name)

使用其名称获取 NamedItem 对象。Gets a NamedItem object using its name.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

getItemOrNullObject(name)

使用其名称获取 NamedItem 对象。Gets a NamedItem object using its name. 如果没有 NamedItem 对象,将返回 NULL 对象。If the nameditem object does not exist, will return a null object.

[API 集: ExcelApi 1.4][ API set: ExcelApi 1.4 ]

load(option)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性之前,你必须调用“context.sync()”。You must call "context.sync()" before reading the properties.

load(propertyNames)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

load(option)
toJSON()

重写 JavaScript toJSON()方法, 以便在将 API 对象传递到时提供更有用的输出JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify反过来, 也会调用传递toJSON给它的对象的方法。尽管原始Excel.NamedItemCollection对象是 API 对象, 但toJSON方法返回一个无格式的 JavaScript 对象 (类型为Excel.Interfaces.NamedItemCollectionData, in turn, calls the toJSON method of the object that is 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), 其中包含集合的项中所有加载属性的浅表副本的 "items" 数组。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

属性详细信息

context

与该对象关联的请求上下文。The request context associated with the object. 这会将加载项的进程连接到 Office 主机应用程序的进程。This connects the add-in's process to the Office host application's process.

context: RequestContext;

属性值

RequestContext

items

获取此集合中已加载的子项。Gets the loaded child items in this collection.

readonly items: Excel.NamedItem[];

属性值

Excel.NamedItem[]

方法详细信息

add(name, reference, comment)

将新名称添加到给定范围的集合。Adds a new name to the collection of the given scope.

[API 集: ExcelApi 1.4][ API set: ExcelApi 1.4 ]

add(name: string, reference: Range | string, comment?: string): Excel.NamedItem;

参数

name
string

已命名项目的名称。The name of the named item.

reference
Range | string

名称将引用的公式或区域。The formula or the range that the name will refer to.

comment
string

可选。Optional. 与已命名项目相关联的注释。The comment associated with the named item.

返回

示例Examples

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.

[API 集: ExcelApi 1.4][ API set: ExcelApi 1.4 ]

addFormulaLocal(name: string, formula: string, comment?: string): Excel.NamedItem;

参数

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.

返回

getCount()

获取集合中已命名项的数量。Gets the number of named items in the collection.

[API 集: ExcelApi 1.4][ API set: ExcelApi 1.4 ]

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

getItem(name)

使用其名称获取 NamedItem 对象。Gets a NamedItem object using its name.

[API 集: ExcelApi 1.1][ API set: ExcelApi 1.1 ]

getItem(name: string): Excel.NamedItem;

参数

name
string

Nameditem 名称。Nameditem name.

返回

示例Examples

Excel.run(function (ctx) { 
    var sheetName = 'Sheet1';
    var nameditem = ctx.workbook.names.getItem(sheetName);
    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));
    }
});

getItemOrNullObject(name)

使用其名称获取 NamedItem 对象。Gets a NamedItem object using its name. 如果没有 NamedItem 对象,将返回 NULL 对象。If the nameditem object does not exist, will return a null object.

[API 集: ExcelApi 1.4][ API set: ExcelApi 1.4 ]

getItemOrNullObject(name: string): Excel.NamedItem;

参数

name
string

Nameditem 名称。Nameditem name.

返回

load(option)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性之前,你必须调用“context.sync()”。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedItemCollection;

参数

option
Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

返回

注解

除了此签名之外, 此方法还具有以下签名:In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.NamedItemCollection-Where 选项是一个逗号分隔的字符串或一个字符串数组, 用于指定要加载的属性。load(option?: string | string[]): Excel.NamedItemCollection - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.NamedItemCollection-Where 选项。选择是一个用逗号分隔的字符串, 用于指定要加载的属性和选项。 expand 是一个用逗号分隔的字符串, 用于指定要加载的导航属性。load(option?: { select?: string; expand?: string; }): Excel.NamedItemCollection - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.NamedItemCollection-仅适用于集合类型。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.NamedItemCollection - Only available on collection types. 它类似于前面的签名。It is similar to the preceding signature. top 指定结果中可包含的集合项的最大数量。Option.top specifies the maximum number of collection items that can be included in the result. 选项。 skip 指定要跳过且不包含在结果中的项目数。Option.skip specifies the number of items that are to be skipped and not included in the result. 如果指定了 top 选项, 则在跳过指定数目的项目后将启动结果集。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.NamedItemCollection;

参数

propertyNames
string | string[]

一个以逗号分隔的字符串或字符串数组, 用于指定要加载的属性。A comma-delimited string or an array of strings that specify the properties to load.

返回

示例Examples

Excel.run(function (ctx) { 
    var nameditems = ctx.workbook.names;
    nameditems.load('items');
    return ctx.sync().then(function() {
        for (var i = 0; i < nameditems.items.length; i++)
        {
            console.log(nameditems.items[i].name);
            console.log(nameditems.items[i].index);
        }
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(option)

load(option?: OfficeExtension.LoadOption): Excel.NamedItemCollection;

参数

返回

toJSON()

重写 JavaScript toJSON()方法, 以便在将 API 对象传递到时提供更有用的输出JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify反过来, 也会调用传递toJSON给它的对象的方法。尽管原始Excel.NamedItemCollection对象是 API 对象, 但toJSON方法返回一个无格式的 JavaScript 对象 (类型为Excel.Interfaces.NamedItemCollectionData, in turn, calls the toJSON method of the object that is 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), 其中包含集合的项中所有加载属性的浅表副本的 "items" 数组。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.NamedItemCollectionData;

返回