Inheritance diagram for Node:

[legend]

Collaboration diagram for Node:

[legend]

Public Member Functions
	AppendCharacter (_.Library.String text, _.Library.Boolean raw, _.Library.String parent)
	Append new character data node to the list of children of this element node. More...

	AppendElement (_.Library.String localName, _.Library.String namespace, _.Library.String text, _.Library.String qname)
	Append new element node to the list of children of this node. More...

_.Library.Status	AppendNode (_.XML.Node sourceNode)
	Append a copy of the specified node to the list of children of this node. More...

_.Library.Status	AppendTree (_.XML.Node sourceNode)
	Append a copy of the specified node, including all its children, to the list of children of this node. More...

_.Library.String	AttributeDefined (_.Library.String attributeName)
	Return non-zero (true) if attribute named attributeName exists for this element.

_.Library.String	FirstAttributeName ()
	Return attribute name for first attribute for this element.

	GetAttribute (_.Library.String attributeName, _.Library.String namespace, _.Library.String value, _.Library.String valueNamespace)
	Return attribute data of attribute named attributeName for this element. More...

	GetAttributeNS (_.Library.String attributeName, _.Library.String namespace, _.Library.String value, _.Library.String valueNamespace)
	Return attribute data of attribute named attributeName in namespace for this element. More...

_.Library.String	GetAttributeNamespace (_.Library.String attributeName)
	Return namespace URI from QName of attribute named attributeName for this element.

_.Library.String	GetAttributeQName (_.Library.String attributeName)
	Return QName of attribute named attributeName for this element.

_.Library.String	GetAttributeQNameNS (_.Library.String attributeName, _.Library.String namespace)
	Return QName of attribute named attributeName in namespace for this element.

_.Library.String	GetAttributeValue (_.Library.String attributeName)
	Return value of attribute named attributeName for this element.

_.Library.String	GetAttributeValueNS (_.Library.String attributeName, _.Library.String namespace)
	Return value of attribute named attributeName in namespace for this element.

_.Library.String	GetAttributeValueNamespace (_.Library.String attributeName)
	Return namespace of value of attribute named attributeName for this element.

_.Library.String	GetAttributeValueNamespaceNS (_.Library.String attributeName, _.Library.String namespace)
	Return namespace value of attribute named attributeName in namespace for this element.

_.Library.Integer	GetNumberAttributes ()
	Return number of attributes for this element.

_.Library.Boolean	GetText (text, _.Library.Boolean mixed)
	Get the text contents of an element node. More...

_.Library.Boolean	HasChildNodes (_.Library.Boolean skipWhitespace)
	Return non-zero (true) if this node has any child nodes.

_.Library.String	InsertCharacter (_.Library.String text, _.Library.String child)
	Insert a new character data node to the list of children of this element node. More...

_.Library.String	InsertElement (_.Library.String localName, _.Library.String namespace, _.Library.String child, _.Library.String text, _.Library.String qname)
	Insert a new element node to the list of children of this node. More...

_.Library.String	InsertNode (_.XML.Node sourceNode, _.Library.String child, _.Library.Status sc)
	Insert a copy of the specified node to the list of children of this node. More...

_.Library.String	InsertTree (_.XML.Node sourceNode, _.Library.String child, _.Library.Status sc)
	Insert a copy of the specified node, including its children, to the list of children of this node. More...

_.Library.Boolean	IsDescendant (_.XML.Node sourceNode)
	Check is a this node is the descendant of specified node.

_.Library.String	LastAttributeName ()
	Return attribute name for last attribute for this element.

_.Library.Boolean	MoveToFirstChild (_.Library.Boolean skipWhitespace)
	Move node to current node's first child node. More...

_.Library.Boolean	MoveToLastChild (_.Library.Boolean skipWhitespace)
	Move node to current node's last child node. More...

_.Library.Boolean	MoveToNextSibling (_.Library.Boolean skipWhitespace)
	Move node to current node's next sibling. More...

_.Library.Boolean	MoveToParent (_.Library.Boolean restrictDocumentNode)
	Move node to current node's parent. More...

_.Library.Boolean	MoveToParentElement (_.Library.String localName)
	Move node to current node's ancestor which has the specified local name.

_.Library.Boolean	MoveToPreviousSibling (_.Library.Boolean skipWhitespace)
	Move node to current node's previous sibling. More...

_.Library.String	NextAttributeName (_.Library.String attributeName)
	Return attribute name for next attribute for this element.

_.Library.String	PreviousAttributeName (_.Library.String attributeName)
	Return attribute name for previous attribute for this element.

	Remove ()
	Remove the current node and make its parent the current node.

	RemoveAttribute (_.Library.String attributeName)
	Remove attribute named attributeName for this element.

	RemoveAttributeNS (_.Library.String attributeName, _.Library.String namespace)
	Remove attribute named attributeName in namespace for this element.

	ReplaceCharacter (_.Library.String text)
	Replace this node with a character node.

	ReplaceElement (_.Library.String localName, _.Library.String namespace, _.Library.String text, _.Library.String qname)
	Replace this node with an element node.

