Class Attribute

Spark icon

AI-generated Key Takeaways

An Attribute object represents an XML attribute and is used in conjunction with XmlService.
Attributes have methods to get and set their name, namespace, and value.
The provided example demonstrates how to parse XML, retrieve attributes, and add a new attribute with a combined value.

Attribute

A representation of an XML attribute.

// Reads the first and last name of each person and adds a new attribute with
// the full name.
letxml='<roster>'+
'<person first="John" last="Doe"/>'+
'<person first="Mary" last="Smith"/>'+
'</roster>';
constdocument=XmlService.parse(xml);
constpeople=document.getRootElement().getChildren('person');
for(leti=0;i < people.length;i++){
constperson=people[i];
constfirstName=person.getAttribute('first').getValue();
constlastName=person.getAttribute('last').getValue();
person.setAttribute('full',`${firstName}${lastName}`);
}
xml=XmlService.getPrettyFormat().format(document);
Logger.log(xml);

Methods

Method	Return type	Brief description
`getName()`	`String`	Gets the local name of the attribute.
`getNamespace()`	`Namespace`	Gets the namespace for the attribute.
`getValue()`	`String`	Gets the value of the attribute.
`setName(name)`	`Attribute`	Sets the local name of the attribute.
`setNamespace(namespace)`	`Attribute`	Sets the namespace for the attribute.
`setValue(value)`	`Attribute`	Sets the value of the attribute.

Detailed documentation

`getName()`

Gets the local name of the attribute. If the attribute has a namespace prefix, use getNamespace() .getPrefix() to get the prefix.

Return

String — the local name of the attribute

`getNamespace()`

Gets the namespace for the attribute.

Return

Namespace — the namespace for the attribute

`getValue()`

Gets the value of the attribute.

Return

String — the value of the attribute

`setName(name)`

Sets the local name of the attribute. To set a namespace prefix for the attribute, use setNamespace(namespace) in conjunction with XmlService.getNamespace(prefix, uri) .

Parameters

Name	Type	Description
`name`	`String`	the local name to set

Return

Attribute — the attribute, for chaining

`setNamespace(namespace)`

Sets the namespace for the attribute. The namespace must have a prefix.

Parameters

Name	Type	Description
`namespace`	`Namespace`	the namespace to set

Return

Attribute — the attribute, for chaining

`setValue(value)`

Sets the value of the attribute.

Parameters

Name	Type	Description
`value`	`String`	the value to set

Return

Attribute — the attribute, for chaining

Class Attribute Stay organized with collections Save and categorize content based on your preferences.

AI-generated Key Takeaways

Methods

Detailed documentation

getName()

Return

getNamespace()

Return

getValue()

Return

setName(name)

Parameters

Return

setNamespace(namespace)

Parameters

Return

setValue(value)

Parameters

Return

Class Attribute

`getName()`

`getNamespace()`

`getValue()`

`setName(name)`

`setNamespace(namespace)`

`setValue(value)`