このページは Cloud Translation API によって翻訳されました。

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`	ノードを親の `Element` ノードから切断します。
`getAllContent()`	`Content[]`	{@code Element} ノードの直接の子であるすべてのノードを取得します。
`getAttribute(name)`	`Attribute`	指定された名前で、名前空間のないこの `Element` ノードの属性を取得します。
`getAttribute(name, namespace)`	`Attribute`	指定された名前と名前空間を持つこの `Element` ノードの属性を取得します。
`getAttributes()`	`Attribute[]`	この `Element` ノードのすべての属性を、ドキュメントに記載されている順序で取得します。
`getChild(name)`	`Element`	指定された名前で、この `Element` ノードの直下の子ノードである Namespace のない最初の `Element` ノードを取得します。
`getChild(name, namespace)`	`Element`	この `Element` ノードの直下の子で、指定された名前と名前空間を持つ最初の `Element` ノードを取得します。
`getChildText(name)`	`String`	ノードが `Element` ノードの直下の子である場合、指定された名前と名前空間のないノードのテキスト値を取得します。
`getChildText(name, namespace)`	`String`	ノードが `Element` ノードの直下にある場合、指定された名前と名前空間を持つノードのテキスト値を取得します。
`getChildren()`	`Element[]`	この `Element` ノードの直下の子であるすべての `Element` ノードを、ドキュメント内の表示順で取得します。
`getChildren(name)`	`Element[]`	指定された名前で、この `Element` ノードの直下の子である名前空間のないすべての `Element` ノードを、ドキュメントに表示される順序で取得します。
`getChildren(name, namespace)`	`Element[]`	この `Element` ノードの直下の子で、指定された名前と名前空間を持つすべての `Element` ノードを、ドキュメントに表示される順序で取得します。
`getContent(index)`	`Content`	{@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`	ノードの親 `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`	{@code Element} ノードの直接の子であるすべてのノードのうち、指定したインデックスのノードを削除します。
`setAttribute(attribute)`	`Element`	この `Element` ノードに指定された属性を設定します。
`setAttribute(name, value)`	`Element`	指定された名前と値で、この `Element` ノードの属性を設定し、名前空間は設定しません。
`setAttribute(name, value, namespace)`	`Element`	指定された名前、値、Namespace を使用して、この `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 - デタッチされたノード

`getAllContent()`

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

戻る

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

`getAttribute(name)`

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

パラメータ

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

戻る

Attribute - 属性。指定した名前の属性が存在せず、名前空間も存在しない場合、null です。

`getAttribute(name, namespace)`

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

パラメータ

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

戻る

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

`getAttributes()`

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

戻る

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

`getChild(name)`

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

パラメータ

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

戻る

Element - Element ノード。指定された名前の子 Element ノードがなく、Namespace もない場合、null です。

`getChild(name, namespace)`

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

パラメータ

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

戻る

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

`getChildText(name)`

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

パラメータ

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

戻る

String - 子ノードのテキスト値。指定された名前と名前空間のない直接の子ノードがない場合、null です。

`getChildText(name, namespace)`

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

パラメータ

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

戻る

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

`getChildren()`

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

戻る

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

`getChildren(name)`

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

パラメータ

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

戻る

Element[] - 指定された名前で、この Element ノードの直接の子である Namespace のないすべての Element ノードの配列

`getChildren(name, namespace)`

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

パラメータ

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

戻る

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

`getContent(index)`

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

パラメータ

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

戻る

Content - ノード。指定されたインデックスにノードがない場合、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 ノードの Namespace

`getNamespace(prefix)`

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

パラメータ

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

戻る

Namespace - Element ノードに指定された接頭辞を持つ名前空間

`getParentElement()`

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

戻る

Element - 親 Element ノード

`getQualifiedName()`

Element ノードのローカル名と名前空間の接頭辞を [namespacePrefix]:[localName] 形式で取得します。ノードに名前空間の接頭辞がない場合は、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`	属性の名前空間

戻る

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 です。

`setAttribute(attribute)`

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

パラメータ

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

戻る

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

`setAttribute(name, value)`

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

パラメータ

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

戻る

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

`setAttribute(name, value, namespace)`

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

パラメータ

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

戻る

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

`setName(name)`

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

パラメータ

名前	型	説明
`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 ノード