オブジェクト組み込みオブジェクト

オブジェクト XmlElement

XmlElement オブジェクトは XML ドキュメントの要素を表します

継承

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>XmlNode|nodeType;nodeName;nodeValue;ownerDocument;parentNode;childNodes;firstChild;lastChild;previousSibling;nextSibling|hasChildNodes();normalize();cloneNode();lookupPrefix();lookupNamespaceURI();insertBefore();insertAfter();appendChild();replaceChild();removeChild()] [<this>XmlElement|namespaceURI;prefix;localName;tagName;id;textContent;innerHTML;className;attributes|getAttribute();getAttributeNS();setAttribute();setAttributeNS();removeAttribute();removeAttributeNS();hasAttribute();hasAttributeNS();getElementsByTagName();getElementsByTagNameNS();getElementById();getElementsByClassName()] [object] <:- [XmlNode] [XmlNode] <:- [XmlElement] XmlNode nodeType nodeName nodeValue ownerDocument parentNode childNodes firstChild lastChild previousSibling nextSibling hasChildNodes() normalize() cloneNode() lookupPrefix() lookupNamespaceURI() insertBefore() insertAfter() appendChild() replaceChild() removeChild() XmlElement namespaceURI prefix localName tagName id textContent innerHTML className attributes getAttribute() getAttributeNS() setAttribute() setAttributeNS() removeAttribute() removeAttributeNS() hasAttribute() hasAttributeNS() getElementsByTagName() getElementsByTagNameNS() getElementById() getElementsByClassName() object toString() toJSON()

メンバーの属性

namespaceURI

文字列、クエリ要素の名前空間の URI。選択したノードに名前空間がない場合、この属性は NULL を返します。

1
readonly String XmlElement.namespaceURI;

prefix

文字列、クエリ、要素の名前空間プレフィックスを設定します。選択したノードに名前空間がない場合、この属性は NULL を返します。

1
String XmlElement.prefix;

localName

文字列、クエリ要素のローカル名。選択したノードに名前空間がない場合、この属性は nodeName と同等です。

1
readonly String XmlElement.localName;

tagName

文字列、要素のタグ名を返します

1
readonly String XmlElement.tagName;

id

文字列、要素の id 属性をクエリおよび設定します

1
String XmlElement.id;

textContent

文字列、クエリ、および選択した要素のテキストを設定します。クエリを実行する場合は要素ノード内のすべてのテキスト ノードの値を返し、設定する場合はすべての子ノードを削除し、それらを単一のテキスト ノードに置き換えます。

1
String XmlElement.textContent;

innerHTML

選択した要素の HTML テキストを文字列、クエリおよび設定します。html モードでのみ有効です。クエリの場合は要素ノード内のすべての子ノードの HTML コードを返し、設定の場合はすべての子ノードを削除し、デコード後に指定した HTML に置き換えます。

1
String XmlElement.innerHTML;

className

文字列、要素のクラス属性をクエリおよび設定します。html モードでのみ有効です。

1
String XmlElement.className;

attributes

XmlNamedNodeMap、選択したノードの属性を含む NamedNodeMap を返します。選択したノードが要素でない場合、この属性は NULL を返します。

1
readonly XmlNamedNodeMap XmlElement.attributes;

nodeType

整数、ノードのノード タイプを返します

1
readonly Integer XmlElement.nodeType;

異なるオブジェクトの nodeType は異なる値を返します。


nodeName

文字列、タイプに応じてノードの名前を返します

1
readonly String XmlElement.nodeName;

異なるオブジェクトの nodeName は異なる値を返します。


nodeValue

文字列、タイプに応じてノードの名前を返します

1
String XmlElement.nodeValue;

異なるオブジェクトの nodeName は異なる値を返します。


ownerDocument

XmlDocument、ノードのルート要素を返します (XmlDocument オブジェクト)

1
readonly XmlDocument XmlElement.ownerDocument;

parentNode

XmlNode、ノードの親ノードを返すことができます

1
readonly XmlNode XmlElement.parentNode;

childNodes

XmlNodeList, 指定されたノードの子ノードのノード リストを返します

1
readonly XmlNodeList XmlElement.childNodes;

firstChild

XmlNode、ノードの最初の子ノードを返します

1
readonly XmlNode XmlElement.firstChild;

lastChild

