List of XmlDoc methods: Difference between revisions
Jump to navigation
Jump to search
m Automatically generated page update |
Automatically generated page update |
||
| (14 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
<!-- This page was automatically generated and will be automatically | <!-- This page was automatically generated and will be automatically | ||
replaced, so any manual edits will be lost. You've been warned. --> | replaced, so any manual edits will be lost. You've been warned. --> | ||
The following are the available XmlDoc class methods. | The following are the available <var>[[XmlDoc class|XmlDoc]]</var> class methods. | ||
{{Template:Method list header|class=XmlDoc}} | {{Template:Method list header|class=XmlDoc}} | ||
<div class="showVisit"> | |||
<table class="wikitable"> | <table class="wikitable"> | ||
<tr><th>Method</th><th>Description</th></tr> | <tr><th>Method</th><th>Description</th></tr> | ||
| Line 9: | Line 10: | ||
<tr><td valign="top">[[AddPI (XmlDoc/XmlNode function)|AddPI]]</td><td valign="top">Add Processing Instruction to XmlDoc Root or to Element XmlNode</td></tr> | <tr><td valign="top">[[AddPI (XmlDoc/XmlNode function)|AddPI]]</td><td valign="top">Add Processing Instruction to XmlDoc Root or to Element XmlNode</td></tr> | ||
<tr><td valign="top">[[AddSubtree (XmlDoc/XmlNode function)|AddSubtree]]</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">Copy subtree to XmlDoc Root or to Element XmlNode</td></tr> | ||
<tr><td valign="top">[[ | <tr><td valign="top">[[AddTopElement (XmlDoc function)|AddTopElement]]</td><td valign="top">Add new top element to XmlDoc</td></tr> | ||
<tr><td valign="top">[[ | <tr><td valign="top">[[AddToRecord (XmlDoc subroutine)|AddToRecord]]</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">Are adjacent text nodes allowed?</td></tr> | <tr><td valign="top">[[AdjacentText (XmlDoc property)|AdjacentText]]</td><td valign="top">Are adjacent text nodes allowed?</td></tr> | ||
<tr><td valign="top">[[AllowNull (XmlDoc property)|AllowNull]]</td><td valign="top">Allow null characters in node values?</td></tr> | <tr><td valign="top">[[AllowNull (XmlDoc property)|AllowNull]]</td><td valign="top">Allow null characters in node values?</td></tr> | ||
<tr><td valign="top">[[AllowXmlAttribute (XmlDoc property)|AllowXmlAttribute]]</td><td valign="top">May Attribute names begin with "xml"?</td></tr> | |||
<tr><td valign="top">[[AllowXmlElement (XmlDoc property)|AllowXmlElement]]</td><td valign="top">May Element names begin with "xml"?</td></tr> | <tr><td valign="top">[[AllowXmlElement (XmlDoc property)|AllowXmlElement]]</td><td valign="top">May Element names begin with "xml"?</td></tr> | ||
<tr><td valign="top">[[Audit (XmlDoc/XmlNode subroutine)|Audit]]</td><td valign="top">Display selected subtree on audit trail</td></tr> | <tr><td valign="top">[[Audit (XmlDoc/XmlNode subroutine)|Audit]]</td><td valign="top">Display selected subtree on audit trail</td></tr> | ||
<tr><td valign="top">[[ClientCertificate (XmlDoc function)|ClientCertificate]]</td><td valign="top">Create | <tr><td valign="top">[[ClientCertificate (XmlDoc function)|ClientCertificate]]</td><td valign="top">Create XmlDoc with client certificate details</td></tr> | ||
<tr><td valign="top">[[Copy (XmlDoc function)|Copy]]</td><td valign="top">Copy this XmlDoc</td></tr> | <tr><td valign="top">[[Copy (XmlDoc function)|Copy]]</td><td valign="top">Copy this XmlDoc</td></tr> | ||
<tr><td valign="top">[[DeepCopy (XmlDoc function)|DeepCopy]]</td><td valign="top">Deep copy this XmlDoc</td></tr> | <tr><td valign="top">[[DeepCopy (XmlDoc function)|DeepCopy]]</td><td valign="top">Deep copy this XmlDoc</td></tr> | ||
<tr><td valign="top">[[DefaultURI (XmlDoc/XmlNode function)|DefaultURI]]</td><td valign="top">Default URI in scope at selected node</td></tr> | <tr><td valign="top">[[DefaultURI (XmlDoc/XmlNode function)|DefaultURI]]</td><td valign="top">Default URI in scope at selected node</td></tr> | ||
<tr><td valign="top">[[DeleteSelectionPrefix (XmlDoc subroutine)|DeleteSelectionPrefix]]</td><td valign="top">Delete prefix XPath-selection association</td></tr> | <tr><td valign="top">[[DeleteSelectionPrefix (XmlDoc subroutine)|DeleteSelectionPrefix]]</td><td valign="top">Delete prefix's XPath-selection association</td></tr> | ||
<tr><td valign="top">[[DeleteSubtree (XmlDoc/XmlNode subroutine)|DeleteSubtree]]</td><td valign="top">Delete selected subtree</td></tr> | <tr><td valign="top">[[DeleteSubtree (XmlDoc/XmlNode subroutine)|DeleteSubtree]]</td><td valign="top">Delete selected subtree</td></tr> | ||
<tr><td valign="top">[[DeleteTopElement (XmlDoc subroutine)|DeleteTopElement]]</td><td valign="top">Delete | <tr><td valign="top">[[DeleteTopElement (XmlDoc subroutine)|DeleteTopElement]]</td><td valign="top">Delete top element from XmlDoc</td></tr> | ||
<tr><td valign="top">[[Encoding (XmlDoc property)|Encoding]]</td><td valign="top"> | <tr><td valign="top">[[Encoding (XmlDoc property)|Encoding]]</td><td valign="top">Encoding of XML document</td></tr> | ||
<tr><td valign="top">[[Exists (XmlDoc/XmlNode function)|Exists]]</td><td valign="top">Is XPath result non-empty?</td></tr> | <tr><td valign="top">[[Exists (XmlDoc/XmlNode function)|Exists]]</td><td valign="top">Is XPath result non-empty?</td></tr> | ||
<tr><td valign="top">[[InvalidChar (XmlDoc property)|InvalidChar]]</td><td valign="top">Allow invalid characters (obsolete)</td></tr> | <tr><td valign="top">[[InvalidChar (XmlDoc property)|InvalidChar]]</td><td valign="top">Allow invalid characters (obsolete)</td></tr> | ||
| Line 30: | Line 31: | ||
<tr><td valign="top">[[IsValidString (XmlDoc function)|IsValidString]]</td><td valign="top">Valid XML Element/Attribute value? (obsolete)</td></tr> | <tr><td valign="top">[[IsValidString (XmlDoc function)|IsValidString]]</td><td valign="top">Valid XML Element/Attribute value? (obsolete)</td></tr> | ||
<tr><td valign="top">[[Length (XmlDoc/XmlNode function)|Length]]</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">Length of string-value of selected node</td></tr> | ||
<tr><td valign="top">[[LoadChangedRecords (XmlDoc subroutine)|LoadChangedRecords]]</td><td valign="top">Load ChangedRecords into this XmlDoc</td></tr> | |||
<tr><td valign="top">[[LoadCommandInfo (XmlDoc subroutine)|LoadCommandInfo]]</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">Load fields and fieldgroups from current record</td></tr> | <tr><td valign="top">[[LoadFromRecord (XmlDoc/XmlNode subroutine)|LoadFromRecord]]</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">( | <tr><td valign="top">[[LoadFromStringlist (XmlDoc/XmlNode function)|LoadFromStringlist]]</td><td valign="top">Deserialize Stringlist into XmlDoc (obsolete)</td></tr> | ||
<tr><td valign="top">[[LoadMessageInfo (XmlDoc subroutine)|LoadMessageInfo]]</td><td valign="top">Load message info into this XmlDoc</td></tr> | |||
<tr><td valign="top">[[LoadMsgctl (XmlDoc subroutine)|LoadMsgctl]]</td><td valign="top">Load MSGCTL commands to this XmlDoc</td></tr> | |||
<tr><td valign="top">[[LoadParameterInfo (XmlDoc subroutine)|LoadParameterInfo]]</td><td valign="top">Load parameter info into this XmlDoc</td></tr> | <tr><td valign="top">[[LoadParameterInfo (XmlDoc subroutine)|LoadParameterInfo]]</td><td valign="top">Load parameter info into this XmlDoc</td></tr> | ||
<tr><td valign="top">[[LoadSystemMethodInfo (XmlDoc subroutine)|LoadSystemMethodInfo]]</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">Load info about system methods into this XmlDoc</td></tr> | ||
<tr><td valign="top">[[LoadXml (XmlDoc/XmlNode function)|LoadXml]]</td><td valign="top">Deserialize | <tr><td valign="top">[[LoadXml (XmlDoc/XmlNode function)|LoadXml]]</td><td valign="top">Deserialize XML document or fragment into XmlDoc Root or into Element XmlNode</td></tr> | ||
<tr><td valign="top">[[LocalName (XmlDoc/XmlNode function)|LocalName]]</td><td valign="top">Name (without prefix) of selected node</td></tr> | <tr><td valign="top">[[LocalName (XmlDoc/XmlNode function)|LocalName]]</td><td valign="top">Name (without prefix) of selected node</td></tr> | ||
<tr><td valign="top">[[Namespace (XmlDoc property)|Namespace]]</td><td valign="top">(Dis)allow or disable prefix handling</td></tr> | <tr><td valign="top">[[Namespace (XmlDoc property)|Namespace]]</td><td valign="top">(Dis)allow or disable prefix handling</td></tr> | ||
| Line 42: | Line 47: | ||
<tr><td valign="top">[[PrefixURI (XmlDoc/XmlNode function)|PrefixURI]]</td><td valign="top">URI of specified prefix in context of selected node</td></tr> | <tr><td valign="top">[[PrefixURI (XmlDoc/XmlNode function)|PrefixURI]]</td><td valign="top">URI of specified prefix in context of selected node</td></tr> | ||
<tr><td valign="top">[[Print (XmlDoc/XmlNode subroutine)|Print]]</td><td valign="top">Print selected subtree</td></tr> | <tr><td valign="top">[[Print (XmlDoc/XmlNode subroutine)|Print]]</td><td valign="top">Print selected subtree</td></tr> | ||
<tr><td valign="top">[[QName (XmlDoc/XmlNode function)|QName]]</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">Name (with prefix, if any) of selected node</td></tr> | ||
<tr><td valign="top">[[SelectCount (XmlDoc/XmlNode function)|SelectCount]]</td><td valign="top">Number of selected nodes</td></tr> | <tr><td valign="top">[[SelectCount (XmlDoc/XmlNode function)|SelectCount]]</td><td valign="top">Number of selected nodes</td></tr> | ||
<tr><td valign="top">[[SelectionNamespace (XmlDoc property)|SelectionNamespace]]</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">Get list of selected nodes as XmlNodelist</td></tr> | <tr><td valign="top">[[SelectNodes (XmlDoc/XmlNode function)|SelectNodes]]</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">Get selected node as XmlNode</td></tr> | <tr><td valign="top">[[SelectSingleNode (XmlDoc/XmlNode function)|SelectSingleNode]]</td><td valign="top">Get selected node as XmlNode</td></tr> | ||
<tr><td valign="top">[[Serial (XmlDoc/XmlNode function)|Serial]]</td><td valign="top">Serialize selected subtree as string</td></tr> | <tr><td valign="top">[[Serial (XmlDoc/XmlNode function)|Serial]]</td><td valign="top">Serialize selected subtree as string</td></tr> | ||
<tr><td valign="top">[[Standalone (XmlDoc property)|Standalone]]</td><td valign="top">Standalone specification in "XML declaration"</td></tr> | <tr><td valign="top">[[Standalone (XmlDoc property)|Standalone]]</td><td valign="top">Standalone specification in "XML declaration"</td></tr> | ||
<tr><td valign="top">[[ToXPathString (XmlDoc/XmlNode function)|ToXPathString]]</td><td valign="top">XPath expression for selected node</td></tr> | <tr><td valign="top">[[ToXPathString (XmlDoc/XmlNode function)|ToXPathString]]</td><td valign="top">XPath expression for selected node</td></tr> | ||
<tr><td valign="top">[[ToXPathStringlist (XmlDoc/XmlNode function)|ToXPathStringlist]]</td><td valign="top">XPath expression for selected node</td></tr> | <tr><td valign="top">[[ToXPathStringlist (XmlDoc/XmlNode function)|ToXPathStringlist]]</td><td valign="top">XPath expression (in Stringlist) for selected node</td></tr> | ||
<tr><td valign="top">[[Trace (XmlDoc/XmlNode subroutine)|Trace]]</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">Display selected subtree on Trace stream</td></tr> | ||
<tr><td valign="top">[[Type (XmlDoc/XmlNode function)|Type]]</td><td valign="top">Type of selected node</td></tr> | <tr><td valign="top">[[Type (XmlDoc/XmlNode function)|Type]]</td><td valign="top">Type of selected node</td></tr> | ||
<tr><td valign="top">[[URI (XmlDoc/XmlNode function)|URI]]</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">Namespace URI of name of selected node</td></tr> | ||
<tr><td valign="top">[[Value (XmlDoc/XmlNode property)|Value]]</td><td valign="top">String-value of selected node</td></tr> | <tr><td valign="top">[[Value (XmlDoc/XmlNode property)|Value]]</td><td valign="top">String-value of selected node</td></tr> | ||
<tr><td valign="top">[[ValueDefault (XmlDoc/XmlNode function)|ValueDefault]]</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">String-value of selected node (allow empty XPath)</td></tr> | ||
<tr><td valign="top">[[Version (XmlDoc property)|Version]]</td><td valign="top">Version number in "XML declaration"</td></tr> | <tr><td valign="top">[[Version (XmlDoc property)|Version]]</td><td valign="top">Version number in "XML declaration"</td></tr> | ||
<tr><td valign="top">[[WebReceive (XmlDoc function)|WebReceive]]</td><td valign="top">Deserialize Web request into XmlDoc</td></tr> | <tr><td valign="top">[[WebReceive (XmlDoc function)|WebReceive]]</td><td valign="top">Deserialize Web request into this XmlDoc</td></tr> | ||
<tr><td valign="top">[[WebSend (XmlDoc subroutine)|WebSend]]</td><td valign="top">Serialize XmlDoc as Web response</td></tr> | <tr><td valign="top">[[WebSend (XmlDoc subroutine)|WebSend]]</td><td valign="top">Serialize XmlDoc as Web response</td></tr> | ||
<tr><td valign="top">[[Xml (XmlDoc function)|Xml]]</td><td valign="top">Serialize XmlDoc as UTF-8 string</td></tr> | <tr><td valign="top">[[Xml (XmlDoc function)|Xml]]</td><td valign="top">Serialize XmlDoc as UTF-8 string</td></tr> | ||
<tr><td valign="top">[[ | <tr><td valign="top">[[XPathNodeID (XmlDoc/XmlNode function)|XPathNodeID]]</td><td valign="top">XPath expression (in Stringlist) for selected node</td></tr> | ||
</table> | </table> | ||
</div> | |||
==See also== | ==See also== | ||
<table class="list"><tr> | <table class="list"><tr> | ||
| Line 85: | Line 87: | ||
</tr> | </tr> | ||
</table> | </table> | ||
[[Category:Lists of methods]] | |||
Latest revision as of 03:55, 15 January 2020
The following are the available XmlDoc class methods.
| Method | Description |
|---|---|
| AddComment | Add Comment to XmlDoc Root or to Element XmlNode |
| AddElement | Add Element to XmlDoc Root or to Element XmlNode |
| AddPI | Add Processing Instruction to XmlDoc Root or to Element XmlNode |
| AddSubtree | Copy subtree to XmlDoc Root or to Element XmlNode |
| AddTopElement | Add new top element to XmlDoc |
| AddToRecord | Add fields and/or fieldgroups to the current record |
| AdjacentText | Are adjacent text nodes allowed? |
| AllowNull | Allow null characters in node values? |
| AllowXmlAttribute | May Attribute names begin with "xml"? |
| AllowXmlElement | May Element names begin with "xml"? |
| Audit | Display selected subtree on audit trail |
| ClientCertificate | Create XmlDoc with client certificate details |
| Copy | Copy this XmlDoc |
| DeepCopy | Deep copy this XmlDoc |
| DefaultURI | Default URI in scope at selected node |
| DeleteSelectionPrefix | Delete prefix's XPath-selection association |
| DeleteSubtree | Delete selected subtree |
| DeleteTopElement | Delete top element from XmlDoc |
| Encoding | Encoding of XML document |
| Exists | Is XPath result non-empty? |
| InvalidChar | Allow invalid characters (obsolete) |
| InvalidCharacterPosition | Detect invalid characters |
| IsSelectionPrefix | Check if prefix has XPath-selection association |
| IsValidString | Valid XML Element/Attribute value? (obsolete) |
| Length | Length of string-value of selected node |
| LoadChangedRecords | Load ChangedRecords into this XmlDoc |
| LoadCommandInfo | Load command info into this XmlDoc |
| LoadFromRecord | Load fields and fieldgroups from current record |
| LoadFromStringlist | Deserialize Stringlist into XmlDoc (obsolete) |
| LoadMessageInfo | Load message info into this XmlDoc |
| LoadMsgctl | Load MSGCTL commands to this XmlDoc |
| LoadParameterInfo | Load parameter info into this XmlDoc |
| LoadSystemMethodInfo | Load info about system methods into this XmlDoc |
| LoadXml | Deserialize XML document or fragment into XmlDoc Root or into Element XmlNode |
| LocalName | Name (without prefix) of selected node |
| Namespace | (Dis)allow or disable prefix handling |
| New | Create a new XmlDoc object |
| NewFromRecord | Create a new XmlDoc from the current record |
| Prefix | Prefix part of name of selected node |
| PrefixURI | URI of specified prefix in context of selected node |
| Print selected subtree | |
| QName | Name (with prefix, if any) of selected node |
| SelectCount | Number of selected nodes |
| SelectionNamespace | Bind prefix to URI (or null) for XPath |
| SelectNodes | Get list of selected nodes as XmlNodelist |
| SelectSingleNode | Get selected node as XmlNode |
| Serial | Serialize selected subtree as string |
| Standalone | Standalone specification in "XML declaration" |
| ToXPathString | XPath expression for selected node |
| ToXPathStringlist | XPath expression (in Stringlist) for selected node |
| Trace | Display selected subtree on Trace stream |
| Type | Type of selected node |
| URI | Namespace URI of name of selected node |
| Value | String-value of selected node |
| ValueDefault | String-value of selected node (allow empty XPath) |
| Version | Version number in "XML declaration" |
| WebReceive | Deserialize Web request into this XmlDoc |
| WebSend | Serialize XmlDoc as Web response |
| Xml | Serialize XmlDoc as UTF-8 string |
| XPathNodeID | XPath expression (in Stringlist) for selected node |