InsertElement
Inserts an XML element at the specified XPath.
Syntax
expression.InsertElement(xPath, xmlStr, index);
expression - A variable that represents a ApiCustomXmlPart class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| xPath | Required | string | The XPath of the parent node where the new element will be inserted. | |
| xmlStr | Required | string | The XML string to insert. | |
| index | Optional | number | The position at which to insert the new XML element. If omitted, the element will be appended as the last child. |
Returns
boolean
Example
Add a child element to an existing XML structure stored in a spreadsheet.
// How do I nest a new node inside an XML block already saved in a spreadsheet?
// Expand stored XML data by appending a new element at a chosen location in a spreadsheet.
const worksheet = Api.GetActiveSheet();
const xmlManager = worksheet.GetCustomXmlParts();
const xmlString = "<content version='9.4' />";
const xml = xmlManager.Add(xmlString);
xml.InsertElement('/content', '<text>lorem</text>');
worksheet.GetRange('A1').SetValue('XML after insertion:');
worksheet.GetRange('A2').SetValue(xml.GetXml());