List of XmlDoc API methods: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
(Make entry for $function XmlDoc method) |
||
(6 intermediate revisions by 2 users 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">[[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 30: | Line 30: | ||
<tr><td valign="top">[[DeleteTopElement (XmlDoc subroutine)|DeleteTopElement]]</td><td valign="top">XmlDoc</td><td valign="top">Delete top element from XmlDoc</td></tr> | <tr><td valign="top">[[DeleteTopElement (XmlDoc subroutine)|DeleteTopElement]]</td><td valign="top">XmlDoc</td><td valign="top">Delete top element from XmlDoc</td></tr> | ||
<tr><td valign="top">[[Difference (XmlNodelist function)|Difference]]</td><td valign="top">XmlNodelist</td><td valign="top">Difference between XmlNodelists</td></tr> | <tr><td valign="top">[[Difference (XmlNodelist function)|Difference]]</td><td valign="top">XmlNodelist</td><td valign="top">Difference between XmlNodelists</td></tr> | ||
<tr><td valign="top">[[Encoding (XmlDoc property)|Encoding]]</td><td valign="top">XmlDoc</td><td valign="top"> | <tr><td valign="top">[[Encoding (XmlDoc property)|Encoding]]</td><td valign="top">XmlDoc</td><td valign="top">Encoding of XML document</td></tr> | ||
<tr><td valign="top">[[Exists (XmlDoc/XmlNode function)|Exists]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Is XPath result non-empty?</td></tr> | <tr><td valign="top">[[Exists (XmlDoc/XmlNode function)|Exists]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Is XPath result non-empty?</td></tr> | ||
<tr><td valign="top">[[InsertCommentBefore (XmlNode function)|InsertCommentBefore]]</td><td valign="top">XmlNode</td><td valign="top">Insert a Comment before this node</td></tr> | <tr><td valign="top">[[InsertCommentBefore (XmlNode function)|InsertCommentBefore]]</td><td valign="top">XmlNode</td><td valign="top">Insert a Comment before this node</td></tr> | ||
Line 43: | Line 43: | ||
<tr><td valign="top">[[Item (XmlNodelist function)|Item]]</td><td valign="top">XmlNodelist</td><td valign="top">Retrieve an item from this nodelist</td></tr> | <tr><td valign="top">[[Item (XmlNodelist function)|Item]]</td><td valign="top">XmlNodelist</td><td valign="top">Retrieve an item from this nodelist</td></tr> | ||
<tr><td valign="top">[[Length (XmlDoc/XmlNode function)|Length]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Length of string-value of selected node</td></tr> | <tr><td valign="top">[[Length (XmlDoc/XmlNode function)|Length]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Length of string-value of selected node</td></tr> | ||
<tr><td valign="top">[[LoadCommandInfo (XmlDoc subroutine)|LoadCommandInfo]]</td><td valign="top">XmlDoc</td><td valign="top">Load command info into this XmlDoc</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">[[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 61: | 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">[[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 70: | 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">[[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 77: | 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">[[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== | ||
Line 101: | Line 105: | ||
</tr> | </tr> | ||
</table> | </table> | ||
[[Category:Lists of methods]] |
Latest revision as of 19:33, 21 March 2023
The following are the available XmlDoc API methods.
Method | Class | Description |
---|---|---|
AddAttribute | XmlNode | Add Attribute to Element node |
AddComment | XmlDoc/XmlNode | Add Comment to XmlDoc Root or to Element XmlNode |
AddElement | XmlDoc/XmlNode | Add Element to XmlDoc Root or to Element XmlNode |
AddNamespace | XmlNode | Add namespace declaration to Element node |
AddPI | XmlDoc/XmlNode | Add Processing Instruction to XmlDoc Root or to Element XmlNode |
AddSubtree | XmlDoc/XmlNode | Copy subtree to XmlDoc Root or to Element XmlNode |
AddText | XmlNode | Add Text child to Element node |
AddTopElement | XmlDoc | Add new top element to XmlDoc |
AddToRecord | XmlDoc | Add fields and/or fieldgroups to the current record |
AdjacentText | XmlDoc | Are adjacent text nodes allowed? |
AllowNull | XmlDoc | Allow null characters in node values? |
AllowXmlAttribute | XmlDoc | May Attribute names begin with "xml"? |
AllowXmlElement | XmlDoc | May Element names begin with "xml"? |
AppendValue | XmlNode | Append to value of node |
Audit | XmlDoc/XmlNode | Display selected subtree on audit trail |
ClientCertificate | XmlDoc | Create XmlDoc with client certificate details |
Copy | XmlDoc | Copy this XmlDoc |
Count | XmlNodelist | Number of nodes in this nodelist |
DeepCopy | XmlDoc | Deep copy this XmlDoc |
DeepCopy | XmlNode | Deep copy this node |
DeepDiscard | XmlNode | Do deep discard of an XmlNode object |
DefaultURI | XmlDoc/XmlNode | Default URI in scope at selected node |
DeleteSelectionPrefix | XmlDoc | Delete prefix's XPath-selection association |
DeleteSubtree | XmlDoc/XmlNode | Delete selected subtree |
DeleteTopElement | XmlDoc | Delete top element from XmlDoc |
Difference | XmlNodelist | Difference between XmlNodelists |
Encoding | XmlDoc | Encoding of XML document |
Exists | XmlDoc/XmlNode | Is XPath result non-empty? |
InsertCommentBefore | XmlNode | Insert a Comment before this node |
InsertElementBefore | XmlNode | Insert an Element before this node |
InsertPIBefore | XmlNode | Insert a processing instruction before this node |
InsertSubtreeBefore | XmlNode | Insert copy of subtree before this node |
InsertTextBefore | XmlNode | Insert Text node before this node |
InvalidChar | XmlDoc | Allow invalid characters (obsolete) |
InvalidCharacterPosition | XmlDoc | Detect invalid characters |
IsSelectionPrefix | XmlDoc | Check if prefix has XPath-selection association |
IsValidString | XmlDoc | Valid XML Element/Attribute value? (obsolete) |
Item | XmlNodelist | Retrieve an item from this nodelist |
Length | XmlDoc/XmlNode | Length of string-value of selected node |
LoadCommandInfo | XmlDoc | Load command info into this XmlDoc |
LoadFromRecord | XmlDoc/XmlNode | Load fields and fieldgroups from current record |
LoadFromStringlist | XmlDoc/XmlNode | Deserialize Stringlist into XmlDoc (obsolete) |
LoadMessageInfo | XmlDoc | Load message info into this XmlDoc |
LoadMsgctl | XmlDoc | Load MSGCTL commands to this XmlDoc |
LoadParameterInfo | XmlDoc | Load parameter info into this XmlDoc |
LoadSystemFunctionInfo | XmlDoc | Load info about system $functions into this XmlDoc |
LoadSystemMethodInfo | XmlDoc | Load info about system methods into this XmlDoc |
LoadXml | XmlDoc/XmlNode | Deserialize XML document or fragment into XmlDoc Root or into Element XmlNode |
LocalName | XmlDoc/XmlNode | Name (without prefix) of selected node |
Namespace | XmlDoc | (Dis)allow or disable prefix handling |
New | XmlDoc | Create a new XmlDoc object |
New | XmlNodelist | Create a new XmlNodelist |
NewFromRecord | XmlDoc | Create a new XmlDoc from the current record |
Next | XmlNode | Get the next node after this node |
NoEmptyElement | XmlNode | Suppress/produce empty tag when serializing this Element, if childless |
Prefix | XmlDoc/XmlNode | Prefix part of name of selected node |
PrefixURI | XmlDoc/XmlNode | URI of specified prefix in context of selected node |
Previous | XmlNode | Get node previous to this node |
XmlDoc/XmlNode | Print selected subtree | |
QName | XmlDoc/XmlNode | Name (with prefix, if any) of selected node |
SelectCount | XmlDoc/XmlNode | Number of selected nodes |
SelectionNamespace | XmlDoc | Bind prefix to URI (or null) for XPath |
SelectNodes | XmlDoc/XmlNode | Get list of selected nodes as XmlNodelist |
SelectSingleNode | XmlDoc/XmlNode | Get selected node as XmlNode |
Serial | XmlDoc/XmlNode | Serialize selected subtree as string |
Standalone | XmlDoc | Standalone specification in "XML declaration" |
ToXPathString | XmlDoc/XmlNode | XPath expression for selected node |
ToXPathStringlist | XmlDoc/XmlNode | XPath expression (in Stringlist) for selected node |
Trace | XmlDoc/XmlNode | Display selected subtree on Trace stream |
Type | XmlDoc/XmlNode | Type of selected node |
UnionSelected | XmlNodelist | Union of XmlNodelist and selected nodes |
URI | XmlDoc/XmlNode | Namespace URI of name of selected node |
Value | XmlDoc/XmlNode | String-value of selected node |
ValueDefault | XmlDoc/XmlNode | String-value of selected node (allow empty XPath) |
Version | XmlDoc | Version number in "XML declaration" |
WebReceive | XmlDoc | Deserialize Web request into this XmlDoc |
WebSend | XmlDoc | Serialize XmlDoc as Web response |
Xml | XmlDoc | Serialize XmlDoc as UTF-8 string |
XmlDoc | XmlNode | Get the XmlDoc associated with this node |
XmlDoc | XmlNodelist | Get the XmlDoc associated with this nodelist |
XPathNodeID | XmlDoc/XmlNode | XPath expression (in Stringlist) for selected node |