XMLDocumentMBS.adoptNode(node as XMLNodeMBS) as XMLNodeMBS

If the node has a parent it is first removed from its parent child list. This effectively allows moving a subtree from one document to another.
Should not be needed in Xojo apps.

XMLDocumentMBS.ElementsByTagName(TagName as String) as XMLElementMBS()

Var xml As String = "<test id=""123""><f>1</f><f>2</f><f>3</f><f>4</f></test>"
Var doc As New XMLDocumentMBS(xml)

Var elements() As XMLElementMBS = doc.ElementsByTagName("f")

Break

TagName: The tag name of the elements to match on. The special value "*" matches all local names.

Returns a new array object containing all the matched XMLElementMBS(s).

XMLDocumentMBS.ElementsByTagNameNS(namespaceURI as string, localName as String) as XMLElementMBS()

namespaceURI: The namespace URI of the elements to match on. The special value "*" matches all namespaces.
localName: The local name of the elements to match on. The special value "*" matches all local names.

Returns a new array object containing all the matched XMLElementMBS(s).

XMLDocumentMBS.evaluate(expression as String, contextNode as XMLNodeMBS, type as Integer) as XMLXPathResultMBS

expression: The XPath expression string to be parsed and evaluated.
contextNode: The context is context node for the evaluation of this XPath expression. Must be owned by the same document and must be a XMLDocumentMBS, XMLElementMBS, XMLAttributeMBS, XMLTextMBS, XMLCDATASectionMBS, DOMComment, XMLProcessingInstructionMBS, or XPathNamespace node.
type: If a specific type is specified, then the result will be returned as the corresponding type. This must be one of the codes of the XMLXPathResultMBS clas constants.

Retruns result of the evaluation of the XPath expression as XMLXPathResultMBS class.

Raises exception if the expression is not legal according to the rules of the DOMXPathEvaluator.
Raises exception if the result cannot be converted to return the specified type.

XMLDocumentMBS.getElementById(elementId as String) as XMLElementMBS

Var doc As New XMLDocumentMBS("<doc><test id=""1"">abc</test><test id=""2"">def</test></doc>")

// we mark this id attribute to be the id
Var d1 As XMLElementMBS = doc.DocumentElement.FirstElementChild
Call d1.SetIdAttribute("id", True)

// now search for it
Var element1 As XMLElementMBS = doc.getElementById("1")
Var element2 As XMLElementMBS = doc.getElementById("2") // not marked!

Break

If no such element exists, returns nil.
Behavior is not defined if more than one element has this ID. The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return nil.

elementId: The unique id value for an element.

Returns the matching element.

XMLDocumentMBS.importNode(node as XMLNodeMBS) as XMLNodeMBS

You don't need to do this manually as the plugin will do it for you in methods as appendChild, replaceChild and insertBefore.

XMLDocumentMBS.IterateElementsByTagName(TagName as String) as XMLIterateElementsMBS

Var doc As New XMLDocumentMBS("<doc><test id=""1"">abc</test><test id=""2"">def</test></doc>")

For Each e As XMLElementMBS In doc.IterateElementsByTagName("test")
  MessageBox e.toString
Next

For use with For Each Loops in Xojo.

XMLDocumentMBS.IterateElementsByTagNameNS(namespaceURI as string, localName as String) as XMLIterateElementsMBS

For use with For Each Loops in Xojo.

XMLDocumentMBS.LoadXml(data as MemoryBlock)

Replaces current document with the new one.

See also:

• LoadXml(data as String)
• LoadXml(file as FolderItem)

Some examples using this method:

• /XML/XML
• /XML/XML Path Query

XMLDocumentMBS.LoadXml(data as String)

Replaces current document with the new one.

See also:

• LoadXml(data as MemoryBlock)
• LoadXml(file as FolderItem)

XMLDocumentMBS.LoadXml(file as FolderItem)

Replaces current document with the new one.
This may reference other files in same folder.

See also:

• LoadXml(data as MemoryBlock)
• LoadXml(data as String)

XMLDocumentMBS.LoadXmlMT(data as MemoryBlock)

Replaces current document with the new one.

The work is performed on a preemptive thread, so this function does not block the application and can yield time to other Xojo threads. Must be called in a Xojo thread to enjoy benefits. If called in main thread will block, but keep other background threads running.

See also:

• LoadXmlMT(data as String)
• LoadXmlMT(file as FolderItem)

XMLDocumentMBS.LoadXmlMT(data as String)

Replaces current document with the new one.

The work is performed on a preemptive thread, so this function does not block the application and can yield time to other Xojo threads. Must be called in a Xojo thread to enjoy benefits. If called in main thread will block, but keep other background threads running.

See also:

• LoadXmlMT(data as MemoryBlock)
• LoadXmlMT(file as FolderItem)

XMLDocumentMBS.LoadXmlMT(file as FolderItem)

Replaces current document with the new one.
This may reference other files in same folder.

The work is performed on a preemptive thread, so this function does not block the application and can yield time to other Xojo threads. Must be called in a Xojo thread to enjoy benefits. If called in main thread will block, but keep other background threads running.

See also:

• LoadXmlMT(data as MemoryBlock)
• LoadXmlMT(data as String)

XMLDocumentMBS.NodeFromHandle(Handle as Integer) as XMLNodeMBS

Raises exception if this handle doesn't belong to this document.

XMLDocumentMBS.normalizeDocument

This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form. The actual result depends on the features being set. See XMLConfigurationMBS for details.

Noticeably this method normalizes XMLTextMBS nodes, makes the document "namespace wellformed", according to the algorithm described below in pseudo code, by adding missing namespace declaration attributes and adding or changing namespace prefixes, updates the replacement tree of XMLEntityReferenceMBS nodes, normalizes attribute values, etc. <br>Mutation events, when supported, are generated to reflect the changes occurring on the document. Note that this is a partial implementation. Not all the required features are implemented. Currently XMLAttributeMBS and XMLTextMBS nodes are normalized. Features to remove XMLCommentMBS and XMLCDATASectionMBS work.

XMLDocumentMBS.renameNode(node as XMLNodeMBS, namespaceURI as String, qualifiedName as String) as XMLNodeMBS

When possible this simply changes the name of the given node, otherwise this creates a new node with the specified name and replaces the existing node with the new node as described below. This only applies to nodes of type ELEMENT_NODE and ATTRIBUTE_NODE.

When a new node is created, the following operations are performed: the new node is created, any registered event listener is registered on the new node, any user data attached to the old node is removed from that node, the old node is removed from its parent if it has one, the children are moved to the new node, if the renamed node is an XMLElementMBS its attributes are moved to the new node, the new node is inserted at the position the old node used to have in its parent's child nodes list if it has one, the user data that was attached to the old node is attach to the new node, the user data event NODE_RENAMED is fired.

When the node being renamed is an XMLAttributeMBS that is attached to an XMLElementMBS, the node is first removed from the XMLElementMBS attributes map. Then, once renamed, either by modifying the existing node or creating a new one as described above, it is put back.

node: The node to rename.
namespaceURI: The new namespaceURI.
qualifiedName: The new qualified name.