Excel.FunctionResult class

Пакет:

excel

Объект , содержащий результат операции вычисления функции.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.2 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
error	Значение ошибки (например, "#DIV/0"), представляющее ошибку. Если строка ошибки не задана, функция выполнена успешно, а ее результат записывается в поле Значение. Ошибка всегда находится в английском языковом стандарте.
value	Значение вычисления функции. Поле значения будет заполнено только в том случае, если ошибка не произошла (т. е. свойство Error не задано).

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

error

Значение ошибки (например, "#DIV/0"), представляющее ошибку. Если строка ошибки не задана, функция выполнена успешно, а ее результат записывается в поле Значение. Ошибка всегда находится в английском языковом стандарте.

readonly error: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.2 ]

value

Значение вычисления функции. Поле значения будет заполнено только в том случае, если ошибка не произошла (т. е. свойство Error не задано).

readonly value: T;

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

T

Комментарии

[ Набор API: ExcelApi 1.2 ]

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

load(options)

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

load(options?: Excel.Interfaces.FunctionResultLoadOptions): FunctionResult<T>;

Параметры

options

Excel.Interfaces.FunctionResultLoadOptions

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

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

Excel.FunctionResult<T>

load(propertyNames)

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

load(propertyNames?: string | string[]): FunctionResult<T>;

Параметры

propertyNames

string | string[]

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

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

Excel.FunctionResult<T>

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): FunctionResult<T>;

Параметры

propertyNamesAndPaths

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

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

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

Excel.FunctionResult<T>

toJSON()

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

toJSON(): Interfaces.FunctionResultData<T>;

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

Excel.Interfaces.FunctionResultData<T>