Class Element

XML Element ノードの表現。

// Adds up the values listed in a sample XML document and adds a new element
// with the total.
let xml = '<things>' +
    '<plates>12</plates>' +
    '<bowls>18</bowls>' +
    '<cups>25</cups>' +
    '</things>';
const document = XmlService.parse(xml);
const root = document.getRootElement();
const items = root.getChildren();
let total = 0;
for (let i = 0; i < items.length; i++) {
  total += Number(items[i].getText());
}
const totalElement = XmlService.createElement('total').setText(total);
root.addContent(totalElement);
xml = XmlService.getPrettyFormat().format(document);
Logger.log(xml);

メソッド

メソッド	戻り値の型	概要
`addContent(content)`	`Element`	指定されたノードを `Element` ノードの最後の子として追加します。
`addContent(index, content)`	`Element`	`Element` ノードの直接の子であるすべてのノードの中で、指定されたインデックスに指定されたノードを挿入します。
`cloneContent()`	`Content[]`	{@code Element} ノードの直下の子であるすべてのノードの、アタッチされていないコピーを作成します。
`detach()`	`Content\|null`	ノードを親の `Element` ノードから切り離します。
`getAllContent()`	`Content[]`	{@code Element} ノードの直接の子であるすべてのノードを取得します。
`getAttribute(name)`	`Attribute\|null`	指定された名前で名前空間のないこの `Element` ノードの属性を取得します。
`getAttribute(name, namespace)`	`Attribute\|null`	指定された名前と名前空間を持つこの `Element` ノードの属性を取得します。
`getAttributes()`	`Attribute[]`	この `Element` ノードのすべての属性を、ドキュメントに表示される順序で取得します。
`getChild(name)`	`Element\|null`	指定された名前を持ち、Namespace がなく、この `Element` ノードの直下の子である最初の `Element` ノードを取得します。
`getChild(name, namespace)`	`Element\|null`	指定された名前と名前空間を持つ最初の `Element` ノードを取得します。このノードは、この `Element` ノードの直下の子です。
`getChildText(name)`	`String\|null`	ノードが `Element` ノードの直下の子である場合、指定された名前で名前空間のないノードのテキスト値を取得します。
`getChildText(name, namespace)`	`String\|null`	ノードが `Element` ノードの直下の子である場合、指定された名前と名前空間を持つノードのテキスト値を取得します。
`getChildren()`	`Element[]`	この `Element` ノードの直下の子であるすべての `Element` ノードを、ドキュメントに表示される順序で取得します。
`getChildren(name)`	`Element[]`	この `Element` ノードの直下の子で、指定された名前を持ち、名前空間を持たないすべての `Element` ノードを、ドキュメントに現れる順序で取得します。
`getChildren(name, namespace)`	`Element[]`	この `Element` ノードの直下の子である、指定された名前と Namespace を持つすべての `Element` ノードを、ドキュメントに現れる順序で取得します。
`getContent(index)`	`Content\|null`	{@code Element} ノードの直接の子であるすべてのノードのうち、指定されたインデックスにあるノードを取得します。
`getContentSize()`	`Integer`	{@code Element} ノードの直接の子であるノードの数を取得します。
`getDescendants()`	`Content[]`	{@code Element} ノードの直接または間接の子であるすべてのノードを、ドキュメントに表示される順序で取得します。
`getDocument()`	`Document`	{@code Element} ノードを含む XML ドキュメントを取得します。
`getName()`	`String`	`Element` ノードのローカル名を取得します。
`getNamespace()`	`Namespace`	`Element` ノードの Namespace を取得します。
`getNamespace(prefix)`	`Namespace`	`Element` ノードの指定された接頭辞を持つ名前空間を取得します。
`getParentElement()`	`Element\|null`	ノードの親 `Element` ノードを取得します。
`getQualifiedName()`	`String`	`Element` ノードのローカル名と名前空間の接頭辞を `[namespacePrefix]:[localName]` 形式で取得します。
`getText()`	`String`	`Element` ノードのテキスト値を取得します。
`getValue()`	`String`	ノードの直接または間接の子であるすべてのノードのテキスト値を、ドキュメントに表示される順序で取得します。
`isAncestorOf(other)`	`Boolean`	この `Element` ノードが、指定された `Element` ノードの直接の親か間接の親かを判断します。
`isRootElement()`	`Boolean`	`Element` ノードがドキュメントのルートノードかどうかを判断します。
`removeAttribute(attribute)`	`Boolean`	指定された属性がこの `Element` ノードに存在する場合、その属性を削除します。
`removeAttribute(attributeName)`	`Boolean`	指定された名前で名前空間のない属性がこの `Element` ノードに存在する場合、その属性を削除します。
`removeAttribute(attributeName, namespace)`	`Boolean`	指定された名前と名前空間を持つこの `Element` ノードの属性を削除します（そのような属性が存在する場合）。
`removeContent()`	`Content[]`	{@code Element} ノードの直接の子であるすべてのノードを削除します。
`removeContent(content)`	`Boolean`	指定されたノードが {@code Element} ノードの直接の子である場合、そのノードを削除します。
`removeContent(index)`	`Content\|null`	{@code Element} ノードの直接の子であるすべてのノードのうち、指定されたインデックスにあるノードを削除します。
`setAttribute(attribute)`	`Element`	この `Element` ノードに指定された属性を設定します。
`setAttribute(name, value)`	`Element`	指定された名前と値で、名前空間なしでこの `Element` ノードの属性を設定します。
`setAttribute(name, value, namespace)`	`Element`	指定された名前、値、名前空間を使用して、この `Element` ノードの属性を設定します。
`setName(name)`	`Element`	`Element` ノードのローカル名を設定します。
`setNamespace(namespace)`	`Element`	`Element` ノードの Namespace を設定します。
`setText(text)`	`Element`	`Element` ノードのテキスト値を設定します。

