Поделиться через


Excel.NamedItemCollection class

Коллекция всех NamedItem объектов, входящих в книгу или лист, в зависимости от того, как она была достигнута.

Extends

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

items

Получает загруженные дочерние элементы в этой коллекции.

Методы

add(name, reference, comment)

Добавляет новое имя в определенную коллекцию.

addFormulaLocal(name, formula, comment)

Добавляет новое имя в определенную коллекцию, используя языковой стандарт пользователя для формулы.

getCount()

Получает количество именованных элементов в коллекции.

getItem(name)

Возвращает объект, NamedItem используя его имя.

getItemOrNullObject(name)

Возвращает объект, NamedItem используя его имя. Если объект не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.NamedItemCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.NamedItemCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Excel.NamedItem[];

Значение свойства

Сведения о методе

add(name, reference, comment)

Добавляет новое имя в определенную коллекцию.

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

Параметры

name

string

Имя именованного элемента.

reference

Excel.Range | string

Формула или диапазон, на который будет ссылаться имя.

comment

string

Необязательный параметр. Комментарий, связанный с именованным элементом.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.4 ]

Примеры

// 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)

Добавляет новое имя в определенную коллекцию, используя языковой стандарт пользователя для формулы.

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

Параметры

name

string

Имя именованного элемента.

formula

string

Формула на языке пользователя, на которую будет ссылаться имя.

comment

string

Необязательный параметр. Комментарий, связанный с именованным элементом.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.4 ]

getCount()

Получает количество именованных элементов в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.4 ]

getItem(name)

Возвращает объект, NamedItem используя его имя.

getItem(name: string): Excel.NamedItem;

Параметры

name

string

Nameitem name.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

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)

Возвращает объект, NamedItem используя его имя. Если объект не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(name: string): Excel.NamedItem;

Параметры

name

string

Nameitem name.

Возвращаемое значение

Комментарии

[ Набор API: ExcelApi 1.4 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

options

Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Примеры

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)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.NamedItemCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.NamedItemCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

toJSON(): Excel.Interfaces.NamedItemCollectionData;

Возвращаемое значение