_.Library.Status	ReplaceNode (_.XML.Node sourceNode)
	Replace this node with a copy of the specified node. More...

_.Library.Status	ReplaceTree (_.XML.Node sourceNode)
	Replace this node with a copy of the specified node including all its children. More...

_.Library.String	Serialize (endElementText)
	Serialize this node as element.

	SetAttribute (_.Library.String attributeName, _.Library.String namespace, _.Library.String value, _.Library.String valueNamespace)
	Set attribute data of attribute named attributeName for this element. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Attributes
	Document
	The DOM that this XML.Node instance is navigating. More...

	LocalName
	Local name for element node. More...

	Namespace
	XML namespace for element node. More...

	NamespaceIndex
	Index into XML namespace table for element node. More...

	Nil
	True if xsi:nil or xsi:null specified as true or 1 for this element node. More...

	NodeData
	Value of a character node. More...

	NodeId
	The id of the current node. More...

	NodeType
	Type of node: $$$xmlELEMENTNODE, $$$xmlTEXTNODE, $$$xmlWHITESPACENODE. More...

	QName
	Qname for element node. More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

For details on using this class, see Representing an XML Document as a DOM.

<class>XML.Node</class> may be used to navigate the an XML document which is represented as an Document Object Model (DOM) using the <class>XML.Document</class>. The <class>XML.Document</class> may be created either from an XML document by accessing the Document property of XML.Reader after calling an Openxxx method of XML.Reader. as a new DOM by calling the <method>CreateDocument</method> of this class.
The <class>XML.Node</class> instance that is used to navigate the DOM is created using the <method>GetDocumentElement</method> of <class>XML.Document</class>.

<class>XML.Node</class> navigates through the nodes of the DOM rather than representing a fixed node in a DOM tree. The MoveToxxx methods are used to move through the DOM. The properties and methods of <class>XML.Node</class> are then used to retrieve and modify the node contents.

Member Function Documentation

◆ AppendCharacter()

AppendCharacter	(	_.Library.String	text,
		_.Library.Boolean	raw,
		_.Library.String	parent
	)

Append new character data node to the list of children of this element node.

The current node pointer does not change. This node is still the parent of the appended child.
If raw is true, the node is marked as $$$xmlRAWTEXTNODE
parent is for internal use only.

◆ AppendElement()

AppendElement	(	_.Library.String	localName,
		_.Library.String	namespace,
		_.Library.String	text,
		_.Library.String	qname
	)

Append new element node to the list of children of this node.

If the text argument is specified, then character data is added as the child of the new element. The current node pointer does not change. This node is still the parent of the appended child.

◆ AppendNode()

_.Library.Status AppendNode ( _.XML.Node sourceNode )

Append a copy of the specified node to the list of children of this node.

The node to copy may be from any document. The current node pointer does not change. This node is still the parent of the appended child.

◆ AppendTree()

_.Library.Status AppendTree ( _.XML.Node sourceNode )

Append a copy of the specified node, including all its children, to the list of children of this node.

The tree to copy may be from any document, but this node may not be a descendant of the source node. The current node pointer does not change. This node is still the parent of the appended child.

◆ GetAttribute()

GetAttribute	(	_.Library.String	attributeName,
		_.Library.String	namespace,
		_.Library.String	value,
		_.Library.String	valueNamespace
	)

Return attribute data of attribute named attributeName for this element.

namespace is the namespace URI from QName of attribute named attributeName for this element. value is the attribute value. valueNamespace is the namespace URI corresponding to the prefix when the attribute value is of the form "prefix:value".

◆ GetAttributeNS()

GetAttributeNS	(	_.Library.String	attributeName,
		_.Library.String	namespace,
		_.Library.String	value,
		_.Library.String	valueNamespace
	)

Return attribute data of attribute named attributeName in namespace for this element.

value is the attribute value. valueNamespace is the namespace URI corresponding to the prefix when the attribute value is of the form "prefix:value".

◆ GetText()

_.Library.Boolean GetText	(		text,
		_.Library.Boolean	mixed
	)

Get the text contents of an element node.

GetText returns false if an error is encountered in evaluating the node.
GetText returns true if text is found. The text which is found may be the empty string. The found text is appended to the text argument. The text argument is created if it is not already defined. If the mixed argument is = 1, then the mixed character and element content in the current node is returned in the text argument.

◆ InsertCharacter()

_.Library.String InsertCharacter	(	_.Library.String	text,
		_.Library.String	child
	)

Insert a new character data node to the list of children of this element node.

The new character data is inserted just before the specified child node. The child node is specified by passing its NodeId. The child node is passed by reference so that it may be updated with a new NodeId after the insert. The nodeId of the inserted character data node is returned. The current node pointer does not change. This node is still the parent of the appended child.

◆ InsertElement()

_.Library.String InsertElement	(	_.Library.String	localName,
		_.Library.String	namespace,
		_.Library.String	child,
		_.Library.String	text,
		_.Library.String	qname
	)

