OfficeExtension.Error class

Paquet:

office

Objet d’erreur retourné par context.sync(), si une promesse est rejetée en raison d’une erreur lors du traitement de la demande.

Propriétés

code	Chaîne de code d’erreur, telle que « InvalidArgument ».
debugInfo	Informations de débogage (utiles pour la journalisation détaillée de l’erreur, par exemple via JSON.stringify(...)).
innerError	Erreur interne, le cas échéant.
message	Message d’erreur transmis à partir de l’application Office.
name	Nom de l’erreur : « OfficeExtension.Error ».
stack	Trace de pile, le cas échéant.
traceMessages	Tracez les messages (le cas échéant) qui ont été ajoutés via un context.trace() appel avant d’appeler context.sync(). En cas d’erreur, il contient tous les messages de trace qui ont été exécutés avant que l’erreur ne se produise. Ces messages peuvent vous aider à surveiller la séquence d’exécution du programme et à détecter le cas de l’erreur.

Détails de la propriété

code

Chaîne de code d’erreur, telle que « InvalidArgument ».

code: string;

Valeur de propriété

string

debugInfo

Informations de débogage (utiles pour la journalisation détaillée de l’erreur, par exemple via JSON.stringify(...)).

debugInfo: DebugInfo;

Valeur de propriété

OfficeExtension.DebugInfo

innerError

Erreur interne, le cas échéant.

innerError: Error;

Valeur de propriété

OfficeExtension.Error

message

Message d’erreur transmis à partir de l’application Office.

message: string;

Valeur de propriété

string

name

Nom de l’erreur : « OfficeExtension.Error ».

name: string;

Valeur de propriété

string

stack

Trace de pile, le cas échéant.

stack: string;

Valeur de propriété

string

traceMessages

Tracez les messages (le cas échéant) qui ont été ajoutés via un context.trace() appel avant d’appeler context.sync(). En cas d’erreur, il contient tous les messages de trace qui ont été exécutés avant que l’erreur ne se produise. Ces messages peuvent vous aider à surveiller la séquence d’exécution du programme et à détecter le cas de l’erreur.

traceMessages: string[];

Valeur de propriété

string[]

Exemples

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