Excel.FunctionResult class

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

Extends

Комментарии

Набор API: ExcelApi 1.2

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

Свойства

context

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

error

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

value

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

Методы

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;

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

error

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

readonly error: string;

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

string

Комментарии

Набор API: ExcelApi 1.2

value

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

readonly value: T;

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

T

Комментарии

Набор API: ExcelApi 1.2

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

load(options)

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

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

Параметры

options
Excel.Interfaces.FunctionResultLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

toJSON()

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

toJSON(): Interfaces.FunctionResultData<T>;

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