XmlNode、ノードの最後の子ノードを返します

1
readonly XmlNode XmlElement.lastChild;

previousSibling

XmlNode, 特定のノード (同じツリー レベル) の直前のノードを返します。そのようなノードがない場合、属性は null を返します。

1
readonly XmlNode XmlElement.previousSibling;

nextSibling

XmlNode(同じツリー レベル内の) 要素の直後のノードを返します。そのようなノードがない場合、プロパティは null を返します。

1
readonly XmlNode XmlElement.nextSibling;

メンバー関数

getAttribute

属性の値を名前でクエリする

1
String XmlElement.getAttribute(String name);

呼び出しパラメータ:

  • name: 文字列、クエリのプロパティ名を指定

結果を返す:

  • String、属性の値を返します

getAttributeNS

名前空間 URI と名前で属性値を取得する

1 2
String XmlElement.getAttributeNS(String namespaceURI, String localName);

呼び出しパラメータ:

  • namespaceURI: 文字列、クエリの名前空間 URI を指定します
  • localName: 文字列、クエリのプロパティ名を指定

結果を返す:

  • String、属性の値を返します

setAttribute

新しいプロパティを作成または変更する

1 2
XmlElement.setAttribute(String name, String value);

呼び出しパラメータ:

  • name: 文字列、設定するプロパティの名前を指定します
  • value: 文字列、設定する属性値を指定します

このメソッドは、指定された属性を指定された値に設定します。指定された名前の属性がない場合、メソッドは新しい属性を作成します


setAttributeNS

名前空間を使用して属性を作成または変更する

1 2 3
XmlElement.setAttributeNS(String namespaceURI, String qualifiedName, String value);

呼び出しパラメータ:

  • namespaceURI: 文字列、設定する名前空間 URI を指定します
  • qualifiedName: 文字列、設定するプロパティの名前を指定します
  • value: 文字列、設定する属性値を指定します

このメソッドは setAttribute メソッドに似ていますが、作成または設定される属性が名前空間 URI および修飾名 (名前空間プレフィックス、コロン、および名前空間内のローカル名で構成される) によって指定される点が異なります。属性の値を変更することに加えて、このメソッドを使用すると、属性の名前空間プレフィックスも変更できます


removeAttribute

指定された属性を名前で削除します

1
XmlElement.removeAttribute(String name);

呼び出しパラメータ:

  • name: 文字列、削除された属性の名前を指定します

removeAttributeNS

指定された属性を名前空間と名前で削除します

1 2
XmlElement.removeAttributeNS(String namespaceURI, String localName);

呼び出しパラメータ:

  • namespaceURI: 文字列、削除する名前空間 URI を指定します
  • localName: 文字列、削除された属性の名前を指定します

hasAttribute

現在のノードに指定された名前の属性があるかどうかを照会します

1
Boolean XmlElement.hasAttribute(String name);

呼び出しパラメータ:

  • name: 文字列、クエリの属性名を指定します

結果を返す:

  • Boolean、現在の要素ノードに指定された属性がある場合はtrueを返し、そうでない場合はfalseを返します

hasAttributeNS

現在のノードに指定された名前空間と名前の属性があるかどうかを照会します

1 2
Boolean XmlElement.hasAttributeNS(String namespaceURI, String localName);

呼び出しパラメータ:

  • namespaceURI: 文字列、照会する名前空間 URI を指定します
  • localName: 文字列、クエリの属性名を指定します

結果を返す:

  • Boolean、現在の要素ノードに指定された属性がある場合はtrueを返し、そうでない場合はfalseを返します

getElementsByTagName

指定された名前のすべての要素を返します XmlNodeList

1
XmlNodeList XmlElement.getElementsByTagName(String tagName);

呼び出しパラメータ:

  • tagName: 文字列、取得するタグ名。値「*」はすべてのタグに一致します

結果を返す:

  • XmlNodeList、ノードツリー内の指定されたマークの XmlElement ノードの XmlNodeListセットする。返される要素ノードの順序は、ソース ドキュメントに表示される順序です。

このメソッドは、指定された要素の子孫をトラバースし、XmlElement ノードを返します。 XmlNodeListオブジェクト。指定されたタグ名を持つすべてのドキュメント要素を意味します。返される配列内の要素の順序は、ドキュメントのソース コードに表示される順序です。

