List of XmlDoc API methods: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
(Make entry for $function XmlDoc method)
 
(36 intermediate revisions by the same user 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. -->
{{Template:API_list_header|desc=XmlDoc API}}
{{Template:API list header|desc=XmlDoc API}}
<table class="wikitable">
<table class="wikitable">
<tr><th>Method</th><th>Class</th><th>Description</th></tr>
<tr><th>Method</th><th>Class</th><th>Description</th></tr>
<tr><td>[[AddAttribute (XmlNode function)|AddAttribute]]</td><td>XmlNode</td><td>Add an attribute</td></tr>
<tr><td valign="top">[[AddAttribute (XmlNode function)|AddAttribute]]</td><td valign="top">XmlNode</td><td valign="top">Add Attribute to Element node</td></tr>
<tr><td>[[AddComment (XmlDoc/XmlNode function)|AddComment]]</td><td>XmlDoc/XmlNode</td><td>Add Comment to XmlDoc Root or to Element XmlNode</td></tr>
<tr><td valign="top">[[AddComment (XmlDoc/XmlNode function)|AddComment]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Add Comment to XmlDoc Root or to Element XmlNode</td></tr>
<tr><td>[[AddElement (XmlDoc/XmlNode function)|AddElement]]</td><td>XmlDoc/XmlNode</td><td>Add Element to XmlDoc Root or to Element XmlNode</td></tr>
<tr><td valign="top">[[AddElement (XmlDoc/XmlNode function)|AddElement]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Add Element to XmlDoc Root or to Element XmlNode</td></tr>
<tr><td>[[AddNamespace (XmlNode subroutine)|AddNamespace]]</td><td>XmlNode</td><td>Add a namespace declaration</td></tr>
<tr><td valign="top">[[AddNamespace (XmlNode subroutine)|AddNamespace]]</td><td valign="top">XmlNode</td><td valign="top">Add namespace declaration to Element node</td></tr>
<tr><td>[[AddPI (XmlDoc/XmlNode function)|AddPI]]</td><td>XmlDoc/XmlNode</td><td>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">XmlDoc/XmlNode</td><td valign="top">Add Processing Instruction to XmlDoc Root or to Element XmlNode</td></tr>
<tr><td>[[AddSubtree (XmlDoc/XmlNode function)|AddSubtree]]</td><td>XmlDoc/XmlNode</td><td>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>[[AddText (XmlNode function)|AddText]]</td><td>XmlNode</td><td>Add a text child element</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>[[AddToRecord (XmlDoc subroutine)|AddToRecord]]</td><td>XmlDoc</td><td>Add 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>[[AddTopElement (XmlDoc function)|AddTopElement]]</td><td>XmlDoc</td><td>Add a new top element</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>[[AdjacentText (XmlDoc property)|AdjacentText]]</td><td>XmlDoc</td><td>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>[[AllowNull (XmlDoc property)|AllowNull]]</td><td>XmlDoc</td><td>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>
<tr><td>[[AllowXmlElement (XmlDoc property)|AllowXmlElement]]</td><td>XmlDoc</td><td>May Element names begin with "xml"?</td></tr>
<tr><td valign="top">[[AllowXmlAttribute (XmlDoc property)|AllowXmlAttribute]]</td><td valign="top">XmlDoc</td><td valign="top">May Attribute names begin with "xml"?</td></tr>
<tr><td>[[AppendValue (XmlNode subroutine)|AppendValue]]</td><td>XmlNode</td><td>Append a value to the child text element</td></tr>
<tr><td valign="top">[[AllowXmlElement (XmlDoc property)|AllowXmlElement]]</td><td valign="top">XmlDoc</td><td valign="top">May Element names begin with "xml"?</td></tr>
<tr><td>[[Audit (XmlDoc/XmlNode subroutine)|Audit]]</td><td>XmlDoc/XmlNode</td><td>Display selected subtree on audit trail</td></tr>
<tr><td valign="top">[[AppendValue (XmlNode subroutine)|AppendValue]]</td><td valign="top">XmlNode</td><td valign="top">Append to value of node</td></tr>
<tr><td>[[ClientCertificate (XmlDoc function)|ClientCertificate]]</td><td>XmlDoc</td><td>Create a client certificate XmlDoc</td></tr>
<tr><td valign="top">[[Audit (XmlDoc/XmlNode subroutine)|Audit]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Display selected subtree on audit trail</td></tr>
<tr><td>[[Copy (XmlDoc function)|Copy]]</td><td>XmlDoc</td><td>Copy this XmlDoc</td></tr>
<tr><td valign="top">[[ClientCertificate (XmlDoc function)|ClientCertificate]]</td><td valign="top">XmlDoc</td><td valign="top">Create XmlDoc with client certificate details</td></tr>
<tr><td>[[Count (XmlNodelist function)|Count]]</td><td>XmlNodelist</td><td>Number of nodes in this list</td></tr>
<tr><td valign="top">[[Copy (XmlDoc function)|Copy]]</td><td valign="top">XmlDoc</td><td valign="top">Copy this XmlDoc</td></tr>
<tr><td>[[Debug (XmlDoc function)|Debug]]</td><td>XmlDoc</td><td>Debug information</td></tr>
<tr><td valign="top">[[Count (XmlNodelist function)|Count]]</td><td valign="top">XmlNodelist</td><td valign="top">Number of nodes in this nodelist</td></tr>
<tr><td>[[Debug (XmlNodelist function)|Debug]]</td><td>XmlNodelist</td><td>Debug information</td></tr>
<tr><td valign="top">[[DeepCopy (XmlDoc function)|DeepCopy]]</td><td valign="top">XmlDoc</td><td valign="top">Deep copy this XmlDoc</td></tr>
<tr><td>[[DeepCopy (XmlDoc function)|DeepCopy]]</td><td>XmlDoc</td><td>Deep copy this XmlDoc</td></tr>
<tr><td valign="top">[[DeepCopy (XmlNode function)|DeepCopy]]</td><td valign="top">XmlNode</td><td valign="top">Deep copy this node</td></tr>
<tr><td>[[DeepCopy (XmlNode function)|DeepCopy]]</td><td>XmlNode</td><td>Deep copy this node</td></tr>
<tr><td valign="top">[[DeepDiscard (XmlNode subroutine)|DeepDiscard]]</td><td valign="top">XmlNode</td><td valign="top">Do deep discard of an XmlNode object</td></tr>
<tr><td>[[DefaultURI (XmlDoc/XmlNode function)|DefaultURI]]</td><td>XmlDoc/XmlNode</td><td>Default URI in scope at selected node</td></tr>
<tr><td valign="top">[[DefaultURI (XmlDoc/XmlNode function)|DefaultURI]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Default URI in scope at selected node</td></tr>
<tr><td>[[DeleteSelectionPrefix (XmlDoc subroutine)|DeleteSelectionPrefix]]</td><td>XmlDoc</td><td>Delete prefix XPath-selection association</td></tr>
<tr><td valign="top">[[DeleteSelectionPrefix (XmlDoc subroutine)|DeleteSelectionPrefix]]</td><td valign="top">XmlDoc</td><td valign="top">Delete prefix's XPath-selection association</td></tr>
<tr><td>[[DeleteSubtree (XmlDoc/XmlNode subroutine)|DeleteSubtree]]</td><td>XmlDoc/XmlNode</td><td>Delete selected subtree</td></tr>
<tr><td valign="top">[[DeleteSubtree (XmlDoc/XmlNode subroutine)|DeleteSubtree]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Delete selected subtree</td></tr>
<tr><td>[[DeleteTopElement (XmlDoc subroutine)|DeleteTopElement]]</td><td>XmlDoc</td><td>Delete the top element</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>[[Difference (XmlNodelist function)|Difference]]</td><td>XmlNodelist</td><td>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>[[Encoding (XmlDoc property)|Encoding]]</td><td>XmlDoc</td><td>Encode this XmlDoc object</td></tr>
<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>[[Exists (XmlDoc/XmlNode function)|Exists]]</td><td>XmlDoc/XmlNode</td><td>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>[[InsertCommentBefore (XmlNode function)|InsertCommentBefore]]</td><td>XmlNode</td><td>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>
<tr><td>[[InsertElementBefore (XmlNode function)|InsertElementBefore]]</td><td>XmlNode</td><td>Insert an element before this node</td></tr>
<tr><td valign="top">[[InsertElementBefore (XmlNode function)|InsertElementBefore]]</td><td valign="top">XmlNode</td><td valign="top">Insert an Element before this node</td></tr>
<tr><td>[[InsertPIBefore (XmlNode function)|InsertPIBefore]]</td><td>XmlNode</td><td>Insert a processing instruction before this node</td></tr>
<tr><td valign="top">[[InsertPIBefore (XmlNode function)|InsertPIBefore]]</td><td valign="top">XmlNode</td><td valign="top">Insert a processing instruction before this node</td></tr>
<tr><td>[[InsertSubtreeBefore (XmlNode function)|InsertSubtreeBefore]]</td><td>XmlNode</td><td>Insert an XmlDoc subtree before this node</td></tr>
<tr><td valign="top">[[InsertSubtreeBefore (XmlNode function)|InsertSubtreeBefore]]</td><td valign="top">XmlNode</td><td valign="top">Insert copy of subtree before this node</td></tr>
<tr><td>[[InsertTextBefore (XmlNode function)|InsertTextBefore]]</td><td>XmlNode</td><td>Insert text before this node</td></tr>
<tr><td valign="top">[[InsertTextBefore (XmlNode function)|InsertTextBefore]]</td><td valign="top">XmlNode</td><td valign="top">Insert Text node before this node</td></tr>
<tr><td>[[InvalidChar (XmlDoc property)|InvalidChar]]</td><td>XmlDoc</td><td>Allow invalid characters (obsolete)</td></tr>
<tr><td valign="top">[[InvalidChar (XmlDoc property)|InvalidChar]]</td><td valign="top">XmlDoc</td><td valign="top">Allow invalid characters (obsolete)</td></tr>
<tr><td>[[InvalidCharacterPosition (XmlDoc function)|InvalidCharacterPosition]]</td><td>XmlDoc</td><td>Detect invalid characters</td></tr>
<tr><td valign="top">[[InvalidCharacterPosition (XmlDoc function)|InvalidCharacterPosition]]</td><td valign="top">XmlDoc</td><td valign="top">Detect invalid characters</td></tr>
<tr><td>[[IsSelectionPrefix (XmlDoc function)|IsSelectionPrefix]]</td><td>XmlDoc</td><td>Check if prefix has XPath-selection association</td></tr>
<tr><td valign="top">[[IsSelectionPrefix (XmlDoc function)|IsSelectionPrefix]]</td><td valign="top">XmlDoc</td><td valign="top">Check if prefix has XPath-selection association</td></tr>
<tr><td>[[IsValidString (XmlDoc function)|IsValidString]]</td><td>XmlDoc</td><td>Valid XML Element/Attribute value? (obsolete)</td></tr>
<tr><td valign="top">[[IsValidString (XmlDoc function)|IsValidString]]</td><td valign="top">XmlDoc</td><td valign="top">Valid XML Element/Attribute value? (obsolete)</td></tr>
<tr><td>[[Item (XmlNodelist function)|Item]]</td><td>XmlNodelist</td><td>Retreive 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>[[Length (XmlDoc/XmlNode function)|Length]]</td><td>XmlDoc/XmlNode</td><td>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>[[LoadFromRecord (XmlDoc/XmlNode subroutine)|LoadFromRecord]]</td><td>XmlDoc/XmlNode</td><td>Load fields and fieldgroups from current record</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>[[LoadFromStringlist (XmlDoc/XmlNode function)|LoadFromStringlist]]</td><td>XmlDoc/XmlNode</td><td>(Obsolete)</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>[[LoadParameterInfo (XmlDoc subroutine)|LoadParameterInfo]]</td><td>XmlDoc</td><td>Load parameter info into this XmlDoc</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>[[LoadSystemMethodInfo (XmlDoc subroutine)|LoadSystemMethodInfo]]</td><td>XmlDoc</td><td>Load info about system methods into this XmlDoc</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>[[LoadXml (XmlDoc/XmlNode function)|LoadXml]]</td><td>XmlDoc/XmlNode</td><td>Deserialize text string into XmlDoc Root or into Element XmlNode</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>[[LocalName (XmlDoc/XmlNode function)|LocalName]]</td><td>XmlDoc/XmlNode</td><td>Name (without prefix) of selected node</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>[[Namespace (XmlDoc property)|Namespace]]</td><td>XmlDoc</td><td>(Dis)allow or disable prefix handling</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>[[New (XmlDoc constructor)|New]]</td><td>XmlDoc</td><td>Create a new XmlDoc object</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>[[New (XmlNodelist constructor)|New]]</td><td>XmlNodelist</td><td>Create a new XmlNodelist</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>[[NewFromRecord (XmlDoc function)|NewFromRecord]]</td><td>XmlDoc</td><td>Create a new XmlDoc from the current record</td></tr>
<tr><td valign="top">[[LocalName (XmlDoc/XmlNode function)|LocalName]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Name (without prefix) of selected node</td></tr>
<tr><td>[[Next (XmlNode function)|Next]]</td><td>XmlNode</td><td>Get the next node of the parent</td></tr>
<tr><td valign="top">[[Namespace (XmlDoc property)|Namespace]]</td><td valign="top">XmlDoc</td><td valign="top">(Dis)allow or disable prefix handling</td></tr>
<tr><td>[[NoEmptyElement (XmlNode property)|NoEmptyElement]]</td><td>XmlNode</td><td>(Dis)allow empty-element tags for childless nodes in serialization</td></tr>
<tr><td valign="top">[[New (XmlDoc constructor)|New]]</td><td valign="top">XmlDoc</td><td valign="top">Create a new XmlDoc object</td></tr>
<tr><td>[[NodelistID (XmlNodelist function)|NodelistID]]</td><td>XmlNodelist</td><td>ID of this XmlNodelist</td></tr>
<tr><td valign="top">[[New (XmlNodelist constructor)|New]]</td><td valign="top">XmlNodelist</td><td valign="top">Create a new XmlNodelist</td></tr>
<tr><td>[[Prefix (XmlDoc/XmlNode function)|Prefix]]</td><td>XmlDoc/XmlNode</td><td>Prefix part of name of selected node</td></tr>
<tr><td valign="top">[[NewFromRecord (XmlDoc function)|NewFromRecord]]</td><td valign="top">XmlDoc</td><td valign="top">Create a new XmlDoc from the current record</td></tr>
<tr><td>[[PrefixURI (XmlDoc/XmlNode function)|PrefixURI]]</td><td>XmlDoc/XmlNode</td><td>URI of specified prefix in context of selected node</td></tr>
<tr><td valign="top">[[Next (XmlNode function)|Next]]</td><td valign="top">XmlNode</td><td valign="top">Get the next node after this node</td></tr>
<tr><td>[[Previous (XmlNode function)|Previous]]</td><td>XmlNode</td><td>Get the previous node of the parent</td></tr>
<tr><td valign="top">[[NoEmptyElement (XmlNode property)|NoEmptyElement]]</td><td valign="top">XmlNode</td><td valign="top">Suppress/produce empty tag when serializing this Element, if childless</td></tr>
<tr><td>[[Print (XmlDoc/XmlNode subroutine)|Print]]</td><td>XmlDoc/XmlNode</td><td>Print selected subtree</td></tr>
<tr><td valign="top">[[Prefix (XmlDoc/XmlNode function)|Prefix]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Prefix part of name of selected node</td></tr>
<tr><td>[[PrintSchema (XmlDoc subroutine)|PrintSchema]]</td><td>XmlDoc</td><td>Print this XmlDoc schema</td></tr>
<tr><td valign="top">[[PrefixURI (XmlDoc/XmlNode function)|PrefixURI]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">URI of specified prefix in context of selected node</td></tr>
<tr><td>[[Qname (XmlDoc/XmlNode function)|Qname]]</td><td>XmlDoc/XmlNode</td><td>Name (with prefix, if any) of selected node</td></tr>
<tr><td valign="top">[[Previous (XmlNode function)|Previous]]</td><td valign="top">XmlNode</td><td valign="top">Get node previous to this node</td></tr>
<tr><td>[[SelectCount (XmlDoc/XmlNode function)|SelectCount]]</td><td>XmlDoc/XmlNode</td><td>Number of selected nodes</td></tr>
<tr><td valign="top">[[Print (XmlDoc/XmlNode subroutine)|Print]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">Print selected subtree</td></tr>
<tr><td>[[SelectNodes (XmlDoc/XmlNode function)|SelectNodes]]</td><td>XmlDoc/XmlNode</td><td>Get list of selected nodes as XmlNodelist</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>[[SelectSingleNode (XmlDoc/XmlNode function)|SelectSingleNode]]</td><td>XmlDoc/XmlNode</td><td>Get selected node as XmlNode</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>[[SelectionNamespace (XmlDoc property)|SelectionNamespace]]</td><td>XmlDoc</td><td>Bind prefix to URI (or null) for XPath</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>[[Serial (XmlDoc/XmlNode function)|Serial]]</td><td>XmlDoc/XmlNode</td><td>Serialize selected subtree as string</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>[[Standalone (XmlDoc property)|Standalone]]</td><td>XmlDoc</td><td>Standalone specification in "XML declaration"</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>[[ToXPathString (XmlDoc/XmlNode function)|ToXPathString]]</td><td>XmlDoc/XmlNode</td><td>XPath expression for selected node</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>[[ToXPathStringlist (XmlDoc/XmlNode function)|ToXPathStringlist]]</td><td>XmlDoc/XmlNode</td><td>XPath expression for selected node</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>[[Trace (XmlDoc/XmlNode subroutine)|Trace]]</td><td>XmlDoc/XmlNode</td><td>Display selected subtree on Trace stream</td></tr>
<tr><td valign="top">[[ToXPathString (XmlDoc/XmlNode function)|ToXPathString]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">XPath expression for selected node</td></tr>
<tr><td>[[Type (XmlDoc/XmlNode function)|Type]]</td><td>XmlDoc/XmlNode</td><td>Type of selected node</td></tr>
<tr><td valign="top">[[ToXPathStringlist (XmlDoc/XmlNode function)|ToXPathStringlist]]</td><td valign="top">XmlDoc/XmlNode</td><td valign="top">XPath expression (in Stringlist) for selected node</td></tr>
<tr><td>[[URI (XmlDoc/XmlNode function)|URI]]</td><td>XmlDoc/XmlNode</td><td>Namespace URI of name of selected node</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>[[UnionSelected (XmlNodelist function)|UnionSelected]]</td><td>XmlNodelist</td><td>Union of XmlNodelist and selected nodes</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>[[Validate (XmlDoc/XmlNode function)|Validate]]</td><td>XmlDoc/XmlNode</td><td>Validate substring against longstring schema</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>[[Value (XmlDoc/XmlNode property)|Value]]</td><td>XmlDoc/XmlNode</td><td>String-value 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>[[ValueDefault (XmlDoc/XmlNode function)|ValueDefault]]</td><td>XmlDoc/XmlNode</td><td>String-value of selected node (allow empty XPath)</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>[[Version (XmlDoc property)|Version]]</td><td>XmlDoc</td><td>Version number in "XML declaration"</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>[[WebReceive (XmlDoc function)|WebReceive]]</td><td>XmlDoc</td><td>Deserialize Web request into XmlDoc</td></tr>
<tr><td valign="top">[[Version (XmlDoc property)|Version]]</td><td valign="top">XmlDoc</td><td valign="top">Version number in "XML declaration"</td></tr>
<tr><td>[[WebSend (XmlDoc subroutine)|WebSend]]</td><td>XmlDoc</td><td>Serialize XmlDoc as Web response</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>[[XPathNodeID (XmlDoc/XmlNode function)|XPathNodeID]]</td><td>XmlDoc/XmlNode</td><td>XPath expression for selected node</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>[[XPathSingleHint (XmlDoc property)|XPathSingleHint]]</td><td>XmlDoc</td><td></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>[[Xml (XmlDoc function)|Xml]]</td><td>XmlDoc</td><td>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>[[XmlDoc (XmlNode function)|XmlDoc]]</td><td>XmlNode</td><td>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>[[XmlDoc (XmlNodelist function)|XmlDoc]]</td><td>XmlNodelist</td><td>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>
<tr><td>[[XmlDocID (XmlDoc function)|XmlDocID]]</td><td>XmlDoc</td><td>Print the id of this XmlDoc</td></tr>
</table>
</table>
==See also==
<table class="list"><tr>
<td valign="top"><ul style="margin-top:0px;">
<li>[[XmlDoc class]]
<li>[[XmlNode class]]
<li>[[XmlNodelist class]]
</ul></td>
<td valign="top"><ul style="margin-top:0px;">
<li>[[List of XmlDoc methods]]
<li>[[List of XmlNode methods]]
<li>[[List of XmlNodelist methods]]
</ul></td>
<td valign="top"><ul style="margin-top:0px;">
<li>[[XmlDoc methods syntax]]
<li>[[XmlNode methods syntax]]
<li>[[XmlNodelist methods syntax]]
</ul></td>
</tr>
</table>
[[Category:Lists of methods]]

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