Office.AsyncResult interface

Objet qui encapsule le résultat d’une requête asynchrone, y compris les informations d’état et d’erreur quand la demande a échoué.An object which encapsulates the result of an asynchronous request, including status and error information if the request failed.

Remarks

HôtesHostsAccess, Excel, Outlook, PowerPoint, Project, WordAccess, Excel, Outlook, PowerPoint, Project, Word

Lorsque la fonction que vous passez à la callback paramètre d’une méthode « Async » s’exécute, elle reçoit un objet AsyncResult accessible à partir de la callback paramètre de la fonction.When the function you pass to the callback parameter of an "Async" method executes, it receives an AsyncResult object that you can access from the callback function's only parameter.

ExemplesExamples

// The following is an example applicable to content and task pane add-ins.
// The example shows a call to the getSelectedDataAsync method of the Document object.
Office.context.document.getSelectedDataAsync("text", {
        valueFormat: "unformatted",
        filterType: "all"
    },
    function (result) {
        if (result.status === "success") {
            var dataValue = result.value; // Get selected data.
            console.log('Selected data is ' + dataValue);
        } else {
            var err = result.error;
            console.log(err.name + ": " + err.message);
        }
    });
// The anonymous function passed as the callback argument ( function (result){...}) has a single 
// parameter named result that provides access to an AsyncResult object when the function executes.
// When the call to the getSelectedDataAsync method completes, the callback function executes, 
// and the following line of code accesses the value property of the AsyncResult object to 
// return the data selected in the document:
var dataValue = result.value;
// Note that other lines of code in the function use the result parameter of the callback function 
// to access the status and error properties of the AsyncResult object.

Properties

asyncContext

Obtient l’élément défini par l’utilisateur transmis à l’option asyncContext paramètre de la méthode appelée dans le même état telle qu’elle a été passé.Gets the user-defined item passed to the optional asyncContext parameter of the invoked method in the same state as it was passed in. Retourne l’élément défini par l’utilisateur (qui peut être de n’importe quel type de JavaScript : chaîne, nombre, booléen, objet, tableau, valeur Null ou Undefined) transmis à l’option asyncContext paramètre de la méthode appelée.This returns the user-defined item (which can be of any JavaScript type: String, Number, Boolean, Object, Array, Null, or Undefined) passed to the optional asyncContext parameter of the invoked method. Renvoie Undefined, si vous n’avez pas rien passez au paramètre asyncContext.Returns Undefined, if you didn't pass anything to the asyncContext parameter.

error

Obtient un objet Office.Error qui fournit une description de l’erreur, si une erreur se produit.Gets an Office.Error object that provides a description of the error, if any error occurred.

status

Obtient Office.AsyncResultStatus de l’opération asynchrone.Gets the Office.AsyncResultStatus of the asynchronous operation.

value

Obtient la charge utile ou le contenu de l’opération asynchrone, le cas échéant.Gets the payload or content of this asynchronous operation, if any.

Property Details

asyncContext

Obtient l’élément défini par l’utilisateur transmis à l’option asyncContext paramètre de la méthode appelée dans le même état telle qu’elle a été passé.Gets the user-defined item passed to the optional asyncContext parameter of the invoked method in the same state as it was passed in. Retourne l’élément défini par l’utilisateur (qui peut être de n’importe quel type de JavaScript : chaîne, nombre, booléen, objet, tableau, valeur Null ou Undefined) transmis à l’option asyncContext paramètre de la méthode appelée.This returns the user-defined item (which can be of any JavaScript type: String, Number, Boolean, Object, Array, Null, or Undefined) passed to the optional asyncContext parameter of the invoked method. Renvoie Undefined, si vous n’avez pas rien passez au paramètre asyncContext.Returns Undefined, if you didn't pass anything to the asyncContext parameter.

asyncContext: any;

Property Value

any

Remarks

Informations de prise en chargeSupport details

MAJUSCULE Y dans le tableau suivant indique que cette propriété est prise en charge dans l’application hôte Office correspondante.A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. Une cellule vide indique que l’application hôte Office ne prennent en charge cette énumération.An empty cell indicates that the Office host application doesn't support this enumeration.

Pour plus d’informations sur les exigences des applications et le serveur hôte Office, voir Configuration requise pour exécuter des compléments Office.For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Hôtes pris en charge par la plateformeSupported hosts, by platform

Office pour Bureau WindowsOffice for Windows desktop Office Online (dans un navigateur)Office Online (in browser) Office pour iPadOffice for iPad OWA pour périphériquesOWA for Devices Office pour MacOffice for Mac
Access Access vY
Excel Excel vY vY vY
Outlook Outlook vY vY vY vY
PowerPoint PowerPoint vY vY vY
Projet Project
Word Word vY vY vY

ExemplesExamples

function getDataWithContext() {
    var format = "Your data: ";
    Office.context.document.getSelectedDataAsync(
        Office.CoercionType.Text, 
        { asyncContext: format }, 
        showDataWithContext);
}

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

error