XmlDocument このインターフェースは getElementsByTagName メソッドも定義します。これはこのメソッドに似ていますが、要素の子孫をトラバースするのではなく、ドキュメント全体をトラバースします。


getElementsByTagNameNS

指定された名前空間と名前を持つすべての要素を返します XmlNodeList

1 2
XmlNodeList XmlElement.getElementsByTagNameNS(String namespaceURI, String localName);

呼び出しパラメータ:

  • namespaceURI: 文字列、照会する名前空間 URI を指定します
  • localName: 文字列、取得するタグ名。値「*」はすべてのタグに一致します

結果を返す:

  • XmlNodeList、ノードツリー内の指定されたマークの XmlElement ノードの XmlNodeListセットする。返される要素ノードの順序は、ソース ドキュメントに表示される順序です。

このメソッドは getElementsByTagName メソッドに似ていますが、取得する要素のタグ名が名前空間 URI と名前空間で定義されたローカル名の組み合わせとして指定される点が異なります。


getElementById

指定されたid属性を持つ要素を返します

1
XmlElement XmlElement.getElementById(String id);

呼び出しパラメータ:

  • id: 文字列、取得するID

結果を返す:

  • XmlElement、ノード ツリー内の指定された ID 属性を持つ XmlElement ノード

このメソッドは、指定された要素の子孫ノードをトラバースし、指定された id 属性を持つ最初のドキュメント要素を表す XmlElement ノード オブジェクトを返します。.

XmlDocument このインターフェースは getElementsByTagName メソッドも定義します。これはこのメソッドに似ていますが、要素の子孫をトラバースするのではなく、ドキュメント全体をトラバースします。


getElementsByClassName

指定されたクラス名を持つすべての要素のノード リストを返します。

1
XmlNodeList XmlElement.getElementsByClassName(String className);

呼び出しパラメータ:

  • className: 文字列、取得するクラスの名前

結果を返す:

  • XmlNodeList、ドキュメント ツリー内の指定されたクラス名を持つ XmlElement ノード XmlNodeListセットする。返される要素ノードの順序は、ソース ドキュメントに表示される順序です。

このメソッドは XmlNodeList オブジェクト (読み取り専用配列として扱うことができます) このオブジェクトは、ドキュメント内の指定されたクラス名を持つすべての XmlElement ノードを格納します。格納される順序は、ソース ドキュメントでの出現順序です。 XmlNodeList オブジェクトは「ライブ」です。つまり、指定されたタグ名を持つ要素がドキュメントに追加または削除されると、そのコンテンツは必要に応じて自動的に更新されます。


hasChildNodes

子ノードがあるかどうかを問い合わせる

1
Boolean XmlElement.hasChildNodes();

結果を返す:

  • Boolean、子ノードがある場合は true を返し、そうでない場合は false を返します。

normalize

隣接するテキスト ノードをマージし、空のテキスト ノードを削除します

1
XmlElement.normalize();

このメソッドは、現在のノードのすべての子孫をトラバースし、空の Text ノードを削除し、隣接するすべての Text ノードをマージすることによってドキュメントを正規化します。このメソッドは、ノードを挿入または削除した後で、ドキュメント ツリーの構造を簡素化する場合に便利です。


cloneNode

指定されたノードの正確なコピーを作成します

1
XmlNode XmlElement.cloneNode(Boolean deep = true);

呼び出しパラメータ:

  • deep: ブール値、ディープ コピーするかどうか、true の場合、クローン ノードは元のノードのすべての子ノードをクローンします

結果を返す:

  • XmlNode、コピーしたノードを返す

このメソッドは、それを呼び出したノードのコピーをコピーして返します。渡されたパラメータが true の場合、現在のノードのすべての子孫も再帰的にコピーします。それ以外の場合は、現在のノードのみをコピーします。返されたノードはドキュメント ツリーに属しておらず、その parentNode プロパティは null です。Element ノードがコピーされると、そのすべての属性がコピーされます。


lookupPrefix

現在のノードで指定された名前空間 URI に一致するプレフィックスを返します。

1
String XmlElement.lookupPrefix(String namespaceURI);

呼び出しパラメータ:

  • namespaceURI: 文字列、一致する名前空間 URI を指定します

結果を返す:

  • String、一致したプレフィックスを返し、一致しない場合は null を返します

