XmlDoc (XmlNodelist 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>XmlDoc object of XmlNode or XmlNodelist</b></span>
{{Template:XmlNodelist:XmlDoc subtitle}}
[[Category:XmlNodelist methods|XmlDoc function]]
[[Category:XmlNodelist methods|XmlDoc function]]
[[Category:XmlDoc API methods]]
[[Category:XmlDoc API methods]]


This function returns the <var>xmlDoc</var> associated with the method object.
This function returns the <var>xmlDoc</var> associated with the method object.
===Syntax===
==Syntax==
  %doc = nod:XmlDoc
{{Template:XmlNodelist:XmlDoc syntax}}
 
===Syntax terms===
  %doc = nlis:XmlDoc
 
====Syntax Terms====
<dl>
<dl>
<dt>%doc
<dt>%doc
Line 21: Line 18:
</dl>
</dl>


===Usage Notes===
==Usage notes==
<ul>
<ul>
<li>The <var>xmlDoc</var> function can be used when it is necessary to get or set <var>xmlDoc</var> properties
<li>The <var>xmlDoc</var> function can be used when it is necessary to get or set <var>xmlDoc</var> properties
Line 27: Line 24:
</ul>
</ul>


===Examples===
==Examples==
You can use the XmlDoc function to access the Root node (and then, optionally, to use an XPath expression which is in effect an absolute expression) with an empty <var>xmlNodelist</var>, as in the following example:
You can use the XmlDoc function to access the Root node (and then, optionally, to use an XPath expression which is in effect an absolute expression) with an empty <var>xmlNodelist</var>, as in the following example:
<p class="code">local subroutine (xmlNodelist):display
<p class="code">local subroutine (xmlNodelist):display

Revision as of 15:31, 23 January 2011

Get the XmlDoc associated with this nodelist (XmlNodelist class)

This function returns the xmlDoc associated with the method object.

Syntax

%doc = nodl:XmlDoc

Syntax terms

%doc
An XmlDoc, which will be set to point to the document associated with nod or nlis.
nod
An XmlNode expression.
nlis
An XmlNodelist expression.

Usage notes

  • The xmlDoc function can be used when it is necessary to get or set xmlDoc properties (such as namespace) given an xmlNodelist.

Examples

You can use the XmlDoc function to access the Root node (and then, optionally, to use an XPath expression which is in effect an absolute expression) with an empty xmlNodelist, as in the following example:

local subroutine (xmlNodelist):display if %this:count eq 0 then printText Nodelist empty, here is the document: %this:xmlDoc:print else ... end if

Request-Cancellation Errors

  • XmlDoc has no request cancellation errors.