詳細なドキュメント

`addContent(content)`

指定されたノードを Element ノードの最後の子として追加します。content 引数には、Element オブジェクト、または ContentType にリストされている型に対応する任意のノードオブジェクトを指定できます。

パラメータ

名前	型	説明
`content`	`Content`	追加するノード。

戻る

Element - チェーン用の Element ノード。

`addContent(index, content)`

Element ノードの直下の子ノードのうち、指定されたインデックスに指定されたノードを挿入します。content 引数には、Element オブジェクトまたは ContentType にリストされている型に対応する任意のノードオブジェクトを指定できます。

パラメータ

名前	型	説明
`index`	`Integer`	`Element` ノードの直接の子であるすべてのノードの中で、ノードを挿入するインデックス。
`content`	`Content`	挿入するノード。

戻る

Element - チェーン用の Element ノード。

`cloneContent()`

{@code Element} ノードの直下の子であるすべてのノードの、アタッチされていないコピーを作成します。

戻る

Content[] - {@code Element} ノードの直接の子であるすべてのノードの未接続コピーの配列。

`detach()`

ノードを親の Element ノードから切り離します。ノードに親がない場合、このメソッドは効力がありません。

戻る

Content|null - デタッチされたノード。

`getAllContent()`

{@code Element} ノードの直接の子であるすべてのノードを取得します。

戻る

Content[] - {@code Element} ノードの直接の子であるすべてのノードの配列。

`getAttribute(name)`

指定された名前で名前空間のないこの Element ノードの属性を取得します。そのような属性がない場合、このメソッドは null を返します。

パラメータ

名前	型	説明
`name`	`String`	属性名。

戻る

Attribute|null - 属性。指定された名前の属性がなく、名前空間もない場合は null。

`getAttribute(name, namespace)`

指定された名前と名前空間を持つこの Element ノードの属性を取得します。そのようなノードがない場合、このメソッドは null を返します。

パラメータ

名前	型	説明
`name`	`String`	属性名。
`namespace`	`Namespace`	属性の Namespace。

戻る

Attribute|null - 属性。指定された名前と名前空間の属性がない場合は null。

`getAttributes()`

