Next (XmlNode function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
<span style="font-size:120%; color:black"><b>Next XmlNode</b></span>
{{Template:XmlNode:Next subtitle}}
[[Category:XmlNode methods|Next function]]
[[Category:XmlNode methods|Next function]]
[[Category:XmlDoc API methods]]
[[Category:XmlDoc API methods]]
Line 20: Line 20:
Attribute
Attribute
node produced if the Element containing the method object
node produced if the Element containing the method object
were serialized in &ldquo;normal&rdquo; (that is, ''not'' ExclCanonical) order.
were serialized in "normal" (that is, ''not'' ExclCanonical) order.
<li>If no &ldquo;next&rdquo; node exists, the Next method returns a Null.
<li>If no "next" node exists, the Next method returns a Null.
</ul>
</ul>


The Next function is new as of version 7.0 of the ''Sirius Mods''.
The Next function is new as of version 7.0 of the ''Sirius Mods''.
===Syntax===
==Syntax==
  %nod = nod:Next
{{Template:XmlNode:Next syntax}}
 
===Syntax terms===
====Syntax Terms====
<dl>
<dl>
<dt>%nod
<dt>%nod
Line 37: Line 36:
</dl>
</dl>


===Usage Notes===
==Usage notes==
<ul>
<ul>
<li>If no &ldquo;next&rdquo; node exists, the Next method returns a Null.
<li>If no "next" node exists, the Next method returns a Null.
<li>The XPath recommendation specifies that
<li>The XPath recommendation specifies that
the following-sibling and preceding-sibling axes are the empty nodeSet when
the following-sibling and preceding-sibling axes are the empty nodeSet when
Line 50: Line 49:
</ul>
</ul>


===Examples===
==Examples==
<ol>
<ol>
<li>Given the following document:
<li>Given the following document:

Revision as of 16:58, 22 January 2011

Get the next node after this node (XmlNode class)

Next is a member of the XmlNode class.

This function returns the next XmlNode with the same parent as the method object.

  • If the method object is a non-Attribute node, the next XmlNode is the next sibling (in document order) of the method object. This is exactly the same as the node returned by SelectSingleNode with an argument of 'following-sibling::node()'
  • If the method object is an Attribute node, the next XmlNode is the next Attribute node produced if the Element containing the method object were serialized in "normal" (that is, not ExclCanonical) order.
  • If no "next" node exists, the Next method returns a Null.

The Next function is new as of version 7.0 of the Sirius Mods.

Syntax

%outNod = nod:Next

Syntax terms

%nod
An XmlNode, which will be set to point to the returned node.
nod
An XmlNode expression.

Usage notes

  • If no "next" node exists, the Next method returns a Null.
  • The XPath recommendation specifies that the following-sibling and preceding-sibling axes are the empty nodeSet when the context node is an Attribute node. The Next and Previous (?? reftxt="Previous function" refid=previus.) methods are available if you want to traverse the Attribute nodes of an Element, as a better approach than using the following&hyph.sibling and preceding&hyph.sibling axes in an XPath argument to a SelectNodes or SelectSingleNode method. See example ?? refid=attnext..

Examples

  1. Given the following document:
        <top>
          <a/>
          <b/>
          <c/>
          <d/>
          <e/>
        </top>
    

    To select the node that follows Element b, you can use a sequence of statements like the following:

        %n1 is object XmlNode
        %n1 = %doc:SelectSingleNode('/*/*[2]')
        Print 'Here is attribute node 2:'
        %n1:Print
        %n2 = %n1:Next
        Print 'Here is the attribute node after 2:'
        %n2:Print
    

    The result is:

        Here is attribute node 2:
        <b/>
        Here is the attribute node after 2:
        <c/>
    

    Note: The following statement obtains the same result as using Next, above:

        %n2 = %n1:SelectSingleNode('following-sibling::node()')
    

    The following-sibling axis generates resultant nodes in document order (in this case, c, then d), and the SelectSingleNode statement selects the first of these two generated nodes also in document order.

  2. Given the following document:
        <top>
           <F b1="b1" b2="b2" b3="b3" b4="b4"/>
        </top>
    

    To select the Attribute node that follows Attribute b2, you can use the following:

        %n1 = %doc:SelectSingleNode('/*/F/@b2'):Next
        Print 'Here is attribute after b2:'
        %n1:Print
    

    The result is:

        Here is attribute after b2:
        b3="b3"
    

    Note: The following-sibling axis does not locate Attribute nodes. This statement causes a request cancellation:

        %n2 = %n1:SelectSingleNode('following-sibling::node()')