Difference between revisions of "Extensions.Xml.GetXmlRootElement"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
| − | {{DISPLAYTITLE:OTX ''' | + | {{DISPLAYTITLE:OTX '''GetXmlRootElement'''}}[[Category:Xml]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | | + | {{ClassificationActivity | GetXmlRootElement|Returns the root element of an '''XML''' document.| [[Term]] | [[Extensions.Xml|OTX Xml extension]] |[[Extensions.Xml#Terms|Xml related Terms]] | - | - |}} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | XmlElementTerm = Xml.GetXmlRootElement(XmlDocumentTerm); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The ''' | + | The '''GetXmlRootElement''' term returns the root element (root node) of an '''XML''' document. |
| − | + | {{TermReturnValue| [[Extensions.Xml.XmlElement|XmlElement]] | The root element of an '''XML''' document.}} | |
| − | |||
| − | {{TermReturnValue| [[ | ||
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie2| Document|[[Extensions.Xml.XmlDocument|XmlDocument]] | [[Term]] | - |[1..1]| The '''XmlDocument''' object to which the operation is applied.}} | + | {{TableRowPropertie2| Document|[[Extensions.Xml.XmlDocument|XmlDocument]] | [[Term]] | - |[1..1]| The '''XmlDocument''' object, to which the operation is applied.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | Xml.XmlDocument XmlDocument1; | ||
Xml.XmlElement XmlElement1; | Xml.XmlElement XmlElement1; | ||
| − | |||
/// Flow | /// Flow | ||
| − | + | XmlDocument1 = Xml.XmlLoadFromFile("XmlStorage/GetXmlElementsByXPath.xml", @Encoding:UTF-8); | |
| − | + | XmlElement1 = Xml.GetXmlRootElement(XmlDocument1); | |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 40: | Line 38: | ||
[[Extensions.Xml.GetXmlElementName|GetXmlElementName]]<br/> | [[Extensions.Xml.GetXmlElementName|GetXmlElementName]]<br/> | ||
[[Extensions.Xml.GetXmlElementsByXPath|GetXmlElementsByXPath]]<br/> | [[Extensions.Xml.GetXmlElementsByXPath|GetXmlElementsByXPath]]<br/> | ||
| − | + | [[Extensions.Xml.GetXmlElementText|GetXmlElementText]]<br/> | |
| − | [[Extensions.Xml.GetXmlRootElement|GetXmlRootElement]]<br/> | + | <!--[[Extensions.Xml.GetXmlRootElement|GetXmlRootElement]]<br/>--> |
[[Extensions.Xml.XmlFromByteField|XmlFromByteField]]<br/> | [[Extensions.Xml.XmlFromByteField|XmlFromByteField]]<br/> | ||
[[Extensions.Xml.XmlLoadFromFile|XmlLoadFromFile]]<br/> | [[Extensions.Xml.XmlLoadFromFile|XmlLoadFromFile]]<br/> | ||
[[Extensions.Xml.XmlToByteField|XmlToByteField]]<br/> | [[Extensions.Xml.XmlToByteField|XmlToByteField]]<br/> | ||
Revision as of 11:00, 9 October 2018
Contents
Classification
| Name | GetXmlRootElement |
| Short Description | Returns the root element of an XML document. |
| Class | Term |
| Extension | OTX Xml extension |
| Group | Xml related Terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
XmlElementTerm = Xml.GetXmlRootElement(XmlDocumentTerm);Description
The GetXmlRootElement term returns the root element (root node) of an XML document.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| XmlElement | The root element of an XML document. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Document | XmlDocument | Term | - | [1..1] | The XmlDocument object, to which the operation is applied. |
OTL Examples
Xml.XmlDocument XmlDocument1;
Xml.XmlElement XmlElement1;
/// Flow
XmlDocument1 = Xml.XmlLoadFromFile("XmlStorage/GetXmlElementsByXPath.xml", @Encoding:UTF-8);
XmlElement1 = Xml.GetXmlRootElement(XmlDocument1);See also
CopyXmlElement
CreateXmlDocument
CreateXmlElement
GetXmlElementAttributes
GetXmlElementChildElements
GetXmlElementName
GetXmlElementsByXPath
GetXmlElementText
XmlFromByteField
XmlLoadFromFile
XmlToByteField
