XmlDoc/XmlNode methods syntax: Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
m (Automatically generated page update) |
||
| Line 2: | Line 2: | ||
replaced, so any manual edits will be lost. You've been warned. --> | replaced, so any manual edits will be lost. You've been warned. --> | ||
{{Template:Syntax list header|class=XmlDoc/XmlNode}} | {{Template:Syntax list header|class=XmlDoc/XmlNode}} | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top:1px solid;"><span class="squareb">[</span><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top:1px solid;"><span class="squareb">[</span><span class="term">%xmlNode</span><span class="literal">=</span><span class="squareb">]</span> <span class="term">nr</span><span class="literal">:[[AddComment (XmlDoc/XmlNode function)|AddComment]]</span><span class="literal">(</span> <span class="term" title="Unicode">comment</span><span class="literal">)</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%xmlNode</span><span class="literal">=</span><span class="squareb">]</span> <span class="term">nr</span><span class="literal">:[[AddElement (XmlDoc/XmlNode function)|AddElement]]</span><span class="literal">(</span> <span class="term" title="Unicode">name</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="Unicode">value</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="Unicode">uri</span><span class="squareb">]</span><span class="literal">)</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%xmlNode</span><span class="literal">=</span><span class="squareb">]</span> <span class="term">nr</span><span class="literal">:[[AddPI (XmlDoc/XmlNode function)|AddPI]]</span><span class="literal">(</span> <span class="term" title="Unicode">name</span><span class="comma">,</span> <span class="term" title="Unicode">value</span><span class="literal">)</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%xmlNode</span><span class="literal">=</span><span class="squareb">]</span> <span class="term">nr</span><span class="literal">:[[AddSubtree (XmlDoc/XmlNode function)|AddSubtree]]</span><span class="literal">(</span> <span class="term" title="XmlNode">xmlNode</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Unicode">DefaultURI=</span> <span class="term" title="Unicode">unicode</span><span class="squareb">]</span><span class="literal">)</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">nr</span><span class="literal">:[[Audit (XmlDoc/XmlNode subroutine)|Audit]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="String">options</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">nr</span><span class="literal">:[[Audit (XmlDoc/XmlNode subroutine)|Audit]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="String">options</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%unicode</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[DefaultURI (XmlDoc/XmlNode function)|DefaultURI]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%unicode</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[DefaultURI (XmlDoc/XmlNode function)|DefaultURI]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
| Line 22: | Line 22: | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%unicode</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[QName (XmlDoc/XmlNode function)|QName]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">qName</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%unicode</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[QName (XmlDoc/XmlNode function)|QName]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">qName</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%number</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[SelectCount (XmlDoc/XmlNode function)|SelectCount]]</span><span class="literal">(</span> <span class="term" title="Unicode">unicode</span><span class="literal">)</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%number</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[SelectCount (XmlDoc/XmlNode function)|SelectCount]]</span><span class="literal">(</span> <span class="term" title="Unicode">unicode</span><span class="literal">)</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%xmlNodelist</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[SelectNodes (XmlDoc/XmlNode function)|SelectNodes]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%xmlNode</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[SelectSingleNode (XmlDoc/XmlNode function)|SelectSingleNode]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[Serial (XmlDoc/XmlNode function)|Serial]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="String">options</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">AddTrailingDelimiter=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[Serial (XmlDoc/XmlNode function)|Serial]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="String">options</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">AddTrailingDelimiter=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[ToXPathString (XmlDoc/XmlNode function)|ToXPathString]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[ToXPathString (XmlDoc/XmlNode function)|ToXPathString]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%stringlist</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[ToXPathStringlist (XmlDoc/XmlNode function)|ToXPathStringlist]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">nr</span><span class="literal">:[[Trace (XmlDoc/XmlNode subroutine)|Trace]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="String">options</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">nr</span><span class="literal">:[[Trace (XmlDoc/XmlNode subroutine)|Trace]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="String">options</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%xmlNodeType</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[Type (XmlDoc/XmlNode function)|Type]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%xmlNodeType</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[Type (XmlDoc/XmlNode function)|Type]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
| Line 33: | Line 33: | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%unicode</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[Value (XmlDoc/XmlNode property)|Value]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%unicode</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[Value (XmlDoc/XmlNode property)|Value]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%unicode</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[ValueDefault (XmlDoc/XmlNode function)|ValueDefault]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="Unicode">value</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%unicode</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[ValueDefault (XmlDoc/XmlNode function)|ValueDefault]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="Unicode">value</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%stringlist</span><span class="literal">=</span> <span class="term">nr</span><span class="literal">:[[XPathNodeID (XmlDoc/XmlNode function)|XPathNodeID]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Unicode">xpath</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
Revision as of 04:52, 28 January 2011
The syntax for each of the XmlDoc/XmlNode class methods is shown below.
Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of XmlDoc/XmlNode methods.
[%xmlNode=] nr:AddComment( comment)
[%xmlNode=] nr:AddElement( name, [value], [uri])
[%xmlNode=] nr:AddPI( name, value)
[%xmlNode=] nr:AddSubtree( xmlNode, [DefaultURI= unicode])
nr:Audit[( [xpath], [options])]
%unicode= nr:DefaultURI[( [xpath])]
nr:DeleteSubtree[( [unicode])]
%boolean= nr:Exists( unicode)
%number= nr:Length[( [xpath])]
nr:LoadFromRecord[( [AttributeValues= boolean], [AttributeNames= boolean], - [NamesToLower= boolean], [AllowUnreversible= boolean], - [CodepageTable= boolean])]
[%number=] nr:LoadFromStringlist( stringlist, [string])
[%number=] nr:LoadXml( string, [string])
%unicode= nr:LocalName[( [name])]
%unicode= nr:Prefix[( [prefix])]
%unicode= nr:PrefixURI( prefix, [xpath])
nr:Print[( [xpath], [options])]
%unicode= nr:QName[( [qName])]
%number= nr:SelectCount( unicode)
%xmlNodelist= nr:SelectNodes[( [xpath])]
%xmlNode= nr:SelectSingleNode[( [xpath])]
%string= nr:Serial[( [xpath], [options], [AddTrailingDelimiter= boolean])]
%string= nr:ToXPathString[( [xpath])]
%stringlist= nr:ToXPathStringlist[( [xpath])]
nr:Trace[( [xpath], [options])]
%xmlNodeType= nr:Type[( [xpath])]
%unicode= nr:URI[( [xpath])]
[%number=] nr:Validate( schema, [options])
%unicode= nr:Value[( [xpath])]
%unicode= nr:ValueDefault[( [xpath], [value])]
%stringlist= nr:XPathNodeID[( [xpath])]