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


Excel.Interfaces.NamedItemLoadOptions interface

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

$all

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

arrayValues

Возвращает объект, содержащий значения и типы именованного элемента.

comment

Указывает комментарий, связанный с этим именем.

formula

Формула именованного элемента. Формулы всегда начинаются со знака равенства ("=").

name

Имя объекта.

scope

Указывает, имеет ли имя область действия книги или определенного листа. Возможные значения: Лист, Книга.

type

Указывает тип значения, возвращаемого формулой имени. Дополнительные сведения см. в этой Excel.NamedItemType статье.

value

Представляет значение, вычисленное по формуле имени. Для именованного диапазона он вернет адрес диапазона. Этот API возвращает #VALUE! ошибка в пользовательском интерфейсе Excel, если она ссылается на определяемую пользователем функцию.

valueAsJson

Представление значений в этом именованном элементе в формате JSON. В отличие от NamedItem.valueподдерживает NamedItem.valueAsJson все типы данных, которые могут находиться в ячейке. Примеры включают форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения пользователя, используйте .NamedItem.valueAsJsonLocal

valueAsJsonLocal

Представление значений в этом именованном элементе в формате JSON. В отличие от NamedItem.valueподдерживает NamedItem.valueAsJsonLocal все типы данных, которые могут находиться в ячейке. Примеры включают форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту отображения пользователя. Чтобы получить данные, не зависящие от языкового стандарта, используйте .NamedItem.valueAsJson

visible

Указывает, является ли объект видимым.

worksheet

Возвращает лист, к которому относится именованный элемент. Выдает ошибку, если элемент ограничен книгой.

worksheetOrNullObject

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

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

$all

Указание $all для LoadOptions загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.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 для String,Integer,Double,Boolean,Range,Error; 1.7 для массива ]

value

Представляет значение, вычисленное по формуле имени. Для именованного диапазона он вернет адрес диапазона. Этот API возвращает #VALUE! ошибка в пользовательском интерфейсе Excel, если она ссылается на определяемую пользователем функцию.

value?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

valueAsJson

Представление значений в этом именованном элементе в формате JSON. В отличие от NamedItem.valueподдерживает NamedItem.valueAsJson все типы данных, которые могут находиться в ячейке. Примеры включают форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения пользователя, используйте .NamedItem.valueAsJsonLocal

valueAsJson?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.16 ]

valueAsJsonLocal

Представление значений в этом именованном элементе в формате JSON. В отличие от NamedItem.valueподдерживает NamedItem.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

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

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

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

Комментарии

[ Набор API: ExcelApi 1.4 ]