Compartilhar via


Excel.FunctionResult class

Um objeto que contém o resultado de uma operação de avaliação de funções

Extends

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

Propriedades

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

error

Valor de erro (como "#DIV/0") que representa o erro. Se a cadeia de erro não estiver definida, a função foi bem-sucedida e o resultado será escrito no campo Valor. O erro está sempre na região em inglês.

value

O valor da avaliação da função. O campo de valor só será preenchido se não tiver ocorrido nenhum erro (ou seja, a propriedade Erro não está definida).

Métodos

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original FunctionResult<T> é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Interfaces.FunctionResultData<T>) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

error

Valor de erro (como "#DIV/0") que representa o erro. Se a cadeia de erro não estiver definida, a função foi bem-sucedida e o resultado será escrito no campo Valor. O erro está sempre na região em inglês.

readonly error: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

value

O valor da avaliação da função. O campo de valor só será preenchido se não tiver ocorrido nenhum erro (ou seja, a propriedade Erro não está definida).

readonly value: T;

Valor da propriedade

T

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

Detalhes do método

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options
Excel.Interfaces.FunctionResultLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original FunctionResult<T> é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Interfaces.FunctionResultData<T>) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Interfaces.FunctionResultData<T>;

Retornos