OfficeExtension.Error class

El objeto de error devuelto por context.sync(), si se rechaza una promesa debido a un error durante el procesamiento de la solicitud.

Propiedades

code

Cadena de código de error, como "InvalidArgument".

debugInfo

Información de depuración (útil para el registro detallado del error, es decir, a través JSON.stringify(...)de ).

innerError

Error interno, si procede.

message

El mensaje de error pasó desde la aplicación de Office.

name

Nombre del error: "OfficeExtension.Error".

stack

Seguimiento de la pila, si procede.

traceMessages

Rastrear mensajes (si los hubiera) que se agregaron mediante una context.trace() invocación antes de llamar context.sync(). Si se produjo un error, contiene todos los mensajes de seguimiento que se ejecutaron antes de que se produjera el error. Estos mensajes pueden ayudarle a supervisar la secuencia de ejecución del programa y a detectar mayúsculas y minúsculas.

Detalles de las propiedades

code

Cadena de código de error, como "InvalidArgument".

code: string;

Valor de propiedad

string

debugInfo

Información de depuración (útil para el registro detallado del error, es decir, a través JSON.stringify(...)de ).

debugInfo: DebugInfo;

Valor de propiedad

innerError

Error interno, si procede.

innerError: Error;

Valor de propiedad

message

El mensaje de error pasó desde la aplicación de Office.

message: string;

Valor de propiedad

string

name

Nombre del error: "OfficeExtension.Error".

name: string;

Valor de propiedad

string

stack

Seguimiento de la pila, si procede.

stack: string;

Valor de propiedad

string

traceMessages

Rastrear mensajes (si los hubiera) que se agregaron mediante una context.trace() invocación antes de llamar context.sync(). Si se produjo un error, contiene todos los mensajes de seguimiento que se ejecutaron antes de que se produjera el error. Estos mensajes pueden ayudarle a supervisar la secuencia de ejecución del programa y a detectar mayúsculas y minúsculas.

traceMessages: string[];

Valor de propiedad

string[]

Ejemplos

// 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"