この Element ノードのすべての属性を、ドキュメントに表示される順序で取得します。

戻る

Attribute[] - この Element ノードのすべての属性の配列。

`getChild(name)`

指定された名前を持ち、Namespace がなく、この Element ノードの直下の子である最初の Element ノードを取得します。そのようなノードがない場合、このメソッドは null を返します。

パラメータ

名前	型	説明
`name`	`String`	子 `Element` ノードの名前。

戻る

Element|null - Element ノード。指定された名前と名前空間を持つ直下の子 Element ノードがない場合は null。

`getChild(name, namespace)`

指定された名前と Namespace を持ち、この Element ノードの直下の子である最初の Element ノードを取得します。そのようなノードがない場合、このメソッドは null を返します。

パラメータ

名前	型	説明
`name`	`String`	子 `Element` ノードの名前。
`namespace`	`Namespace`	子 `Element` ノードの名前空間。

戻る

Element|null - Element ノード。指定された名前と名前空間を持つ直下の子 Element ノードがない場合は null。

`getChildText(name)`

ノードが Element ノードの直下の子である場合、指定された名前で名前空間のないノードのテキスト値を取得します。そのようなノードがない場合、このメソッドは null を返します。

パラメータ

名前	型	説明
`name`	`String`	子ノードの名前。

戻る

String|null - 子ノードのテキスト値。指定された名前と名前空間を持つ直下の子ノードがない場合は null。

`getChildText(name, namespace)`

ノードが Element ノードの直下の子である場合、指定された名前と名前空間を持つノードのテキスト値を取得します。そのようなノードがない場合、このメソッドは null を返します。

パラメータ

名前	型	説明
`name`	`String`	子ノードの名前。
`namespace`	`Namespace`	子ノードの Namespace。

戻る

String|null - 子ノードのテキスト値。指定された名前と名前空間を持つ直近の子ノードがない場合は null。

`getChildren()`

この Element ノードの直下の子であるすべての Element ノードを、ドキュメントに表示される順序で取得します。

戻る

Element[] - この Element ノードの直接の子であるすべての Element ノードの配列。

`getChildren(name)`

この Element ノードの直下の子で、指定された名前を持ち、名前空間を持たないすべての Element ノードを、ドキュメントに現れる順序で取得します。

パラメータ

名前	型	説明
`name`	`String`	子 `Element` ノードの名前。

戻る

Element[] - 指定された名前を持ち、Namespace がなく、この Element ノードの直下の子であるすべての Element ノードの配列。

`getChildren(name, namespace)`

この Element ノードの直下の子である、指定された名前と Namespace を持つすべての Element ノードを、ドキュメントに現れる順序で取得します。

パラメータ

名前	型	説明
`name`	`String`	子 `Element` ノードの名前。
`namespace`	`Namespace`	子 `Element` ノードの Namespace。

戻る

Element[] - 指定された名前と名前空間を持つすべての Element ノードの配列。この Element ノードの直下の子です。

`getContent(index)`

{@code Element} ノードの直接の子であるすべてのノードのうち、指定されたインデックスにあるノードを取得します。指定されたインデックスにノードがない場合、このメソッドは null を返します。

パラメータ

名前	型	説明
`index`	`Integer`	{@code Element} ノードの直接の子であるすべてのノードの中での、ノードのインデックス。

戻る

Content|null - ノード。指定されたインデックスにノードがない場合は null。

`getContentSize()`

{@code Element} ノードの直接の子であるノードの数を取得します。

戻る

Integer - {@code Element} ノードの直下の子ノードの数。

`getDescendants()`

{@code Element} ノードの直接または間接の子であるすべてのノードを、ドキュメントに表示される順序で取得します。

戻る

Content[] - {@code Element} ノードの直接または間接の子であるすべてのノードの配列。

`getDocument()`

{@code Element} ノードを含む XML ドキュメントを取得します。

戻る

Document - {@code Element} ノードを含むドキュメント。

`getName()`

