Excel.NamedItemArrayValues class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi 1.7

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

• Excel.NamedItem: arrayValues

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
types	Представляет типы для каждого элемента в массиве именованных элементов
values	Представляет значения каждого элемента в массиве именованных элементов.
valuesAsJson	JSON-представление значений в этом именованном массиве элементов. В отличие от , NamedItemArrayValues.valuesNamedItemArrayValues.valuesAsJson поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения, заданном пользователем, используйте NamedItemArrayValues.valuesAsJsonLocal.
valuesAsJsonLocal	JSON-представление значений в этом именованном массиве элементов. В отличие от , NamedItemArrayValues.valuesNamedItemArrayValues.valuesAsJsonLocal поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту отображения, выбранному пользователем. Для получения данных, не зависящих от языкового стандарта, используйте NamedItemArrayValues.valuesAsJson.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.NamedItemArrayValues объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.NamedItemArrayValuesData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

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

context

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

context: RequestContext;

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

Excel.RequestContext

types

Представляет типы для каждого элемента в массиве именованных элементов

readonly types: Excel.RangeValueType[][];

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

Excel.RangeValueType[][]

Комментарии

Набор API: ExcelApi 1.7

values

Представляет значения каждого элемента в массиве именованных элементов.

readonly values: any[][];

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

any[][]

Комментарии

Набор API: ExcelApi 1.7

valuesAsJson

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

readonly valuesAsJson: CellValue[][];

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

Excel.CellValue[][]

Комментарии

Набор API: ExcelApi 1.16

valuesAsJsonLocal

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

readonly valuesAsJsonLocal: CellValue[][];

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

Excel.CellValue[][]

Комментарии

Набор API: ExcelApi 1.16

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

load(options)

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

load(options?: Excel.Interfaces.NamedItemArrayValuesLoadOptions): Excel.NamedItemArrayValues;

Параметры

options

Excel.Interfaces.NamedItemArrayValuesLoadOptions

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

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

Excel.NamedItemArrayValues

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.NamedItemArrayValues

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.NamedItemArrayValues;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

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

Excel.NamedItemArrayValues

toJSON()

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

toJSON(): Excel.Interfaces.NamedItemArrayValuesData;

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

Excel.Interfaces.NamedItemArrayValuesData