XmlDoc methods syntax: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Automatically generated page update)
m (Automatically generated page update)
Line 49: Line 49:
<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">:[[Print (XmlDoc/XmlNode subroutine)|Print]]</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">:[[Print (XmlDoc/XmlNode subroutine)|Print]]</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="literal">%(XmlDoc):[[PrintSchema (XmlDoc subroutine)|PrintSchema]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">string</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="literal">%(XmlDoc):[[PrintSchema (XmlDoc subroutine)|PrintSchema]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">string</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">%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">%object</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">%object</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>

Revision as of 15:01, 24 January 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.

[%object=] nr:AddComment( comment)

[%object=] nr:AddElement( name, [value], [uri])

[%object=] nr:AddPI( name, value)

[%object=] nr:AddSubtree( xmlNode, [DefaultURI= unicode])

doc:AddToRecord[( [DisableFieldConstraints= boolean], [CopyIDs= boolean], - [IgnoreUndefinedFields= boolean])]

[%object=] doc:AddTopElement( name, [uri], [MoveNamespace= boolean])

%xmlAdjacentTextSetting= doc:AdjacentText

%boolean= doc:AllowNull

%boolean= doc:AllowXmlElement

nr:Audit[( [xpath], [options])]

%object= %(XmlDoc):ClientCertificate[( [AttributeValues= boolean], - [AttributeNames= boolean])]

%object= doc:Copy

[%number=] doc:Debug[( [options], [length])]

%object= doc:DeepCopy

%unicode= nr:DefaultURI[( [xpath])]

doc:DeleteSelectionPrefix( prefix)

nr:DeleteSubtree[( [unicode])]

doc:DeleteTopElement

%string= doc:Encoding

%boolean= nr:Exists( unicode)

%xmlInvalidChar= doc:InvalidChar

%D: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( stringlist, [string])

doc:LoadParameterInfo[( [string], [string])]

doc:LoadSystemMethodInfo( pattern, [ShowBase= boolean])

[%number=] nr:LoadXml( string, [string])

%unicode= nr:LocalName[( [name])]

%xmlNamespaceSetting= doc:Namespace

%doc= %(XmlDoc):New

%object= %(XmlDoc):NewFromRecord[( [AttributeValues= boolean], - [AttributeNames= boolean], - [NamesToLower= boolean], - [AllowUnreversible= boolean], - [CodepageTable= boolean], - [AllowNull= boolean])]

%unicode= nr:Prefix[( [prefix])]

%unicode= nr:PrefixURI( prefix, [xpath])

nr:Print[( [xpath], [options])]

%(XmlDoc):PrintSchema[( [string])]

%unicode= nr:QName[( [qName])]

%number= nr:SelectCount( unicode)

%object= nr:SelectNodes[( [xpath])]

%object= nr:SelectSingleNode[( [xpath])]

%unicode= doc:SelectionNamespace( uri)

%string= nr:Serial[( [xpath], [options], [AddTrailingDelimiter= boolean])]

%string= doc:Standalone

%string= nr:ToXPathString[( [xpath])]

%object= 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])]

%string= doc:Version

[%D:position=] doc:WebReceive[( [fieldname], [occurrence], [options])]

doc:WebSend[( [options])]

%object= nr:XPathNodeID[( [xpath])]

%xPathSingleHint= doc:XPathSingleHint

%string= doc:Xml[( [options])]

%D:id= doc:XmlDocID