Element ノードのローカル名を取得します。ノードに名前空間の接頭辞がある場合は、getQualifiedName() または getNamespace() を使用します。getPrefix() を使用して接頭辞を取得します。

戻る

String - Element ノードのローカル名。

`getNamespace()`

Element ノードの Namespace を取得します。

戻る

Namespace - Element ノードの名前空間。

`getNamespace(prefix)`

Element ノードの指定された接頭辞を持つ名前空間を取得します。

パラメータ

名前	型	説明
`prefix`	`String`	Namespace の接頭辞。

戻る

Namespace - Element ノードの指定された接頭辞を持つ Namespace。

`getParentElement()`

ノードの親 Element ノードを取得します。ノードに親がない場合、このメソッドは null を返します。

戻る

Element|null - 親 Element ノード。

`getQualifiedName()`

Element ノードのローカル名と名前空間の接頭辞を [namespacePrefix]:[localName] 形式で取得します。ノードに Namespace 接頭辞がない場合は、getName() を使用します。

戻る

String - Element ノードのローカル名と名前空間の接頭辞（[namespacePrefix]:[localName] 形式）。

`getText()`

Element ノードのテキスト値を取得します。

戻る

String - Element ノードのテキスト値。

`getValue()`

ノードの直接または間接の子であるすべてのノードのテキスト値を、ドキュメントに表示される順序で取得します。

戻る

String - ノードの直接または間接の子であるすべてのノードのテキスト値。

`isAncestorOf(other)`

この Element ノードが、指定された Element ノードの直接の親か間接の親かを判断します。

パラメータ

名前	型	説明
`other`	`Element`	もう一方の `Element` ノード。

戻る

Boolean - この Element ノードが指定された Element ノードの直接または間接的な親である場合は true、そうでない場合は false。

`isRootElement()`

Element ノードがドキュメントのルートノードかどうかを判断します。

戻る

Boolean - Element ノードがドキュメントのルートノードの場合は true、それ以外の場合は false。

`removeAttribute(attribute)`

指定された属性がこの Element ノードに存在する場合、その属性を削除します。

パラメータ

名前	型	説明
`attribute`	`Attribute`	属性。

戻る

Boolean - 属性が存在して削除された場合は true、存在しない場合は false。

`removeAttribute(attributeName)`

指定された名前で名前空間のない属性がこの Element ノードに存在する場合、その属性を削除します。

パラメータ

名前	型	説明
`attributeName`	`String`	属性名。

戻る

Boolean - 属性が存在して削除された場合は true、存在しない場合は false。

`removeAttribute(attributeName, namespace)`

指定された名前と名前空間を持つこの Element ノードの属性を削除します（そのような属性が存在する場合）。

パラメータ

名前	型	説明
`attributeName`	`String`	属性名。
`namespace`	`Namespace`	属性の Namespace。

戻る

Boolean - 属性が存在して削除された場合は true、存在しない場合は false。

`removeContent()`

{@code Element} ノードの直接の子であるすべてのノードを削除します。

戻る

Content[] - 削除される前の {@code Element} ノードの直下の子であったすべてのノードの配列。

`removeContent(content)`

指定されたノードが {@code Element} ノードの直接の子である場合、そのノードを削除します。content 引数には、Element オブジェクトまたは ContentType にリストされている型に対応する任意のノードオブジェクトを指定できます。

パラメータ

名前	型	説明
`content`	`Content`	削除するノード。

戻る

Boolean - ノードが直接の子で、削除された場合は true、それ以外の場合は false。

`removeContent(index)`

{@code Element} ノードの直接の子であるすべてのノードのうち、指定されたインデックスにあるノードを削除します。指定されたインデックスにノードがない場合、このメソッドは null を返します。

パラメータ

名前	型	説明
`index`	`Integer`	{@code Element} ノードの直接の子であるすべてのノードの中での、ノードのインデックス。

戻る

Content|null - 削除されたノード。指定されたインデックスにノードがない場合は null。

`setAttribute(attribute)`

この Element ノードに指定された属性を設定します。

パラメータ

名前	型	説明
`attribute`	`Attribute`	設定する属性。

