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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

error

Valor de erro (como "#DIV/0") que representa o erro. Se a cadeia de erros não estiver definida, a função terá êxito e seu resultado será gravado no campo Valor. O erro está sempre na localidade em inglês.

value

O valor da avaliação da função. O campo valor será preenchido somente se nenhum erro tiver ocorrido (ou seja, a propriedade Error 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original FunctionResult<T> é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Interfaces.FunctionResultData<T>) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

error

Valor de erro (como "#DIV/0") que representa o erro. Se a cadeia de erros não estiver definida, a função terá êxito e seu resultado será gravado no campo Valor. O erro está sempre na localidade 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 valor será preenchido somente se nenhum erro tiver ocorrido (ou seja, a propriedade Error 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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

toJSON()

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

toJSON(): Interfaces.FunctionResultData<T>;

Retornos