Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Div
iddescription



HTML Table
id
classservoy sReturnTypes
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Return Types
Table Row (tr)
Table Cell (td)
Span
classsWordList
XmlNode



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
XmlNode[]
Table Cell (td)
readXmlDocumentFromFile(argument)
Reads an XML document from a file.
Table Row (tr)
Table Cell (td)
XmlNode[]
Table Cell (td)
readXmlDocumentFromString(argument)
Reads an XML document from a string.



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idreadXmlDocumentFromFile-Object
Table Row (tr)
idname
Table Cell (td)

readXmlDocumentFromFile

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XmlNode[]
Span
stylefont-weight: bold;
readXmlDocumentFromFile
Span
(argument)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Reads an XML document from a file.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} argument
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XmlNode[]
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// specifies a reference to a file containing valid XML
var xmlNodes = plugins.XmlReader.readXmlDocumentFromFile('c:/test.xml');
var childNodes = xmlNodes[0].getChildNodes();
// shows a dialog to open an xml file, then reads the file
var xmlFile = plugins.file.showFileOpenDialog(1);
var xmlNodes = plugins.XmlReader.readXmlDocumentFromFile(xmlFile);
var childNodes = xmlNodes[0].getChildNodes();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idreadXmlDocumentFromString-String
Table Row (tr)
idname
Table Cell (td)

readXmlDocumentFromString

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XmlNode[]
Span
stylefont-weight: bold;
readXmlDocumentFromString
Span
(argument)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Reads an XML document from a string.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} argument
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XmlNode[]
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var xmlString = '<books><book price="44.95">' +
'<title>Core Java 1.5</title>' +
'<author>Piet Klerksen</author>' +
'<nrPages>1487</nrPages>' +
'</book>' +
'<book price="59.95">' +
'<title>Developing with Servoy</title>' +
'<author>Cheryl Owens and others</author><nrPages>492</nrPages></book></books>';
var xmlNodes = plugins.XmlReader.readXmlDocumentFromString(xmlString);
Table Row (tr)
classlastDetailRow
Table Cell (td)