戻る

Element - チェーン用の Element ノード。

`setAttribute(name, value)`

指定された名前と値で、名前空間なしでこの Element ノードの属性を設定します。

パラメータ

名前	型	説明
`name`	`String`	設定する属性の名前。
`value`	`String`	設定する属性の値。

戻る

Element - チェーン用の Element ノード。

`setAttribute(name, value, namespace)`

指定された名前、値、名前空間を使用して、この Element ノードの属性を設定します。

パラメータ

名前	型	説明
`name`	`String`	設定する属性の名前。
`value`	`String`	設定する属性の値。
`namespace`	`Namespace`	設定する属性の Namespace。

戻る

Element - チェーン用の Element ノード。

`setName(name)`

Element ノードのローカル名を設定します。ノードの Namespace 接頭辞を設定するには、XmlService.getNamespace(prefix, uri) と組み合わせて setNamespace(namespace) を使用します。

パラメータ

名前	型	説明
`name`	`String`	設定するローカル名。

戻る

Element - チェーン用の Element ノード。

`setNamespace(namespace)`

Element ノードの Namespace を設定します。

パラメータ

名前	型	説明
`namespace`	`Namespace`	設定する Namespace。

戻る

Element - チェーン用の Element ノード。

`setText(text)`

Element ノードのテキスト値を設定します。ノードにテキスト値または子ノードがすでに含まれている場合、このメソッドは古いコンテンツを上書きします。代わりにコンテンツを追加または挿入するには、addContent(content) または addContent(index, content) を使用します。

パラメータ

名前	型	説明
`text`	`String`	設定するテキスト。

戻る

Element - チェーン用の Element ノード。

Class Element コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

メソッド

詳細なドキュメント

addContent(content)

パラメータ

戻る

addContent(index, content)

パラメータ

戻る

cloneContent()

戻る

detach()

戻る

getAllContent()

戻る

getAttribute(name)

パラメータ

戻る

getAttribute(name, namespace)

パラメータ

戻る

getAttributes()

戻る

getChild(name)

パラメータ

戻る

getChild(name, namespace)

パラメータ

戻る

getChildText(name)

パラメータ

戻る

getChildText(name, namespace)

パラメータ

戻る

getChildren()

戻る

getChildren(name)

パラメータ

戻る

getChildren(name, namespace)

パラメータ

戻る

getContent(index)

パラメータ

戻る

getContentSize()

戻る

getDescendants()

戻る

getDocument()

戻る

getName()

戻る

getNamespace()

戻る

getNamespace(prefix)

パラメータ

戻る

getParentElement()

戻る

getQualifiedName()

戻る

getText()

戻る

getValue()

戻る

isAncestorOf(other)

パラメータ

戻る

isRootElement()

戻る

removeAttribute(attribute)

パラメータ

戻る

removeAttribute(attributeName)

パラメータ

戻る

removeAttribute(attributeName, namespace)

パラメータ

Class Element

`addContent(content)`

`addContent(index, content)`

`cloneContent()`

`detach()`

`getAllContent()`

`getAttribute(name)`

`getAttribute(name, namespace)`

`getAttributes()`

`getChild(name)`

`getChild(name, namespace)`

`getChildText(name)`

`getChildText(name, namespace)`

`getChildren()`

`getChildren(name)`

`getChildren(name, namespace)`

`getContent(index)`

`getContentSize()`

`getDescendants()`

`getDocument()`

`getName()`

`getNamespace()`

`getNamespace(prefix)`

`getParentElement()`

`getQualifiedName()`

`getText()`

`getValue()`

`isAncestorOf(other)`

`isRootElement()`

`removeAttribute(attribute)`

`removeAttribute(attributeName)`

`removeAttribute(attributeName, namespace)`

`removeContent()`

`removeContent(content)`

`removeContent(index)`

`setAttribute(attribute)`

`setAttribute(name, value)`

`setAttribute(name, value, namespace)`

`setName(name)`

`setNamespace(namespace)`

`setText(text)`