OfficeExtension.Error class

Pacote:

office

O objeto de erro retornado por context.sync(), se uma promessa for rejeitada devido a um erro durante o processamento da solicitação.

Propriedades

code	Cadeia de caracteres de código de erro, como "InvalidArgument".
debugInfo	Informações de depuração (úteis para log detalhado do erro, ou seja, via JSON.stringify(...)).
innerError	Erro interno, se aplicável.
message	A mensagem de erro passada do aplicativo do Office.
name	Nome do erro: "OfficeExtension.Error".
stack	Rastreamento de pilha, se aplicável.
traceMessages	Rastrear mensagens (se houver) que foram adicionadas por meio de uma context.trace() invocação antes de chamar context.sync(). Se houve um erro, isso contém todas as mensagens de rastreamento que foram executadas antes do erro ocorrer. Essas mensagens podem ajudá-lo a monitorar a sequência de execução do programa e detectar o caso do erro.

Detalhes da propriedade

code

Cadeia de caracteres de código de erro, como "InvalidArgument".

code: string;

Valor da propriedade

string

debugInfo

Informações de depuração (úteis para log detalhado do erro, ou seja, via JSON.stringify(...)).

debugInfo: DebugInfo;

Valor da propriedade

OfficeExtension.DebugInfo

innerError

Erro interno, se aplicável.

innerError: Error;

Valor da propriedade

OfficeExtension.Error

message

A mensagem de erro passada do aplicativo do Office.

message: string;

Valor da propriedade

string

name

Nome do erro: "OfficeExtension.Error".

name: string;

Valor da propriedade

string

stack

Rastreamento de pilha, se aplicável.

stack: string;

Valor da propriedade

string

traceMessages

Rastrear mensagens (se houver) que foram adicionadas por meio de uma context.trace() invocação antes de chamar context.sync(). Se houve um erro, isso contém todas as mensagens de rastreamento que foram executadas antes do erro ocorrer. Essas mensagens podem ajudá-lo a monitorar a sequência de execução do programa e detectar o caso do erro.

traceMessages: string[];

Valor da propriedade

string[]

Exemplos

// The following example shows how you can instrument a batch of commands
// to determine where an error occurred. The first batch successfully
// inserts the first two paragraphs into the document and cause no errors.
// The second batch successfully inserts the third and fourth paragraphs
// but fails in the call to insert the fifth paragraph. All other commands
// after the failed command in the batch are not executed, including the
// command that adds the fifth trace message. In this case, the error
// occurred after the fourth paragraph was inserted, and before adding the
// fifth trace message.

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the document body.
    const body = context.document.body;

    // Queue a command to insert the paragraph at the end of the document body.
    // Start a batch of commands.
    body.insertParagraph('1st paragraph', Word.InsertLocation.end);
    // Queue a command for instrumenting this part of the batch.
    context.trace('1st paragraph successful');

    body.insertParagraph('2nd paragraph', Word.InsertLocation.end);
    context.trace('2nd paragraph successful');

    // Synchronize the document state by executing the queued-up commands,
    // and return a promise to indicate task completion.
    await context.sync();

    // Queue a command to insert the paragraph at the end of the document body.
    // Start a new batch of commands.
    body.insertParagraph('3rd paragraph', Word.InsertLocation.end);
    context.trace('3rd paragraph successful');

    body.insertParagraph('4th paragraph', Word.InsertLocation.end);
    context.trace('4th paragraph successful');

    // This command will cause an error. The trace messages in the queue up to
    // this point will be available via Error.traceMessages.
    body.insertParagraph(0, '5th paragraph', Word.InsertLocation.end);
    // Queue a command for instrumenting this part of the batch.
    // This trace message will not be set on Error.traceMessages.
    context.trace('5th paragraph successful');
    await context.sync();
}).catch(function (error) {
    if (error instanceof OfficeExtension.Error) {
        console.log('Trace messages: ' + error.traceMessages);
    }
});

// Output: "Trace messages: 3rd paragraph successful,4th paragraph successful"