List of XmlDoc methods: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Automatically generated page update)
 
(Automatically generated page update)
 
(24 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. -->
{{Template:Method_list_header|class=XmlDoc}}
The following are the available <var>[[XmlDoc class|XmlDoc]]</var> class methods.
{{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>
<tr><td>[[AddComment (XmlDoc function)|AddComment]]</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">Add Comment to XmlDoc Root or to Element XmlNode</td></tr>
<tr><td>[[AddElement (XmlDoc function)|AddElement]]</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">Add Element to XmlDoc Root or to Element XmlNode</td></tr>
<tr><td>[[AddPI (XmlDoc function)|AddPI]]</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">Add Processing Instruction to XmlDoc Root or to Element XmlNode</td></tr>
<tr><td>[[AddSubtree (XmlDoc function)|AddSubtree]]</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">Copy subtree to XmlDoc Root or to Element XmlNode</td></tr>
<tr><td>[[AddToRecord (XmlDoc subroutine)|AddToRecord]]</td><td>Add to the current record</td></tr>
<tr><td valign="top">[[AddTopElement (XmlDoc function)|AddTopElement]]</td><td valign="top">Add new top element to XmlDoc</td></tr>
<tr><td>[[AddTopElement (XmlDoc function)|AddTopElement]]</td><td>Add a new top element</td></tr>
<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>[[AdjacentText (XmlDoc property)|AdjacentText]]</td><td>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>[[AllowNull (XmlDoc property)|AllowNull]]</td><td>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>[[AllowXmlElement (XmlDoc property)|AllowXmlElement]]</td><td>May Element names begin with "xml"?</td></tr>
<tr><td valign="top">[[AllowXmlAttribute (XmlDoc property)|AllowXmlAttribute]]</td><td valign="top">May Attribute names begin with "xml"?</td></tr>
<tr><td>[[Audit (XmlDoc subroutine)|Audit]]</td><td>Display selected subtree on audit trail</td></tr>
<tr><td valign="top">[[AllowXmlElement (XmlDoc property)|AllowXmlElement]]</td><td valign="top">May Element names begin with "xml"?</td></tr>
<tr><td>[[ClientCertificate (XmlDoc function)|ClientCertificate]]</td><td>Create a client certificate XmlDoc</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>[[Copy (XmlDoc function)|Copy]]</td><td>Copy this XmlDoc</td></tr>
<tr><td valign="top">[[ClientCertificate (XmlDoc function)|ClientCertificate]]</td><td valign="top">Create XmlDoc with client certificate details</td></tr>
<tr><td>[[Debug (XmlDoc function)|Debug]]</td><td>Debug information</td></tr>
<tr><td valign="top">[[Copy (XmlDoc function)|Copy]]</td><td valign="top">Copy this XmlDoc</td></tr>
<tr><td>[[DeepCopy (XmlDoc function)|DeepCopy]]</td><td>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>[[DefaultURI (XmlDoc function)|DefaultURI]]</td><td>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>[[DeleteSelectionPrefix (XmlDoc subroutine)|DeleteSelectionPrefix]]</td><td>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>[[DeleteSubtree (XmlDoc subroutine)|DeleteSubtree]]</td><td>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>[[DeleteTopElement (XmlDoc subroutine)|DeleteTopElement]]</td><td>Delete the top element</td></tr>
<tr><td valign="top">[[DeleteTopElement (XmlDoc subroutine)|DeleteTopElement]]</td><td valign="top">Delete top element from XmlDoc</td></tr>
<tr><td>[[Encoding (XmlDoc property)|Encoding]]</td><td>Encode this XmlDoc object</td></tr>
<tr><td valign="top">[[Encoding (XmlDoc property)|Encoding]]</td><td valign="top">Encoding of XML document</td></tr>
<tr><td>[[Exists (XmlDoc function)|Exists]]</td><td>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>[[InvalidChar (XmlDoc property)|InvalidChar]]</td><td>Allow invalid characters (obsolete)</td></tr>
<tr><td valign="top">[[InvalidChar (XmlDoc property)|InvalidChar]]</td><td valign="top">Allow invalid characters (obsolete)</td></tr>
<tr><td>[[InvalidCharacterPosition (XmlDoc function)|InvalidCharacterPosition]]</td><td>Detect invalid characters</td></tr>
<tr><td valign="top">[[InvalidCharacterPosition (XmlDoc function)|InvalidCharacterPosition]]</td><td valign="top">Detect invalid characters</td></tr>
<tr><td>[[IsSelectionPrefix (XmlDoc function)|IsSelectionPrefix]]</td><td>Check if prefix has XPath-selection association</td></tr>
<tr><td valign="top">[[IsSelectionPrefix (XmlDoc function)|IsSelectionPrefix]]</td><td valign="top">Check if prefix has XPath-selection association</td></tr>
<tr><td>[[IsValidString (XmlDoc function)|IsValidString]]</td><td>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>[[Length (XmlDoc function)|Length]]</td><td>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>[[LoadFromRecord (XmlDoc subroutine)|LoadFromRecord]]</td><td>Load fields and fieldgroups from current record</td></tr>
<tr><td valign="top">[[LoadChangedRecords (XmlDoc subroutine)|LoadChangedRecords]]</td><td valign="top">Load ChangedRecords into this XmlDoc</td></tr>
<tr><td>[[LoadFromStringlist (XmlDoc function)|LoadFromStringlist]]</td><td>(Obsolete)</td></tr>
<tr><td valign="top">[[LoadCommandInfo (XmlDoc subroutine)|LoadCommandInfo]]</td><td valign="top">Load command info into this XmlDoc</td></tr>
<tr><td>[[LoadParameterInfo (XmlDoc subroutine)|LoadParameterInfo]]</td><td>Load parameter 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>[[LoadSystemMethodInfo (XmlDoc subroutine)|LoadSystemMethodInfo]]</td><td>Load info about system methods into this XmlDoc</td></tr>
<tr><td valign="top">[[LoadFromStringlist (XmlDoc/XmlNode function)|LoadFromStringlist]]</td><td valign="top">Deserialize Stringlist into XmlDoc (obsolete)</td></tr>
<tr><td>[[LoadXml (XmlDoc function)|LoadXml]]</td><td>Deserialize text string into XmlDoc Root or into Element XmlNode</td></tr>
<tr><td valign="top">[[LoadMessageInfo (XmlDoc subroutine)|LoadMessageInfo]]</td><td valign="top">Load message info into this XmlDoc</td></tr>
<tr><td>[[LocalName (XmlDoc function)|LocalName]]</td><td>Name (without prefix) of selected node</td></tr>
<tr><td valign="top">[[LoadMsgctl (XmlDoc subroutine)|LoadMsgctl]]</td><td valign="top">Load MSGCTL commands to this XmlDoc</td></tr>
<tr><td>[[Namespace (XmlDoc property)|Namespace]]</td><td>(Dis)allow or disable prefix handling</td></tr>
<tr><td valign="top">[[LoadParameterInfo (XmlDoc subroutine)|LoadParameterInfo]]</td><td valign="top">Load parameter info into this XmlDoc</td></tr>
<tr><td>[[NewFromRecord (XmlDoc function)|NewFromRecord]]</td><td>Create a new XmlDoc from the current record</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>[[Prefix (XmlDoc function)|Prefix]]</td><td>Prefix part of name of selected node</td></tr>
<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>[[PrefixURI (XmlDoc function)|PrefixURI]]</td><td>URI of specified prefix in context 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>[[Print (XmlDoc subroutine)|Print]]</td><td>Print selected subtree</td></tr>
<tr><td valign="top">[[Namespace (XmlDoc property)|Namespace]]</td><td valign="top">(Dis)allow or disable prefix handling</td></tr>
<tr><td>[[PrintSchema (XmlDoc subroutine)|PrintSchema]]</td><td>Print this XmlDoc schema</td></tr>
<tr><td valign="top">[[New (XmlDoc constructor)|New]]</td><td valign="top">Create a new XmlDoc object</td></tr>
<tr><td>[[Qname (XmlDoc function)|Qname]]</td><td>Name (with prefix, if any) of selected node</td></tr>
<tr><td valign="top">[[NewFromRecord (XmlDoc function)|NewFromRecord]]</td><td valign="top">Create a new XmlDoc from the current record</td></tr>
<tr><td>[[SelectCount (XmlDoc function)|SelectCount]]</td><td>Number of selected nodes</td></tr>
<tr><td valign="top">[[Prefix (XmlDoc/XmlNode function)|Prefix]]</td><td valign="top">Prefix part of name of selected node</td></tr>
<tr><td>[[SelectNodes (XmlDoc function)|SelectNodes]]</td><td>Get list of selected nodes as XmlNodelist</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>[[SelectSingleNode (XmlDoc function)|SelectSingleNode]]</td><td>Get selected node as XmlNode</td></tr>
<tr><td valign="top">[[Print (XmlDoc/XmlNode subroutine)|Print]]</td><td valign="top">Print selected subtree</td></tr>
<tr><td>[[SelectionNamespace (XmlDoc property)|SelectionNamespace]]</td><td>Bind prefix to URI (or null) for XPath</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>[[Serial (XmlDoc function)|Serial]]</td><td>Serialize selected subtree as string</td></tr>
<tr><td valign="top">[[SelectCount (XmlDoc/XmlNode function)|SelectCount]]</td><td valign="top">Number of selected nodes</td></tr>
<tr><td>[[Standalone (XmlDoc property)|Standalone]]</td><td>Standalone specification in "XML declaration"</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>[[ToXPathString (XmlDoc function)|ToXPathString]]</td><td>XPath expression for selected node</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>[[ToXPathStringlist (XmlDoc function)|ToXPathStringlist]]</td><td>XPath expression for selected node</td></tr>
<tr><td valign="top">[[SelectSingleNode (XmlDoc/XmlNode function)|SelectSingleNode]]</td><td valign="top">Get selected node as XmlNode</td></tr>
<tr><td>[[Trace (XmlDoc subroutine)|Trace]]</td><td>Display selected subtree on Trace stream</td></tr>
<tr><td valign="top">[[Serial (XmlDoc/XmlNode function)|Serial]]</td><td valign="top">Serialize selected subtree as string</td></tr>
<tr><td>[[Type (XmlDoc function)|Type]]</td><td>Type of selected node</td></tr>
<tr><td valign="top">[[Standalone (XmlDoc property)|Standalone]]</td><td valign="top">Standalone specification in "XML declaration"</td></tr>
<tr><td>[[URI (XmlDoc function)|URI]]</td><td>Namespace URI of name of 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>[[Validate (XmlDoc function)|Validate]]</td><td>Validate substring against longstring schema</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>[[Value (XmlDoc property)|Value]]</td><td>String-value of 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>[[ValueDefault (XmlDoc function)|ValueDefault]]</td><td>String-value of selected node (allow empty XPath)</td></tr>
<tr><td valign="top">[[Type (XmlDoc/XmlNode function)|Type]]</td><td valign="top">Type of selected node</td></tr>
<tr><td>[[Version (XmlDoc property)|Version]]</td><td>Version number in "XML declaration"</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>[[WebReceive (XmlDoc function)|WebReceive]]</td><td>Deserialize Web request into XmlDoc</td></tr>
<tr><td valign="top">[[Value (XmlDoc/XmlNode property)|Value]]</td><td valign="top">String-value of selected node</td></tr>
<tr><td>[[WebSend (XmlDoc subroutine)|WebSend]]</td><td>Serialize XmlDoc as Web response</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>[[XPathNodeID (XmlDoc function)|XPathNodeID]]</td><td>XPath expression for selected node</td></tr>
<tr><td valign="top">[[Version (XmlDoc property)|Version]]</td><td valign="top">Version number in "XML declaration"</td></tr>
<tr><td>[[XPathSingleHint (XmlDoc property)|XPathSingleHint]]</td><td></td></tr>
<tr><td valign="top">[[WebReceive (XmlDoc function)|WebReceive]]</td><td valign="top">Deserialize Web request into this XmlDoc</td></tr>
<tr><td>[[Xml (XmlDoc function)|Xml]]</td><td>Serialize XmlDoc as UTF-8 string</td></tr>
<tr><td valign="top">[[WebSend (XmlDoc subroutine)|WebSend]]</td><td valign="top">Serialize XmlDoc as Web response</td></tr>
<tr><td>[[XmlDocID (XmlDoc function)|XmlDocID]]</td><td>Print the id of this XmlDoc</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">[[XPathNodeID (XmlDoc/XmlNode function)|XPathNodeID]]</td><td valign="top">XPath expression (in Stringlist) for selected node</td></tr>
</table>
</table>
</div>
==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 XmlNode methods]]
<li>[[List of XmlNodelist methods]]
<li>[[List of XmlDoc API 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 03:55, 15 January 2020

The following are the available XmlDoc class methods.

MethodDescription
AddCommentAdd Comment to XmlDoc Root or to Element XmlNode
AddElementAdd Element to XmlDoc Root or to Element XmlNode
AddPIAdd Processing Instruction to XmlDoc Root or to Element XmlNode
AddSubtreeCopy subtree to XmlDoc Root or to Element XmlNode
AddTopElementAdd new top element to XmlDoc
AddToRecordAdd fields and/or fieldgroups to the current record
AdjacentTextAre adjacent text nodes allowed?
AllowNullAllow null characters in node values?
AllowXmlAttributeMay Attribute names begin with "xml"?
AllowXmlElementMay Element names begin with "xml"?
AuditDisplay selected subtree on audit trail
ClientCertificateCreate XmlDoc with client certificate details
CopyCopy this XmlDoc
DeepCopyDeep copy this XmlDoc
DefaultURIDefault URI in scope at selected node
DeleteSelectionPrefixDelete prefix's XPath-selection association
DeleteSubtreeDelete selected subtree
DeleteTopElementDelete top element from XmlDoc
EncodingEncoding of XML document
ExistsIs XPath result non-empty?
InvalidCharAllow invalid characters (obsolete)
InvalidCharacterPositionDetect invalid characters
IsSelectionPrefixCheck if prefix has XPath-selection association
IsValidStringValid XML Element/Attribute value? (obsolete)
LengthLength of string-value of selected node
LoadChangedRecordsLoad ChangedRecords into this XmlDoc
LoadCommandInfoLoad command info into this XmlDoc
LoadFromRecordLoad fields and fieldgroups from current record
LoadFromStringlistDeserialize Stringlist into XmlDoc (obsolete)
LoadMessageInfoLoad message info into this XmlDoc
LoadMsgctlLoad MSGCTL commands to this XmlDoc
LoadParameterInfoLoad parameter info into this XmlDoc
LoadSystemMethodInfoLoad info about system methods into this XmlDoc
LoadXmlDeserialize XML document or fragment into XmlDoc Root or into Element XmlNode
LocalNameName (without prefix) of selected node
Namespace(Dis)allow or disable prefix handling
NewCreate a new XmlDoc object
NewFromRecordCreate a new XmlDoc from the current record
PrefixPrefix part of name of selected node
PrefixURIURI of specified prefix in context of selected node
PrintPrint selected subtree
QNameName (with prefix, if any) of selected node
SelectCountNumber of selected nodes
SelectionNamespaceBind prefix to URI (or null) for XPath
SelectNodesGet list of selected nodes as XmlNodelist
SelectSingleNodeGet selected node as XmlNode
SerialSerialize selected subtree as string
StandaloneStandalone specification in "XML declaration"
ToXPathStringXPath expression for selected node
ToXPathStringlistXPath expression (in Stringlist) for selected node
TraceDisplay selected subtree on Trace stream
TypeType of selected node
URINamespace URI of name of selected node
ValueString-value of selected node
ValueDefaultString-value of selected node (allow empty XPath)
VersionVersion number in "XML declaration"
WebReceiveDeserialize Web request into this XmlDoc
WebSendSerialize XmlDoc as Web response
XmlSerialize XmlDoc as UTF-8 string
XPathNodeIDXPath expression (in Stringlist) for selected node

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=List_of_XmlDoc_methods&oldid=117838"