Excel.Interfaces.NamedItemCollectionLoadOptions interface

Набор всех NamedItem объектов, являющихся частью книги или листа, в зависимости от способа возникновения.

Комментарии

Набор API: ExcelApi 1.1

Используется

Свойства

$all

Указание $all параметров загрузки загружает все скалярные свойства (такие как ), но не навигационные свойства (такие какRange.addressRange.format.fill.color ).

arrayValues

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Возвращает объект, содержащий значения и типы именованного элемента.

comment

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Указывает комментарий, связанный с этим именем.

formula

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Формула именованного элемента. Формулы всегда начинаются со знака равенства ("=").

name

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Имя объекта.

scope

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Указывает, ограничено ли имя книгой или определенным листом. Возможные значения: Лист, Книга.

type

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Указывает тип значения, возвращаемого формулой имени. См. Excel.NamedItemType дополнительные сведения.

value

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Представляет значение, вычисленное с помощью формулы имени. Для именованного диапазона он вернет адрес диапазона. Этот API возвращает #VALUE! в пользовательском интерфейсе Excel, если он ссылается на пользовательскую функцию.

valueAsJson

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: JSON-представление значений в этом именованном элементе. В отличие от , NamedItem.valueNamedItem.valueAsJson поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения, заданном пользователем, используйте NamedItem.valueAsJsonLocal.

valueAsJsonLocal

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: JSON-представление значений в этом именованном элементе. В отличие от , NamedItem.valueNamedItem.valueAsJsonLocal поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту отображения, выбранному пользователем. Для получения данных, не зависящих от языкового стандарта, используйте NamedItem.valueAsJson.

visible

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Указывает, является ли объект видимым.

worksheet

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Возвращает лист, областью действия которого является именованный элемент. Возникает ошибка, если область элемента ограничена книгой.

worksheetOrNullObject

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Возвращает лист, областью которого ограничен именованный элемент. Если вместо этого элемент ограничен книгой, этот метод возвращает объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

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

$all

Указание $all параметров загрузки загружает все скалярные свойства (такие как ), но не навигационные свойства (такие какRange.addressRange.format.fill.color ).

$all?: boolean;

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

boolean

arrayValues

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Возвращает объект, содержащий значения и типы именованного элемента.

arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;

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

Комментарии

Набор API: ExcelApi 1.7

comment

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Указывает комментарий, связанный с этим именем.

comment?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.4

formula

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Формула именованного элемента. Формулы всегда начинаются со знака равенства ("=").

formula?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.7

name

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Имя объекта.

name?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

scope

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Указывает, ограничено ли имя книгой или определенным листом. Возможные значения: Лист, Книга.

scope?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.4

type

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Указывает тип значения, возвращаемого формулой имени. См. Excel.NamedItemType дополнительные сведения.

type?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 для массива

value

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Представляет значение, вычисленное с помощью формулы имени. Для именованного диапазона он вернет адрес диапазона. Этот API возвращает #VALUE! в пользовательском интерфейсе Excel, если он ссылается на пользовательскую функцию.

value?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

valueAsJson

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: JSON-представление значений в этом именованном элементе. В отличие от , NamedItem.valueNamedItem.valueAsJson поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения, заданном пользователем, используйте NamedItem.valueAsJsonLocal.

valueAsJson?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.16

valueAsJsonLocal

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: JSON-представление значений в этом именованном элементе. В отличие от , NamedItem.valueNamedItem.valueAsJsonLocal поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту отображения, выбранному пользователем. Для получения данных, не зависящих от языкового стандарта, используйте NamedItem.valueAsJson.

valueAsJsonLocal?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.16

visible

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Указывает, является ли объект видимым.

visible?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

worksheet

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Возвращает лист, областью действия которого является именованный элемент. Возникает ошибка, если область элемента ограничена книгой.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

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

Комментарии

Набор API: ExcelApi 1.4

worksheetOrNullObject

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Возвращает лист, областью которого ограничен именованный элемент. Если вместо этого элемент ограничен книгой, этот метод возвращает объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

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

Комментарии

Набор API: ExcelApi 1.4