Excel.Interfaces.NamedItemCollectionLoadOptions interface

Пакет:

excel

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

$all	Указание $all для параметров загрузки загружает все скалярные свойства (например,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 для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).

$all?: boolean;

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

boolean

arrayValues

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

arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;

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

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;

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

Excel.Interfaces.WorksheetLoadOptions

Комментарии

[ Набор API: ExcelApi 1.4 ]

worksheetOrNullObject

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

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

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

Excel.Interfaces.WorksheetLoadOptions

Комментарии

[ Набор API: ExcelApi 1.4 ]