xmlNode (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Functions for managing XML files

Declaring an xmlNode variable

Properties specific to the description of xmlNode variables

See also

xmlNode (Type of variable)

In french: xmlNoeud

The xmlNode type is used to handle a node of an XML document. The characteristics of this node can be defined and modified by several WLanguage properties.

This type of variable is used by:

the xmlDocument type.
Versions 21 and later
the xpathResult type.
New in version 21
the xpathResult type.
the xpathResult type.

Remark: See Declaring a variable for more details on the declaration of this type of variable and the use of WLanguage properties.

Example

MyXMLText is string = [
<?xml version="1.0"?>
<!DOCTYPE PLAY SYSTEM "play.dtd">
<PLAY>
<TITLE>The Tragedy of Romeo and Juliet</TITLE>
<ACT><TITLE>ACT I</TITLE>
<PROLOGUE><TITLE>PROLOGUE</TITLE></PROLOGUE>
<SCENE><TITLE>SCENE I. Verona. A public place.</TITLE></SCENE>
</ACT>
<ACT><TITLE>ACT II</TITLE>

<PROLOGUE><TITLE>PROLOGUE</TITLE></PROLOGUE>
<SCENE><TITLE>SCENE I. A lane by the wall of Capulet's orchard.</TITLE></SCENE>
</ACT>
<ACT><TITLE>ACT III</TITLE>

<PROLOGUE><TITLE>PROLOGUE</TITLE></PROLOGUE>
<SCENE><TITLE>SCENE I. A public place.</TITLE></SCENE>
</ACT>
</PLAY>
]

// Load an XML document
RomeoAndJuliet is xmlDocument
RomeoAndJuliet = XMLOpen(MyXMLText, fromString)

// Display the title of acts
Act is xmlNode
FOR EACH Act OF RomeoAndJuliet.PLAY ON Act
Trace(Act.TITLE)
END

// Validation from the schema defined during the declaration
cMyNode is xmlNode, description="ProjectXSDSchema.RootNode"
// The variable can also be declared as follows:
// cMyNode is xmlNode <description="ProjectXSDSchema.RootNode">
cMyNode..Text = "21"
IF XMLValidNode(cMyNode) = False THEN
Error(ErrorInfo())
ELSE
Info("The XML node is valid")
END

Remarks

Declaring an xmlNode variable

The xmlNode variables can be declared by specifying a template node (node in an XSD file). The structure of this document will be read by WINDEV and the automatic completion will be available for the names of nodes in the code editor.

To declare an xmlNode variable with a sample document:

Add the XML or XSD document into the project.
The XML or XSD document appears in the project browser, in the "XML descriptions" branch. You have the ability to see its structure.
Declare the variable as follows:

<Variable name> is xmlNode, description = <Path of node in XSD document>

Remark: the syntax for node declaration can also be obtained by performing a "Drag and Drop" of the node into the project explorer.

The child nodes of the variable can now be directly accessed by their names. These names are automatically proposed by the mechanism for automatic completion of the code editor.

Properties specific to the description of xmlNode variables

The following properties can be used to handle an xmlNode variable:

Name	Type used	Effect

Attribute	Array of xmlAttribute	Array of XML attributes associated with the node.
Exist	Boolean	True if the node exists, False otherwise. This property is used for example to check the existence of a specific child of a document node. This property is available in read-only.
Namespace	xmlNamespace variable	XML namespace of node.
NamespaceDeclared	Array of xmlNamespace	Array of XML namespaces declared by the node.
ChildNode	Array of xmlNode	Array of child nodes.
Name	UNICODE character string	Name of node.
Occurrence	Integer	Number of nodes of same level and with the same name in the XML document. This property is available in read-only.
XMLSource	UNICODE character string	Fragment of XML code corresponding to the node. This property also returns the XML code of the child nodes. This property is available in read-only.
Text	UNICODE character string	Text found in the node.
Type	Integer	Type of node. The possible types are as follows: XMLTag (default value): Simple XML node that may contain children. For example: <NODE> <CHILDNODE> </CHILDNODE> </NODE> XMLText: XML node containing text. For example: <NODE> Text </NODE> XMLCDATA: XML node containing data that must be ignored by the XML analyzer. For example: <NODE><![CDATA[This data is not processed by the XML analyzer.]]> </NODE> Remarks: The type can be assigned once only. Then, the property is read-only. If ..Name is assigned, the node will automatically be an XMLTag node. If ..Text is assigned, the node will automatically be an XMLText node. When assigning ..Text, all the child nodes whose type is XMLText and XMLCData are deleted.

Remark: These properties can be used with one of the following syntaxes:

<Variable name>..<Property name>
<Variable name>.<Property name>