Difference between revisions of "Extensions.Xml.GetXmlRootElement"

From emotive
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{DISPLAYTITLE:OTX '''GetXmlElementText'''}}[[Category:Xml]]
+
{{DISPLAYTITLE:OTX '''GetXmlRootElement'''}}[[Category:Xml]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetXmlElementText|Returns the text of an '''XML''' element| [[Term]] | [[Extensions.Xml|OTX Xml extension]] |[[Extensions.Xml#Terms|Xml related Terms]] | - | - |}}
+
{{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;">
−
StringTerm = Xml.GetXmlElementText(XmlElementTerm);
+
XmlElementTerm Xml.GetXmlRootElement(XmlDocumentTerm document);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetXmlElementText''' term returns the text of an '''XML''' element as a String. If no text is available an empty string is returned. Escaped special characters shall be unescaped.
+
The '''GetXmlRootElement''' term returns the root element (root node) of an '''XML''' document.
  
−
If the element contains CDATA's the returned string contains the content of the CDATA section as it is. If the element contains multiple text and/or CDATA nodes, the returned String is the concatenation of all these nodes.
+
{{TermReturnValue| [[Extensions.Xml.XmlElement|XmlElement]] | The root element of an '''XML''' document.}}
−
 
 
−
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The text of an '''XML''' element.}}
 
  
 
== 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;">
 +
/// Local Declarations
 +
 +
Xml.XmlDocument XmlDocument1;
 
Xml.XmlElement XmlElement1;
 
Xml.XmlElement XmlElement1;
−
String String1 = "";
 
  
 
/// Flow
 
/// Flow
  
−
XmlElement1 = Xml.CreateXmlElement("root", "abc");
+
XmlDocument1 = Xml.XmlLoadFromFile("XmlStorage/GetXmlElementsByXPath.xml", @Encoding:UTF-8);
−
String1 = Xml.GetXmlElementText(XmlElement1);
+
XmlElement1 = Xml.GetXmlRootElement(XmlDocument1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 40: Line 40:
 
[[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.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/>

Latest revision as of 05:59, 8 November 2018

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 document);

Description

The GetXmlRootElement term returns the root element (root node) of an XML document.

Return Value

The Term returns the value, see table below.

Icons Note.png 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

/// Local Declarations

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

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.Xml.GetXmlRootElement&oldid=9193"