Skip to main content

UpdateAttribute

Updates the value of an existing attribute in the custom XML node. If the attribute doesn't exist, the update will not occur.

Syntax

expression.UpdateAttribute(name, value);

expression - A variable that represents a ApiCustomXmlNode class.

Parameters

NameRequired/OptionalData typeDefaultDescription
nameRequiredstringThe name of the attribute to update.
valueRequiredstringThe new value to assign to the attribute.

Returns

boolean

Example

Update the value of an existing attribute in a custom XML node in a spreadsheet.

// How do I update attribute in a spreadsheet?

// Update attribute using a custom XML node object in a spreadsheet.

const worksheet = Api.GetActiveSheet();
const xmlManager = worksheet.GetCustomXmlParts();
const xmlString = `
<bookstore>
<book category='fiction'>
<title>The Odyssey</title>
</book>
</bookstore>`;
const xml = xmlManager.Add(xmlString);
const bookNode = xml.GetNodes('/bookstore/book')[0];

bookNode.UpdateAttribute('category', 'ancient');

const attributes = bookNode.GetAttributes();
worksheet.GetRange('A1').SetValue('Updated attribute: ' + attributes[0].name + '=' + attributes[0].value);