List of XmlDoc API methods: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
(Make entry for $function XmlDoc method)
 
(3 intermediate revisions by one other user not shown)
Line 11: Line 11:
<tr><td valign="top">[[AddSubtree (XmlDoc/XmlNode function)|AddSubtree]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Copy subtree to XmlDoc Root or to Element XmlNode</td></tr>
<tr><td valign="top">[[AddSubtree (XmlDoc/XmlNode function)|AddSubtree]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Copy subtree to XmlDoc Root or to Element XmlNode</td></tr>
<tr><td valign="top">[[AddText (XmlNode function)|AddText]]</td><td valign="top">XmlNode</td><td valign="top">Add Text child to Element node</td></tr>
<tr><td valign="top">[[AddText (XmlNode function)|AddText]]</td><td valign="top">XmlNode</td><td valign="top">Add Text child to Element node</td></tr>
<tr><td valign="top">[[AddTopElement (XmlDoc function)|AddTopElement]]</td><td valign="top">XmlDoc</td><td valign="top">Add new top element to XmlDoc</td></tr>
<tr><td valign="top">[[AddToRecord (XmlDoc subroutine)|AddToRecord]]</td><td valign="top">XmlDoc</td><td valign="top">Add fields and/or fieldgroups to the current record</td></tr>
<tr><td valign="top">[[AddToRecord (XmlDoc subroutine)|AddToRecord]]</td><td valign="top">XmlDoc</td><td valign="top">Add fields and/or fieldgroups to the current record</td></tr>
<tr><td valign="top">[[AddTopElement (XmlDoc function)|AddTopElement]]</td><td valign="top">XmlDoc</td><td valign="top">Add new top element to XmlDoc</td></tr>
<tr><td valign="top">[[AdjacentText (XmlDoc property)|AdjacentText]]</td><td valign="top">XmlDoc</td><td valign="top">Are adjacent text nodes allowed?</td></tr>
<tr><td valign="top">[[AdjacentText (XmlDoc property)|AdjacentText]]</td><td valign="top">XmlDoc</td><td valign="top">Are adjacent text nodes allowed?</td></tr>
<tr><td valign="top">[[AllowNull (XmlDoc property)|AllowNull]]</td><td valign="top">XmlDoc</td><td valign="top">Allow null characters in node values?</td></tr>
<tr><td valign="top">[[AllowNull (XmlDoc property)|AllowNull]]</td><td valign="top">XmlDoc</td><td valign="top">Allow null characters in node values?</td></tr>
Line 46: Line 46:
<tr><td valign="top">[[LoadFromRecord (XmlDoc/XmlNode subroutine)|LoadFromRecord]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Load fields and fieldgroups from current record</td></tr>
<tr><td valign="top">[[LoadFromRecord (XmlDoc/XmlNode subroutine)|LoadFromRecord]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Load fields and fieldgroups from current record</td></tr>
<tr><td valign="top">[[LoadFromStringlist (XmlDoc/XmlNode function)|LoadFromStringlist]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Deserialize Stringlist into XmlDoc (obsolete)</td></tr>
<tr><td valign="top">[[LoadFromStringlist (XmlDoc/XmlNode function)|LoadFromStringlist]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Deserialize Stringlist into XmlDoc (obsolete)</td></tr>
<tr><td valign="top">[[LoadMessageInfo (XmlDoc subroutine)|LoadMessageInfo]]</td><td valign="top">XmlDoc</td><td valign="top">Load message info into this XmlDoc</td></tr>
<tr><td valign="top">[[LoadMsgctl (XmlDoc subroutine)|LoadMsgctl]]</td><td valign="top">XmlDoc</td><td valign="top">Load MSGCTL commands to this XmlDoc</td></tr>
<tr><td valign="top">[[LoadParameterInfo (XmlDoc subroutine)|LoadParameterInfo]]</td><td valign="top">XmlDoc</td><td valign="top">Load parameter info into this XmlDoc</td></tr>
<tr><td valign="top">[[LoadParameterInfo (XmlDoc subroutine)|LoadParameterInfo]]</td><td valign="top">XmlDoc</td><td valign="top">Load parameter info into this XmlDoc</td></tr>
<tr><td valign="top">[[LoadSystemFunctionInfo (XmlDoc subroutine)|LoadSystemFunctionInfo]]</td><td valign="top">XmlDoc</td><td valign="top">Load info about system $functions into this XmlDoc</td></tr>
<tr><td valign="top">[[LoadSystemMethodInfo (XmlDoc subroutine)|LoadSystemMethodInfo]]</td><td valign="top">XmlDoc</td><td valign="top">Load info about system methods into this XmlDoc</td></tr>
<tr><td valign="top">[[LoadSystemMethodInfo (XmlDoc subroutine)|LoadSystemMethodInfo]]</td><td valign="top">XmlDoc</td><td valign="top">Load info about system methods into this XmlDoc</td></tr>
<tr><td valign="top">[[LoadXml (XmlDoc/XmlNode function)|LoadXml]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Deserialize XML document or fragment into XmlDoc Root or into Element XmlNode</td></tr>
<tr><td valign="top">[[LoadXml (XmlDoc/XmlNode function)|LoadXml]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Deserialize XML document or fragment into XmlDoc Root or into Element XmlNode</td></tr>
Line 62: Line 65:
<tr><td valign="top">[[QName (XmlDoc/XmlNode function)|QName]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Name (with prefix, if any) of selected node</td></tr>
<tr><td valign="top">[[QName (XmlDoc/XmlNode function)|QName]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Name (with prefix, if any) of selected node</td></tr>
<tr><td valign="top">[[SelectCount (XmlDoc/XmlNode function)|SelectCount]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Number of selected nodes</td></tr>
<tr><td valign="top">[[SelectCount (XmlDoc/XmlNode function)|SelectCount]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Number of selected nodes</td></tr>
<tr><td valign="top">[[SelectionNamespace (XmlDoc property)|SelectionNamespace]]</td><td valign="top">XmlDoc</td><td valign="top">Bind prefix to URI (or null) for XPath</td></tr>
<tr><td valign="top">[[SelectNodes (XmlDoc/XmlNode function)|SelectNodes]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Get list of selected nodes as XmlNodelist</td></tr>
<tr><td valign="top">[[SelectNodes (XmlDoc/XmlNode function)|SelectNodes]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Get list of selected nodes as XmlNodelist</td></tr>
<tr><td valign="top">[[SelectSingleNode (XmlDoc/XmlNode function)|SelectSingleNode]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Get selected node as XmlNode</td></tr>
<tr><td valign="top">[[SelectSingleNode (XmlDoc/XmlNode function)|SelectSingleNode]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Get selected node as XmlNode</td></tr>
<tr><td valign="top">[[SelectionNamespace (XmlDoc property)|SelectionNamespace]]</td><td valign="top">XmlDoc</td><td valign="top">Bind prefix to URI (or null) for XPath</td></tr>
<tr><td valign="top">[[Serial (XmlDoc/XmlNode function)|Serial]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Serialize selected subtree as string</td></tr>
<tr><td valign="top">[[Serial (XmlDoc/XmlNode function)|Serial]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Serialize selected subtree as string</td></tr>
<tr><td valign="top">[[Standalone (XmlDoc property)|Standalone]]</td><td valign="top">XmlDoc</td><td valign="top">Standalone specification in "XML declaration"</td></tr>
<tr><td valign="top">[[Standalone (XmlDoc property)|Standalone]]</td><td valign="top">XmlDoc</td><td valign="top">Standalone specification in "XML declaration"</td></tr>
Line 71: Line 74:
<tr><td valign="top">[[Trace (XmlDoc/XmlNode subroutine)|Trace]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Display selected subtree on Trace stream</td></tr>
<tr><td valign="top">[[Trace (XmlDoc/XmlNode subroutine)|Trace]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Display selected subtree on Trace stream</td></tr>
<tr><td valign="top">[[Type (XmlDoc/XmlNode function)|Type]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Type of selected node</td></tr>
<tr><td valign="top">[[Type (XmlDoc/XmlNode function)|Type]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Type of selected node</td></tr>
<tr><td valign="top">[[UnionSelected (XmlNodelist function)|UnionSelected]]</td><td valign="top">XmlNodelist</td><td valign="top">Union of XmlNodelist and selected nodes</td></tr>
<tr><td valign="top">[[URI (XmlDoc/XmlNode function)|URI]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Namespace URI of name of selected node</td></tr>
<tr><td valign="top">[[URI (XmlDoc/XmlNode function)|URI]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Namespace URI of name of selected node</td></tr>
<tr><td valign="top">[[UnionSelected (XmlNodelist function)|UnionSelected]]</td><td valign="top">XmlNodelist</td><td valign="top">Union of XmlNodelist and selected nodes</td></tr>
<tr><td valign="top">[[Value (XmlDoc/XmlNode property)|Value]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">String-value of selected node</td></tr>
<tr><td valign="top">[[Value (XmlDoc/XmlNode property)|Value]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">String-value of selected node</td></tr>
<tr><td valign="top">[[ValueDefault (XmlDoc/XmlNode function)|ValueDefault]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">String-value of selected node (allow empty XPath)</td></tr>
<tr><td valign="top">[[ValueDefault (XmlDoc/XmlNode function)|ValueDefault]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">String-value of selected node (allow empty XPath)</td></tr>
Line 78: Line 81:
<tr><td valign="top">[[WebReceive (XmlDoc function)|WebReceive]]</td><td valign="top">XmlDoc</td><td valign="top">Deserialize Web request into this XmlDoc</td></tr>
<tr><td valign="top">[[WebReceive (XmlDoc function)|WebReceive]]</td><td valign="top">XmlDoc</td><td valign="top">Deserialize Web request into this XmlDoc</td></tr>
<tr><td valign="top">[[WebSend (XmlDoc subroutine)|WebSend]]</td><td valign="top">XmlDoc</td><td valign="top">Serialize XmlDoc as Web response</td></tr>
<tr><td valign="top">[[WebSend (XmlDoc subroutine)|WebSend]]</td><td valign="top">XmlDoc</td><td valign="top">Serialize XmlDoc as Web response</td></tr>
<tr><td valign="top">[[XPathNodeID (XmlDoc/XmlNode function)|XPathNodeID]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">XPath expression (in Stringlist) for selected node</td></tr>
<tr><td valign="top">[[Xml (XmlDoc function)|Xml]]</td><td valign="top">XmlDoc</td><td valign="top">Serialize XmlDoc as UTF-8 string</td></tr>
<tr><td valign="top">[[Xml (XmlDoc function)|Xml]]</td><td valign="top">XmlDoc</td><td valign="top">Serialize XmlDoc as UTF-8 string</td></tr>
<tr><td valign="top">[[XmlDoc (XmlNode function)|XmlDoc]]</td><td valign="top">XmlNode</td><td valign="top">Get the XmlDoc associated with this node</td></tr>
<tr><td valign="top">[[XmlDoc (XmlNode function)|XmlDoc]]</td><td valign="top">XmlNode</td><td valign="top">Get the XmlDoc associated with this node</td></tr>
<tr><td valign="top">[[XmlDoc (XmlNodelist function)|XmlDoc]]</td><td valign="top">XmlNodelist</td><td valign="top">Get the XmlDoc associated with this nodelist</td></tr>
<tr><td valign="top">[[XmlDoc (XmlNodelist function)|XmlDoc]]</td><td valign="top">XmlNodelist</td><td valign="top">Get the XmlDoc associated with this nodelist</td></tr>
<tr><td valign="top">[[XPathNodeID (XmlDoc/XmlNode function)|XPathNodeID]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">XPath expression (in Stringlist) for selected node</td></tr>
</table>
</table>
==See also==
==See also==

Latest revision as of 19:33, 21 March 2023

The following are the available XmlDoc API methods.

MethodClassDescription
AddAttributeXmlNodeAdd Attribute to Element node
AddCommentXmlDoc/XmlNodeAdd Comment to XmlDoc Root or to Element XmlNode
AddElementXmlDoc/XmlNodeAdd Element to XmlDoc Root or to Element XmlNode
AddNamespaceXmlNodeAdd namespace declaration to Element node
AddPIXmlDoc/XmlNodeAdd Processing Instruction to XmlDoc Root or to Element XmlNode
AddSubtreeXmlDoc/XmlNodeCopy subtree to XmlDoc Root or to Element XmlNode
AddTextXmlNodeAdd Text child to Element node
AddTopElementXmlDocAdd new top element to XmlDoc
AddToRecordXmlDocAdd fields and/or fieldgroups to the current record
AdjacentTextXmlDocAre adjacent text nodes allowed?
AllowNullXmlDocAllow null characters in node values?
AllowXmlAttributeXmlDocMay Attribute names begin with "xml"?
AllowXmlElementXmlDocMay Element names begin with "xml"?
AppendValueXmlNodeAppend to value of node
AuditXmlDoc/XmlNodeDisplay selected subtree on audit trail
ClientCertificateXmlDocCreate XmlDoc with client certificate details
CopyXmlDocCopy this XmlDoc
CountXmlNodelistNumber of nodes in this nodelist
DeepCopyXmlDocDeep copy this XmlDoc
DeepCopyXmlNodeDeep copy this node
DeepDiscardXmlNodeDo deep discard of an XmlNode object
DefaultURIXmlDoc/XmlNodeDefault URI in scope at selected node
DeleteSelectionPrefixXmlDocDelete prefix's XPath-selection association
DeleteSubtreeXmlDoc/XmlNodeDelete selected subtree
DeleteTopElementXmlDocDelete top element from XmlDoc
DifferenceXmlNodelistDifference between XmlNodelists
EncodingXmlDocEncoding of XML document
ExistsXmlDoc/XmlNodeIs XPath result non-empty?
InsertCommentBeforeXmlNodeInsert a Comment before this node
InsertElementBeforeXmlNodeInsert an Element before this node
InsertPIBeforeXmlNodeInsert a processing instruction before this node
InsertSubtreeBeforeXmlNodeInsert copy of subtree before this node
InsertTextBeforeXmlNodeInsert Text node before this node
InvalidCharXmlDocAllow invalid characters (obsolete)
InvalidCharacterPositionXmlDocDetect invalid characters
IsSelectionPrefixXmlDocCheck if prefix has XPath-selection association
IsValidStringXmlDocValid XML Element/Attribute value? (obsolete)
ItemXmlNodelistRetrieve an item from this nodelist
LengthXmlDoc/XmlNodeLength of string-value of selected node
LoadCommandInfoXmlDocLoad command info into this XmlDoc
LoadFromRecordXmlDoc/XmlNodeLoad fields and fieldgroups from current record
LoadFromStringlistXmlDoc/XmlNodeDeserialize Stringlist into XmlDoc (obsolete)
LoadMessageInfoXmlDocLoad message info into this XmlDoc
LoadMsgctlXmlDocLoad MSGCTL commands to this XmlDoc
LoadParameterInfoXmlDocLoad parameter info into this XmlDoc
LoadSystemFunctionInfoXmlDocLoad info about system $functions into this XmlDoc
LoadSystemMethodInfoXmlDocLoad info about system methods into this XmlDoc
LoadXmlXmlDoc/XmlNodeDeserialize XML document or fragment into XmlDoc Root or into Element XmlNode
LocalNameXmlDoc/XmlNodeName (without prefix) of selected node
NamespaceXmlDoc(Dis)allow or disable prefix handling
NewXmlDocCreate a new XmlDoc object
NewXmlNodelistCreate a new XmlNodelist
NewFromRecordXmlDocCreate a new XmlDoc from the current record
NextXmlNodeGet the next node after this node
NoEmptyElementXmlNodeSuppress/produce empty tag when serializing this Element, if childless
PrefixXmlDoc/XmlNodePrefix part of name of selected node
PrefixURIXmlDoc/XmlNodeURI of specified prefix in context of selected node
PreviousXmlNodeGet node previous to this node
PrintXmlDoc/XmlNodePrint selected subtree
QNameXmlDoc/XmlNodeName (with prefix, if any) of selected node
SelectCountXmlDoc/XmlNodeNumber of selected nodes
SelectionNamespaceXmlDocBind prefix to URI (or null) for XPath
SelectNodesXmlDoc/XmlNodeGet list of selected nodes as XmlNodelist
SelectSingleNodeXmlDoc/XmlNodeGet selected node as XmlNode
SerialXmlDoc/XmlNodeSerialize selected subtree as string
StandaloneXmlDocStandalone specification in "XML declaration"
ToXPathStringXmlDoc/XmlNodeXPath expression for selected node
ToXPathStringlistXmlDoc/XmlNodeXPath expression (in Stringlist) for selected node
TraceXmlDoc/XmlNodeDisplay selected subtree on Trace stream
TypeXmlDoc/XmlNodeType of selected node
UnionSelectedXmlNodelistUnion of XmlNodelist and selected nodes
URIXmlDoc/XmlNodeNamespace URI of name of selected node
ValueXmlDoc/XmlNodeString-value of selected node
ValueDefaultXmlDoc/XmlNodeString-value of selected node (allow empty XPath)
VersionXmlDocVersion number in "XML declaration"
WebReceiveXmlDocDeserialize Web request into this XmlDoc
WebSendXmlDocSerialize XmlDoc as Web response
XmlXmlDocSerialize XmlDoc as UTF-8 string
XmlDocXmlNodeGet the XmlDoc associated with this node
XmlDocXmlNodelistGet the XmlDoc associated with this nodelist
XPathNodeIDXmlDoc/XmlNodeXPath expression (in Stringlist) for selected node

See also