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

オブジェクト XmlComment

XmlComment オブジェクトは、ドキュメント内のコメント ノードのコンテンツを表します。

XmlComment ノードは、XML ドキュメント内のコメントを表します。によって使われたXmlCharacterData インターフェイスによって継承されたデータ属性、または XmlNodeインターフェイスによって継承された nodeValue プロパティは、注釈のコンテンツにアクセスできます。(つまり、間のテキスト)。によって使われたXmlCharacterData インターフェースによって継承されたさまざまなメソッドは、コメントの内容を操作できます。

使用する XmlDocument.createComment() コメント オブジェクトを作成します。

継承

#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()] [<class>XmlCharacterData|data;length|substringData();appendData();insertData();deleteData();replaceData()] [<this>XmlComment] [object] <:- [XmlNode] [XmlNode] <:- [XmlCharacterData] [XmlCharacterData] <:- [XmlComment] XmlNode nodeType nodeName nodeValue ownerDocument parentNode childNodes firstChild lastChild previousSibling nextSibling hasChildNodes() normalize() cloneNode() lookupPrefix() lookupNamespaceURI() insertBefore() insertAfter() appendChild() replaceChild() removeChild() XmlCharacterData data length substringData() appendData() insertData() deleteData() replaceData() object toString() toJSON() XmlComment

メンバーの属性

data

文字列、ノードに含まれるテキスト

1
String XmlComment.data;

length

整数、ノードに含まれる文字数

1
readonly Integer XmlComment.length;

nodeType

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

1
readonly Integer XmlComment.nodeType;

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


nodeName

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

1
readonly String XmlComment.nodeName;

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


nodeValue

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

1
String XmlComment.nodeValue;

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


ownerDocument

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

1
readonly XmlDocument XmlComment.ownerDocument;

parentNode

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

1
readonly XmlNode XmlComment.parentNode;

childNodes

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

1
readonly XmlNodeList XmlComment.childNodes;

firstChild

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

1
readonly XmlNode XmlComment.firstChild;

lastChild

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

1
readonly XmlNode XmlComment.lastChild;

previousSibling

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

1
readonly XmlNode XmlComment.previousSibling;

nextSibling

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

1
readonly XmlNode XmlComment.nextSibling;

メンバー関数

substringData

ノードから部分文字列を抽出

1 2
String XmlComment.substringData(Integer offset, Integer count);

呼び出しパラメータ:

  • offset: 整数、最初に返される文字の位置
  • count: 整数、返される部分文字列の文字数

結果を返す:

  • String、抽出した文字列を返す

appendData

文字列をノードに追加します

1
XmlComment.appendData(String arg);

呼び出しパラメータ:

  • arg: 文字列、ノードに追加される文字列

insertData

ノードに文字列を挿入

1 2
XmlComment.insertData(Integer offset, String arg);

呼び出しパラメータ:

  • offset: 整数、文字列がノードに挿入される文字位置
  • arg: 文字列、挿入する文字列

deleteData

ノードからテキストを削除

1 2
XmlComment.deleteData(Integer offset, Integer count);

呼び出しパラメータ:

  • offset: 整数、削除される最初の文字の位置
  • count: 整数、削除する文字数

replaceData

ノードの文字を指定された文字列に置き換えます

1 2 3
XmlComment.replaceData(Integer offset, Integer count, String arg);

呼び出しパラメータ:

  • offset: 整数、置換されるノードの文字位置
  • count: 整数、置換する文字数
  • arg: 文字列、挿入する文字列

hasChildNodes

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

1
Boolean XmlComment.hasChildNodes();

結果を返す:

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

normalize

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

1
XmlComment.normalize();

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


cloneNode

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

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

呼び出しパラメータ:

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

結果を返す:

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

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


lookupPrefix

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

1
String XmlComment.lookupPrefix(String namespaceURI);

呼び出しパラメータ:

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

結果を返す:

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

lookupNamespaceURI

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

1
String XmlComment.lookupNamespaceURI(String prefix);

呼び出しパラメータ:

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

結果を返す:

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

insertBefore

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

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

呼び出しパラメータ:

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

結果を返す:

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

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


insertAfter

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

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

呼び出しパラメータ:

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

結果を返す:

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

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


appendChild

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

1
XmlNode XmlComment.appendChild(XmlNode newChild);

呼び出しパラメータ:

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

結果を返す:

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

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


replaceChild

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

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

呼び出しパラメータ:

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

結果を返す:

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

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


removeChild

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

1
XmlNode XmlComment.removeChild(XmlNode oldChild);

呼び出しパラメータ:

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

結果を返す:

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

toString

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

1
String XmlComment.toString();

結果を返す:

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

toJSON

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

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

呼び出しパラメータ:

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

結果を返す:

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