Class Element

要素

XML Element ノードの表現。

// Adds up the values listed in a sample XML document and adds a new element with the total.
var xml = '<things>'
    + '<plates>12</plates>'
    + '<bowls>18</bowls>'
    + '<cups>25</cups>'
    + '</things>';
var document = XmlService.parse(xml);
var root = document.getRootElement();
var items = root.getChildren();
var total = 0;
for (var i = 0; i < items.length; i++) {
  total += Number(items[i].getText());
}
var 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 ノードを取得します。 この Element ノードの子ノード。
getChild(name, namespace)Element指定の名前と Namespace を持つ最初の Element ノードを取得します。 この Element ノードの子ノード。
getChildText(name)String指定の名前で名前空間を持たないノードのテキスト値を取得します(ノードが Element ノードの直接の子。
getChildText(name, namespace)String指定の名前と名前空間を持つノードのテキスト値を取得します(ノードが即時ノードである場合)。 Element ノードの子ノード。
getChildren()Element[]この Element ノードの直接の子であるすべての Element ノードを取得します。 順序付けられます。
getChildren(name)Element[]指定された名前で、直接の子である名前空間を持たないすべての Element ノードを取得します この Element ノードのことを、ドキュメントでの表示順で指定します。
getChildren(name, namespace)Element[]指定の名前と Namespace の直接の子である Element ノードをすべて取得します。 この Element ノードを、ドキュメントでの出現順で並べ替えます。
getContent(index)Contentノードの直接の子ノードのうち、指定されたインデックスにあるノードを取得します。 {@code Element} ノード。
getContentSize()Integer{@code Element} ノードの直接の子であるノードの数を取得します。
getDescendants()Content[]{@code Element} ノードの直接的または間接的な子であるすべてのノードを、次の順序で取得します。 ドキュメントに表示されます。
getDocument()Document{@code Element} ノードを含む XML ドキュメントを取得します。
getName()StringElement ノードのローカル名を取得します。
getNamespace()NamespaceElement ノードの名前空間を取得します。
getNamespace(prefix)NamespaceElement ノードに指定された接頭辞を持つ名前空間を取得します。
getParentElement()Elementノードの親 Element ノードを取得します。
getQualifiedName()StringElement ノードのローカル名と名前空間の接頭辞を [namespacePrefix]:[localName] の形式で取得します。
getText()StringElement ノードのテキスト値を取得します。
getValue()Stringノードの直接または間接の子であるすべてのノードのテキスト値を次の順序で取得します。 ドキュメントに表示されます。
isAncestorOf(other)Booleanこの Element ノードが、指定された Element ノードの直接的親であるか、間接的な親であるかを決定します。
isRootElement()BooleanElement ノードがドキュメントのルートノードかどうかを判断します。
removeAttribute(attribute)Booleanこの Element ノードに指定された属性が存在する場合は、その属性を削除します。
removeAttribute(attributeName)Boolean指定された名前で名前空間を持たないこの Element ノードの属性を削除します。 存在する必要があります。
removeAttribute(attributeName, namespace)Boolean指定の名前と Namespace を持つこの 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指定の名前、値、名前空間を使用して、この Element ノードの属性を設定します。
setName(name)ElementElement ノードのローカル名を設定します。
setNamespace(namespace)ElementElement ノードの名前空間を設定します。
setText(text)ElementElement ノードのテキスト値を設定します。

詳細なドキュメント

addContent(content)

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

パラメータ

名前説明
contentContent追加するノード

戻る

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


addContent(index, content)

親ノードの直接の子であるすべてのノードの中で、指定されたノードを指定されたインデックスに挿入します。 Element 個のノード。content 引数には、Element オブジェクトまたは任意のものを指定できます。 ContentType にリストされているタイプに対応するノード オブジェクト。

パラメータ

名前説明
indexInteger直接の子であるすべてのノード間でそのノードを挿入するインデックス (Element ノードの)
contentContent挿入するノードを指定します。

戻る

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


cloneContent()

{@code Element} ノードの直接の子であるすべてのノードについて、接続されていないコピーを作成します。

戻る

Content[] - ノードの直接の子であるすべてのノードの、接続されていないコピーの配列 {@code Element} ノード


detach()

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

戻る

Content - 切断されたノード


getAllContent()

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

戻る

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


getAttribute(name)

指定の名前で名前空間を持たないこの Element ノードの属性を取得します。もし 該当する属性がない場合、このメソッドは null を返します。

パラメータ

名前説明
nameString属性の名前

戻る

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


getAttribute(name, namespace)

指定の名前と名前空間を持つこの Element ノードの属性を取得します。もし 存在しない場合、このメソッドは null を返します。

パラメータ

名前説明
nameString属性の名前
namespaceNamespace属性の名前空間

戻る

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


getAttributes()

この Element ノードのすべての属性を、ドキュメントでの出現順に取得します。

戻る

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


getChild(name)

指定の名前で、即時の名前空間を持たない最初の Element ノードを取得します。 この Element ノードの子ノード。該当するノードが存在しない場合、このメソッドは null を返します。

パラメータ

名前説明
nameStringElement ノードの名前

戻る

Element - Element ノード。指定した名前の直接の子 Element ノードがなく、名前空間がない場合は null


getChild(name, namespace)

指定の名前と Namespace を持つ最初の Element ノードを取得します。 この Element ノードの子ノード。該当するノードが存在しない場合、このメソッドは null を返します。

パラメータ

名前説明
nameStringElement ノードの名前
namespaceNamespaceElement ノードの Namespace

戻る

Element - Element ノード。指定した名前と Namespace の直接の子 Element ノードがない場合は null


getChildText(name)

指定の名前で名前空間を持たないノードのテキスト値を取得します(ノードが Element ノードの直接の子。該当するノードが存在しない場合、このメソッドは null

パラメータ

名前説明
nameString子ノードの名前

戻る

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


getChildText(name, namespace)

指定の名前と名前空間を持つノードのテキスト値を取得します(ノードが即時ノードである場合)。 Element ノードの子ノード。該当するノードが存在しない場合、このメソッドは null を返します。

パラメータ

名前説明
nameString子ノードの名前
namespaceNamespace子ノードの Namespace

戻る

String - 子ノードのテキスト値。直接の子ノードがない場合は null 特定の名前と Namespace を持つ


getChildren()

この Element ノードの直接の子であるすべての Element ノードを取得します。 順序付けられます。

戻る

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


getChildren(name)

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

パラメータ

名前説明
nameStringElement ノードの名前

戻る

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


getChildren(name, namespace)

指定の名前と Namespace の直接の子である Element ノードをすべて取得します。 この Element ノードを、ドキュメントでの出現順で並べ替えます。

パラメータ

名前説明
nameStringElement ノードの名前
namespaceNamespaceElement ノードの Namespace

戻る

Element[] - 指定の名前と Namespace を持つすべての Element ノードの配列 この Element ノードの直接の子


getContent(index)

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

パラメータ

名前説明
indexIntegerノードの直接の子であるすべてのノードのインデックス {@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 - Element ノードの名前空間


getNamespace(prefix)

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

パラメータ

名前説明
prefixString名前空間の接頭辞

戻る

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 ノードの直接的親であるか、間接的な親であるかを決定します。

パラメータ

名前説明
otherElement他の Element ノード

戻る

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


isRootElement()

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

戻る

Boolean - Element ノードがドキュメントのルートノードの場合は true。次の場合は false


removeAttribute(attribute)

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

パラメータ

名前説明
attributeAttribute属性

戻る

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


removeAttribute(attributeName)

指定された名前で名前空間を持たないこの Element ノードの属性を削除します。 存在する必要があります。

パラメータ

名前説明
attributeNameString属性の名前

戻る

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


removeAttribute(attributeName, namespace)

指定の名前と Namespace を持つこの Element ノードの属性を削除します(存在する場合) 属性が存在する可能性があります。

パラメータ

名前説明
attributeNameString属性の名前
namespaceNamespace属性の名前空間

戻る

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


removeContent()

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

戻る

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


removeContent(content)

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

パラメータ

名前説明
contentContent削除するノードを選択します。

戻る

Boolean - ノードが直接の子であり、削除されている場合は true。含まれていない場合は false


removeContent(index)

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

パラメータ

名前説明
indexIntegerノードの直接の子であるすべてのノードのインデックス {@code Element} ノード

戻る

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


setAttribute(attribute)

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

パラメータ

名前説明
attributeAttribute設定する属性

戻る

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


setAttribute(name, value)

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

パラメータ

名前説明
nameString設定する属性の名前
valueString設定する属性の値

戻る

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


setAttribute(name, value, namespace)

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

パラメータ

名前説明
nameString設定する属性の名前
valueString設定する属性の値
namespaceNamespace設定する属性の名前空間

戻る

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


setName(name)

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

パラメータ

名前説明
nameString設定するローカル名

戻る

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


setNamespace(namespace)

Element ノードの名前空間を設定します。

パラメータ

名前説明
namespaceNamespace設定する Namespace

戻る

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


setText(text)

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

パラメータ

名前説明
textString設定するテキスト

戻る

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