XMLNode

From Xojo Documentation

You are currently browsing the old Xojo documentation site. Please visit the new Xojo documentation site!

Class (inherits from Object)

XMLNode is the base class for most of the XML Document Object Model (DOM) classes and implements many of the common properties and functions of a DOM node. This class won’t usually be instantiated directly. Most objects will be created from methods of the XMLDocument class.

Properties
ChildCount fa-lock-32.png Name Prefix fa-lock-32.png
FirstChild fa-lock-32.png NamespaceURI fa-lock-32.png PreviousSibling fa-lock-32.png
LastChild fa-lock-32.png NextSibling fa-lock-32.png ToString fa-lock-32.png
LastError fa-lock-32.png OwnerDocument fa-lock-32.png Type fa-lock-32.png
LocalName fa-lock-32.png Parent fa-lock-32.png Value


Methods
AppendChild GetAttributeNode SetAttribute
Child Insert SetAttributeNode
Clone RemoveAttributeNode XQL
Compare RemoveChild
GetAttribute ReplaceChild

Notes

Note that not every property is utilized on every node type. For example, the Value property is used on an XMLAttribute and XMLTextNode, but not an XMLElement.

Sample Code

The following XML:

  <?xml version="1.0" encoding="UTF-8"?>
  <League>
  	<Team name="Seagulls">
  		<Player name="Bob" position="1B" />
  		<Player name="Tom" position="2B" />
  	</Team>
  	<Team name="Pigeons">
  		<Player name="Bill" position="1B" />
  		<Player name="Tim" position="2B" />
  	</Team>
  	<Team name="Crows">
  		<Player name="Ben" position="1B" />
  		<Player name="Ty" position="2B" />
  	</Team>
  </League>

Can be created using this code, which displays the XML to a TextArea and prompts you to save it to a file:

Var xml As New XmlDocument

Var root As XmlNode
root = xml.AppendChild(xml.CreateElement("League"))

Var teamNode As XmlNode
Var playerNode As XmlNode

// Create 1st team and its players
teamNode = root.AppendChild(xml.CreateElement("Team"))
teamNode.SetAttribute("name", "Seagulls")

playerNode = teamNode.AppendChild(xml.CreateElement("Player"))
playerNode.SetAttribute("name", "Bob")
playerNode.SetAttribute("position", "1B")

playerNode = teamNode.AppendChild(xml.CreateElement("Player"))
playerNode.SetAttribute("name", "Tom")
playerNode.SetAttribute("position", "2B")

// Create 2nd team and its players
teamNode = root.AppendChild(xml.CreateElement("Team"))
teamNode.SetAttribute("name", "Pigeons")

playerNode = teamNode.AppendChild(xml.CreateElement("Player"))
playerNode.SetAttribute("name", "Bill")
playerNode.SetAttribute("position", "1B")

playerNode = teamNode.AppendChild(xml.CreateElement("Player"))
playerNode.SetAttribute("name", "Tim")
playerNode.SetAttribute("position", "2B")

// Create 3rd team and its players
teamNode = root.AppendChild(xml.CreateElement("Team"))
teamNode.SetAttribute("name", "Crows")

playerNode = teamNode.AppendChild(xml.CreateElement("Player"))
playerNode.SetAttribute("name", "Ben")
playerNode.SetAttribute("position", "1B")

playerNode = teamNode.AppendChild(xml.CreateElement("Player"))
playerNode.SetAttribute("name", "Ty")
playerNode.SetAttribute("position", "2B")

TextArea1.Value = xml.ToString

DisplayXML(xml)

This code iterates through the XML created above and displays it in a ListBox:

Sub DisplayXML(xml As XmlDocument)
Var root As XmlNode
root = xml.DocumentElement

XMLList.DeleteAllRows

Var teamNode As XmlNode
Var playerNode As XmlNode
For team As Integer = 0 To root.ChildCount-1

// Add Team name
teamNode = root.Child(team)
XMLList.AddRow(teamNode.GetAttribute("name"))

// Add Players
For player As Integer = 0 To teamNode.ChildCount-1
playerNode = teamNode.Child(player)
XMLList.AddRow(playerNode.GetAttribute("name"), _
playerNode.GetAttribute("position"))
Next

Next
End Sub

Compatibility

All project types on all operating systems.

See Also

XMLDocument, XMLElement, XMLNodeList classes.