Office.Error interface

Pacote:

office

Fornece informações específicas sobre um erro que ocorreu durante uma operação de dados assíncrona.

Comentários

O objeto Erro é acedido a partir do objeto AsyncResult que é devolvido na função transmitida como o argumento de chamada de retorno de uma operação de dados assíncrona, como o setSelectedDataAsync método do objeto Documento.

Propriedades

code	Obtém o código numérico do erro. Para obter uma lista de códigos de erro, veja JavaScript API for Office error codes (API javaScript para códigos de erro do Office).
message	Obtém uma descrição detalhada do erro.
name	Obtém o nome do erro.

Detalhes da propriedade

code

Obtém o código numérico do erro. Para obter uma lista de códigos de erro, veja JavaScript API for Office error codes (API javaScript para códigos de erro do Office).

code: number;

Valor da propriedade

number

Exemplos

// To cause an error to be thrown, select a table or a matrix, and then call the setText function.
function setText() {
    Office.context.document.setSelectedDataAsync("Hello World!",
        function (asyncResult) {
            if (asyncResult.status === "failed")
                const error = asyncResult.error;
            write(error.name + ": " + error.code + " - " + error.message);
        });
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

message

Obtém uma descrição detalhada do erro.

message: string;

Valor da propriedade

string

Exemplos

// To cause an error to be thrown, select a table or a matrix, and then call the setText function.
function setText() {
    Office.context.document.setSelectedDataAsync("Hello World!",
        function (asyncResult) {
            if (asyncResult.status === "failed")
                const error = asyncResult.error;
            write(error.name + ": " + error.message);
        });
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

name

Obtém o nome do erro.

name: string;

Valor da propriedade

string

Exemplos

// To cause an error to be thrown, select a table or a matrix, and then call the setText function.
function setText() {
    Office.context.document.setSelectedDataAsync("Hello World!",
        function (asyncResult) {
            if (asyncResult.status === "failed")
                const error = asyncResult.error;
            write(error.name + ": " + error.message);
        });
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}