lookupNamespaceURI

現在のノードで指定されたプレフィックスに一致する名前空間 URI を返します

1
String XmlElement.lookupNamespaceURI(String prefix);

呼び出しパラメータ:

  • prefix: 文字列、一致するプレフィックスを指定します

結果を返す:

  • String、一致する名前空間 URI を返し、一致しない場合は null を返します

insertBefore

既存の子ノードの前に新しい子ノードを挿入します

1 2
XmlNode XmlElement.insertBefore(XmlNode newChild, XmlNode refChild);

呼び出しパラメータ:

  • newChild: XmlNode、新しいノードを挿入
  • refChild: XmlNode, このノードの前に新しいノードを挿入します

結果を返す:

  • XmlNode、新しい子ノードを返す

newChild がドキュメント ツリーに既に存在する場合は、ドキュメント ツリーから削除され、新しい位置に再挿入されます。あるドキュメントのノード (または 1 つのドキュメントによって作成されたノード) を別のドキュメントに挿入することはできません。つまり、newChild の ownerDocument プロパティは、現在のノードの ownerDocument プロパティと同じである必要があります。


insertAfter

既存の子ノードの後に​​新しい子ノードを挿入します

1 2
XmlNode XmlElement.insertAfter(XmlNode newChild, XmlNode refChild);

呼び出しパラメータ:

  • newChild: XmlNode、新しいノードを挿入
  • refChild: XmlNode, このノードの後に​​新しいノードを挿入します

結果を返す:

  • XmlNode、新しい子ノードを返す

newChild がドキュメント ツリーに既に存在する場合は、ドキュメント ツリーから削除され、新しい位置に再挿入されます。あるドキュメントのノード (または 1 つのドキュメントによって作成されたノード) を別のドキュメントに挿入することはできません。つまり、newChild の ownerDocument プロパティは、現在のノードの ownerDocument プロパティと同じである必要があります。


appendChild

ノードの子ノード リストの最後に新しい子ノードを追加します

1
XmlNode XmlElement.appendChild(XmlNode newChild);

呼び出しパラメータ:

  • newChild: XmlNode、追加したノードを指定

結果を返す:

  • XmlNode、この新しい子ノードを返す

newChild がドキュメント ツリーに既に存在する場合は、ドキュメント ツリーから削除され、新しい位置に再挿入されます。あるドキュメントのノード (または 1 つのドキュメントによって作成されたノード) を別のドキュメントに挿入することはできません。つまり、newChild の ownerDocument プロパティは、現在のノードの ownerDocument プロパティと同じである必要があります。


replaceChild

子ノードを別の子ノードに置き換える

1 2
XmlNode XmlElement.replaceChild(XmlNode newChild, XmlNode oldChild);

呼び出しパラメータ:

  • newChild: XmlNode、新しいノードを指定
  • oldChild: XmlNode、交換するノードを指定

結果を返す:

  • XmlNode、置換が成功した場合、このメソッドは置換されたノードを返すことができ、置換が失敗した場合は null を返します

newChild がドキュメント ツリーに既に存在する場合は、ドキュメント ツリーから削除され、新しい位置に再挿入されます。あるドキュメントのノード (または 1 つのドキュメントによって作成されたノード) を別のドキュメントに挿入することはできません。つまり、newChild の ownerDocument プロパティは、現在のノードの ownerDocument プロパティと同じである必要があります。


removeChild

子ノードのリストからノードを削除します

1
XmlNode XmlElement.removeChild(XmlNode oldChild);

呼び出しパラメータ:

  • oldChild: XmlNode、削除するノードを指定

結果を返す:

  • XmlNode、削除が成功した場合、このメソッドは削除されたノードを返すことができ、失敗した場合は null を返します。

toString

オブジェクトの文字列表現を返します。通常は「[ネイティブ オブジェクト]」を返します。オブジェクトは独自の特性に従って再実装できます。

1
String XmlElement.toString();

結果を返す:

  • String、オブジェクトの文字列表現を返します

toJSON

オブジェクトの JSON 形式の表現を返します。通常は、オブジェクトによって定義された読み取り可能な属性のコレクションを返します。

1
Value XmlElement.toJSON(String key = "");

呼び出しパラメータ:

  • key: ストリング、未使用

結果を返す:

  • Value、シリアライズ可能なJSONを含む値を返します