Document.createAttribute(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description

Creates an attribute node of type ATTRIBUTE_NODE with the optional specified value and returns the new xml.Attr object.

The localName, prefix, and namespaceURI properties of the new node are set to null.

Returns

xml.Attr

Supported Script Types

Client and server scripts

For more information, see SuiteScript 2.x Script Types.

Governance

None

Module

N/xml Module

Since

2015.2

Parameters
Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

options.name

string

required

Name of the new attribute node.

options.value

string

optional

Value for the attribute node. If unspecified, the value is an empty string.

Errors

Error Code

Message

Thrown If

SSS_XML_DOM_EXCEPTION

INVALID_CHARACTER_ERR: An invalid or illegal XML character is specified.

Attribute with the spcified name or value cannot be created.

Syntax
Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/xml Module Script Samples.

          //Add additional code 
...
var attr = xmlDocument.createAttribute({
    name : 'lang',
    value : 'fr'
});
...
//Add additional code 

        

Related Topics

xml.Document
N/xml Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices