Excel.Interfaces.NamedItemLoadOptions interface

Представляет определенное имя для диапазона ячеек или значения. Имена могут быть примитивными именованными объектами (как показано в приведенном ниже типе), объектом-диапазоном или ссылкой на диапазон. Этот объект может использоваться для получения объекта диапазона, связанного с именами.

Комментарии

Набор 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