AsyncResult.value property (apps for Office)
Published: February 26, 2013
Gets the payload or content of this asynchronous operation, if any.
var dataValue = asyncResult.value;
Returns the value of the request at the time the asynchronous call was made.
Note
|
|---|
|
What the value property returns for a particular "Async" method varies depending on the purpose and context of that method. To determine what is returned by the value property for an "Async" method, refer to the "Callback value" section of the method's topic. For a complete listing of the "Async" methods, see the Remarks section of the AsyncResult object topic. |
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.
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; }
|
Supported clients |
Excel 2013, Excel Web App, Word 2013, and Project 2013 |
|
Library |
Office.js |
|
Namespace |
Office |
