CustomXmlNode.setXmlAsync method
Sets the XML of the node.
customXmlNodeObj.setXmlAsync(XML, [options ,]callback);
Parameters
| Name |
Type |
Description |
Support notes |
| XML |
string |
The XML for the subtree to be added. Required. |
|
| options |
object |
Specifies any of the following optional parameters |
|
| asyncContext |
array, boolean, null, number, object, string, or undefined |
A user-defined item of any type that is returned in the AsyncResult object without being altered. |
|
| callback |
object |
A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. |
|
Callback Value
When the function you passed to the callback parameter executes, it receives an AsyncResult object that you can access from the callback function's only parameter.
In the callback function passed to the setXmlAsync method, you can use the properties of the AsyncResult object to return the following information.
Example
function setXmlNodeInnerXml() {
Office.context.document.customXmlParts.getByIdAsync("{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
var xmlPart = result.value;
xmlPart.getNodesAsync('*', function (nodeResults) {
for (i = 0; i < nodeResults.value.length; i++) {
var node = nodeResults.value[i];
node.setXmlAsync("<childNode>" + i + "</childNode>");
}
});
});
}
Support details
A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
For more information about Office host application and server requirements, see Requirements for running Office Add-ins.
|
Office for Windows desktop |
Office Online (in browser) |
Office for iPad |
| Word |
Y |
Y |
Y |
|
|
| Available in requirement sets |
CustomXmlParts |
| Minimum permission level |
ReadWriteDocument |
| Add-in types |
Task pane |
| Library |
Office.js |
| Namespace |
Office |
Support history
| Version |
Changes |
| 1.1 |
Added support for Word in Office for iPad. |
| 1.0 |
Introduced |