XmlDoc methods syntax: Difference between revisions
m (Automatically generated page update) |
m (Automatically generated page update) |
||
| Line 18: | Line 18: | ||
<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">%doc</span><span class="literal"> =</span> <span class="literal">%(XmlDoc):[[ClientCertificate (XmlDoc function)|ClientCertificate]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="Boolean">AttributeValues=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | <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">%doc</span><span class="literal"> =</span> <span class="literal">%(XmlDoc):[[ClientCertificate (XmlDoc function)|ClientCertificate]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="Boolean">AttributeValues=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="Boolean">AttributeNames=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <span class="squareb">[</span><span class="literal" title="Boolean">AttributeNames=</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">% | <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">%newXmlDoc</span><span class="literal"> =</span> <span class="term">doc</span><span class="literal">:[[Copy (XmlDoc function)|Copy]]</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">%newXmlDoc</span><span class="literal"> =</span> <span class="term">doc</span><span class="literal">:[[DeepCopy (XmlDoc function)|DeepCopy]]</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> | ||
<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">doc</span><span class="literal">:[[DeleteSelectionPrefix (XmlDoc subroutine)|DeleteSelectionPrefix]]</span><span class="literal">(</span> <span class="term" title="Unicode">prefix</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">doc</span><span class="literal">:[[DeleteSelectionPrefix (XmlDoc subroutine)|DeleteSelectionPrefix]]</span><span class="literal">(</span> <span class="term" title="Unicode">prefix</span><span class="literal">)</span></p> | ||
| Line 39: | Line 39: | ||
<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">doc</span><span class="literal">:[[LoadParameterInfo (XmlDoc subroutine)|LoadParameterInfo]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">paramOrFam</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="String">famOrParam</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">doc</span><span class="literal">:[[LoadParameterInfo (XmlDoc subroutine)|LoadParameterInfo]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">paramOrFam</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="String">famOrParam</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">doc</span><span class="literal">:[[LoadSystemMethodInfo (XmlDoc subroutine)|LoadSystemMethodInfo]]</span><span class="literal">(</span> <span class="term" title="String">pattern</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">ShowBase=</span> <span class="term" title="Boolean">boolean</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">doc</span><span class="literal">:[[LoadSystemMethodInfo (XmlDoc subroutine)|LoadSystemMethodInfo]]</span><span class="literal">(</span> <span class="term" title="String">pattern</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">ShowBase=</span> <span class="term" title="Boolean">boolean</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">%errorPosition</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">nr</span><span class="literal">:[[LoadXml (XmlDoc/XmlNode function)|LoadXml]]</span><span class="literal">(</span> <span class="term" title="String">input</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="String"> | <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">%errorPosition</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">nr</span><span class="literal">:[[LoadXml (XmlDoc/XmlNode function)|LoadXml]]</span><span class="literal">(</span> <span class="term" title="String">input</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="String">options</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">%unicode</span><span class="literal"> =</span> <span class="term">nr</span><span class="literal">:[[LocalName (XmlDoc/XmlNode function)|LocalName]]</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">:[[LocalName (XmlDoc/XmlNode function)|LocalName]]</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">%currentXmlNamespaceSetting</span><span class="literal"> =</span> <span class="term">doc</span><span class="literal">:[[Namespace (XmlDoc property)|Namespace]]</span> | <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">%currentXmlNamespaceSetting</span><span class="literal"> =</span> <span class="term">doc</span><span class="literal">:[[Namespace (XmlDoc property)|Namespace]]</span> | ||
Revision as of 21:38, 14 March 2011
The syntax for each of the XmlDoc 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 methods.
[%nod =] nr:AddComment( value)
[%nod =] nr:AddElement( name, [value], [uri])
[%nod =] nr:AddPI( name, value)
[%nod =] nr:AddSubtree( sourceSubtreeNode, [DefaultURI= unicode])
doc:AddToRecord[( [DisableFieldConstraints= boolean], [CopyIDs= boolean], - [IgnoreUndefinedFields= boolean])]
[%nod =] doc:AddTopElement( name, [uri], [MoveNamespace= boolean])
%currentXmlAdjacentTextSetting = doc:AdjacentText doc:AdjacentText = newXmlAdjacentTextSetting
%currentBoolean = doc:AllowNull doc:AllowNull = newBoolean
%currentBoolean = doc:AllowXmlElement doc:AllowXmlElement = newBoolean
nr:Audit[( [xpath], [options])]
%doc = %(XmlDoc):ClientCertificate[( [AttributeValues= boolean], - [AttributeNames= boolean])]
%newXmlDoc = doc:Copy
%newXmlDoc = doc:DeepCopy
%unicode = nr:DefaultURI[( [xpath])]
doc:DeleteSelectionPrefix( prefix)
nr:DeleteSubtree[( [xpath])]
doc:DeleteTopElement
%currentString = doc:Encoding doc:Encoding = newString
%boolean = nr:Exists( xpath)
%currentXmlInvalidChar = doc:InvalidChar doc:InvalidChar = newXmlInvalidChar
%position = %(XmlDoc):InvalidCharacterPosition( string, [AllowNull= boolean])
%boolean = doc:IsSelectionPrefix( prefix)
%boolean = %(XmlDoc):IsValidString( string, [AllowNull= boolean])
%number = nr:Length[( [xpath])]
nr:LoadFromRecord[( [AttributeValues= boolean], [AttributeNames= boolean], - [NamesToLower= boolean], [AllowUnreversible= boolean], - [CodepageTable= boolean])]
[%number =] nr:LoadFromStringlist( sl, [string])
doc:LoadParameterInfo[( [paramOrFam], [famOrParam])]
doc:LoadSystemMethodInfo( pattern, [ShowBase= boolean])
[%errorPosition =] nr:LoadXml( input, [options])
%unicode = nr:LocalName[( [xpath])]
%currentXmlNamespaceSetting = doc:Namespace doc:Namespace = newXmlNamespaceSetting
%doc = %(XmlDoc):New
%doc = %(XmlDoc):NewFromRecord[( [AttributeValues= boolean], - [AttributeNames= boolean], - [NamesToLower= boolean], - [AllowUnreversible= boolean], - [CodepageTable= boolean], - [AllowNull= boolean])]
%unicode = nr:Prefix[( [xpath])]
%unicode = nr:PrefixURI( prefix, [xpath])
nr:Print[( [xpath], [options])]
%unicode = nr:QName[( [xpath])]
%number = nr:SelectCount( xpath)
%nodl = nr:SelectNodes[( [xpath])]
%nod = nr:SelectSingleNode[( [xpath])]
%currentUnicode = doc:SelectionNamespace( prefix) doc:SelectionNamespace( prefix) = newUnicode
%string = nr:Serial[( [xpath], [options], [AddTrailingDelimiter= boolean])]
%currentString = doc:Standalone doc:Standalone = newString
%string = nr:ToXPathString[( [selectionXpath])]
%sl = nr:ToXPathStringlist[( [selectionXpath])]
nr:Trace[( [xpath], [options])]
%xmlNodeType = nr:Type[( [xpath])]
%unicode = nr:URI[( [xpath])]
%currentUnicode = nr:Value[( [xpath])] nr:Value[( [xpath])] = newUnicode
%unicode = nr:ValueDefault[( [xpath], [value])]
%currentString = doc:Version doc:Version = newString
[%errorPosition =] doc:WebReceive[( [formFieldname], [fieldOccurrence], - [options])]
doc:WebSend[( [options])]
%sl = nr:XPathNodeID[( [selectionXpath])]
%string = doc:Xml[( [options])]