Insert a new element node to the list of children of this node.

The new element is inserted just before the specified child node. The child node is specified by passing its NodeId. The child node is passed by reference so that it may be updated with a new NodeId after the insert. The nodeId of the inserted element is returned. If the text argument is specified, then character data is added as the child of the new element. The current node pointer does not change. This node is still the parent of the appended child.

◆ InsertNode()

_.Library.String InsertNode	(	_.XML.Node	sourceNode,
		_.Library.String	child,
		_.Library.Status	sc
	)

Insert a copy of the specified node to the list of children of this node.

The node to copy may be from any document. The new node is inserted just before the specified child node. The child node is specified by passing its NodeId. The child node is passed by reference so that it may be updated with a new NodeId after the insert. The nodeId of the inserted node is returned. The current node pointer does not change.

◆ InsertTree()

_.Library.String InsertTree	(	_.XML.Node	sourceNode,
		_.Library.String	child,
		_.Library.Status	sc
	)

Insert a copy of the specified node, including its children, to the list of children of this node.

The tree to copy may be from any document, but this node may not be a descendant of the source node. The new node is inserted just before the specified child node. The child node is specified by passing its NodeId. The child node is passed by reference so that it may be updated with a new NodeId after the insert. The nodeId of the inserted node is returned. The current node pointer does not change.

◆ MoveToFirstChild()

_.Library.Boolean MoveToFirstChild ( _.Library.Boolean skipWhitespace )

Move node to current node's first child node.

Optionally skip whitespace nodes.

◆ MoveToLastChild()

_.Library.Boolean MoveToLastChild ( _.Library.Boolean skipWhitespace )

Move node to current node's last child node.

Optionally skip whitespace nodes.

◆ MoveToNextSibling()

_.Library.Boolean MoveToNextSibling ( _.Library.Boolean skipWhitespace )

Move node to current node's next sibling.

Optionally skip whitespace nodes.

◆ MoveToParent()

_.Library.Boolean MoveToParent ( _.Library.Boolean restrictDocumentNode )

Move node to current node's parent.

If restrictDocumentNode is true, then MoveTopParent will not move to document node.

◆ MoveToPreviousSibling()

_.Library.Boolean MoveToPreviousSibling ( _.Library.Boolean skipWhitespace )

Move node to current node's previous sibling.

Optionally skip whitespace nodes.

◆ ReplaceNode()

_.Library.Status ReplaceNode ( _.XML.Node sourceNode )

Replace this node with a copy of the specified node.

The node to copy may be from any document. The current node pointer does not change.

◆ ReplaceTree()

_.Library.Status ReplaceTree ( _.XML.Node sourceNode )

Replace this node with a copy of the specified node including all its children.

The tree to copy may be from any document, but this node may not be a descendant of the source node. The current node pointer does not change.

◆ SetAttribute()

SetAttribute	(	_.Library.String	attributeName,
		_.Library.String	namespace,
		_.Library.String	value,
		_.Library.String	valueNamespace
	)

Set attribute data of attribute named attributeName for this element.

namespace is the namespace URI from QName of attribute named attributeName for this element. value is the attribute value. valueNamespace is the namespace URI corresponding to the prefix when the attribute value is of the form "prefix:value".

Member Data Documentation

◆ Document

Document

The DOM that this XML.Node instance is navigating.

The Document property may be

set to change which DOM is being navigated. When the Document is set, XML.Node is positioned at the document node, i.e. the parent of the root element.

◆ LocalName

LocalName

Local name for element node.

◆ Namespace

Namespace

XML namespace for element node.

◆ NamespaceIndex

NamespaceIndex

Index into XML namespace table for element node.

◆ Nil

Nil

True if xsi:nil or xsi:null specified as true or 1 for this element node.

◆ NodeData

NodeData

Value of a character node.

◆ NodeId

NodeId

The id of the current node.

The NodeId property may be set in order to move the specified node.

◆ NodeType

NodeType

Type of node: $$$xmlELEMENTNODE, $$$xmlTEXTNODE, $$$xmlWHITESPACENODE.

◆ QName

QName

Qname for element node.

Only used for output as XML when the prefix is valid for the document.

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AppendCharacter()

◆ AppendElement()

◆ AppendNode()

◆ AppendTree()

◆ GetAttribute()

◆ GetAttributeNS()

◆ GetText()

◆ InsertCharacter()

◆ InsertElement()

◆ InsertNode()

◆ InsertTree()

◆ MoveToFirstChild()

◆ MoveToLastChild()

◆ MoveToNextSibling()

◆ MoveToParent()

◆ MoveToPreviousSibling()

◆ ReplaceNode()

◆ ReplaceTree()

◆ SetAttribute()

Member Data Documentation

◆ Document

◆ LocalName

◆ Namespace

◆ NamespaceIndex

◆ Nil

◆ NodeData

◆ NodeId

◆ NodeType

◆ QName