Obtient un objet Office.Error qui fournit une description de l’erreur, si une erreur se produit.Gets an Office.Error object that provides a description of the error, if any error occurred.

error: Office.Error;

Property Value

Remarks

Informations de prise en chargeSupport details

MAJUSCULE Y dans le tableau suivant indique que cette propriété est prise en charge dans l’application hôte Office correspondante.A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. Une cellule vide indique que l’application hôte Office ne prennent en charge cette énumération.An empty cell indicates that the Office host application doesn't support this enumeration.

Pour plus d’informations sur les exigences des applications et le serveur hôte Office, voir Configuration requise pour exécuter des compléments Office.For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Hôtes pris en charge par la plateformeSupported hosts, by platform

Office pour Bureau WindowsOffice for Windows desktop Office Online (dans un navigateur)Office Online (in browser) Office pour iPadOffice for iPad OWA pour périphériquesOWA for Devices Office pour MacOffice for Mac
Access Access vY
Excel Excel vY vY vY
Outlook Outlook vY vY vY vY
PowerPoint PowerPoint vY vY vY
Projet Project vY
Word Word vY vY vY

ExemplesExamples

function getData() {
    Office.context.document.getSelectedDataAsync(Office.CoercionType.Table, function(asyncResult) {
        if (asyncResult.status == Office.AsyncResultStatus.Failed) {
            write(asyncResult.error.message);
        }
        else {
            write(asyncResult.value);
        }
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

status

Obtient Office.AsyncResultStatus de l’opération asynchrone.Gets the Office.AsyncResultStatus of the asynchronous operation.

status: AsyncResultStatus;

Property Value

Remarks

Informations de prise en chargeSupport details

MAJUSCULE Y dans le tableau suivant indique que cette propriété est prise en charge dans l’application hôte Office correspondante.A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. Une cellule vide indique que l’application hôte Office ne prennent en charge cette énumération.An empty cell indicates that the Office host application doesn't support this enumeration.

Pour plus d’informations sur les exigences des applications et le serveur hôte Office, voir Configuration requise pour exécuter des compléments Office.For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Hôtes pris en charge par la plateformeSupported hosts, by platform

Office pour Bureau WindowsOffice for Windows desktop Office Online (dans un navigateur)Office Online (in browser) Office pour iPadOffice for iPad OWA pour périphériquesOWA for Devices Office pour MacOffice for Mac
Access Access vY
Excel Excel vY vY vY
Outlook Outlook vY vY vY vY
PowerPoint PowerPoint vY vY vY
Projet Project vY
Word Word vY vY vY

ExemplesExamples

function getData() {
    Office.context.document.getSelectedDataAsync(Office.CoercionType.Table, function(asyncResult) {
        if (asyncResult.status == Office.AsyncResultStatus.Failed) {
            write(asyncResult.error.message);
        }
        else {
            write(asyncResult.value);
        }
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

value

Obtient la charge utile ou le contenu de l’opération asynchrone, le cas échéant.Gets the payload or content of this asynchronous operation, if any.

value: T;

Property Value

T

Remarks

Vous accédez à l’objet AsyncResult dans la fonction passée comme argument au paramètre callback d’une méthode « Async », telles que la getSelectedDataAsync et setSelectedDataAsync méthodes de l’objet Document .You access the AsyncResult object in the function passed as the argument to the callback parameter of an "Async" method, such as the getSelectedDataAsync and setSelectedDataAsync methods of the Document object.

Remarque : Ce que la propriété value renvoie pour un particulier « Async » méthode varie en fonction de l’objectif et le contexte de cette méthode.Note: What the value property returns for a particular "Async" method varies depending on the purpose and context of that method. Pour déterminer ce qui est renvoyé par la propriété value pour une méthode « Async », reportez-vous à la section « Valeur de rappel » de la rubrique de la méthode.To determine what is returned by the value property for an "Async" method, refer to the "Callback value" section of the method's topic.

Informations de prise en chargeSupport details

MAJUSCULE Y dans le tableau suivant indique que cette propriété est prise en charge dans l’application hôte Office correspondante.A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. Une cellule vide indique que l’application hôte Office ne prennent en charge cette énumération.An empty cell indicates that the Office host application doesn't support this enumeration.

Pour plus d’informations sur les exigences des applications et le serveur hôte Office, voir Configuration requise pour exécuter des compléments Office.For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Hôtes pris en charge par la plateformeSupported hosts, by platform

Office pour Bureau WindowsOffice for Windows desktop Office Online (dans un navigateur)Office Online (in browser) Office pour iPadOffice for iPad OWA pour périphériquesOWA for Devices Office pour MacOffice for Mac
Access Access vY
Excel Excel vY vY vY
Outlook Outlook vY vY vY vY
PowerPoint PowerPoint vY vY vY
Projet Project vY
Word Word vY vY vY

範例Examples

function getData() {
    Office.context.document.getSelectedDataAsync(Office.CoercionType.Table, function(asyncResult) {
        if (asyncResult.status == Office.AsyncResultStatus.Failed) {
            write(asyncResult.error.message);
        }
        else {
            write(asyncResult.value);
        }
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}