Whitebeam Template Reference Documentation
rb.XmlParser Object Description
|
| rb.XmlParser.mode() | Configures how the parser will interpret data. |
| rb.XmlParser.build() | Build an XML tree from some XML source. |
| rb.XmlParser.thisTag() | Return the current 'context' XML element. |
| rb.XmlParser.clean() | Clean the contents of the XML parser. |
| rb.XmlParser.loadSyntax() | Load a set of parsing rules. |
| rb.XmlParser.execute() | Re-execute part of an XML tag tree. Each note gets to re-evaluate its contribution to the document being generated. ADVANCED. |
| rb.XmlParser.bodytext() | Generate the text representation of the XML subtree. ADVANCED. |
| rb.XmlParser.text() | Generate the text representation of the XML subtree. ADVANCED. |
Object Properties
| Name | Type/Value | Range/Length | Description |
|---|---|---|---|
| removeComments | bool | Optional, default = true This is a control flag used to modify the behaviour of the parser when it builds the internal XML representation of a document. If this flag is set (true) the parser will filter all XML comments from the DOM. | |
| removeWhitespace | bool | Optional, default = true This is a control flag used to modify the behaviour of the parser when it builds the internal XML representation of a document. If this flag is set (true) the parser will remove whitespace between adjacent tags (or the end on one tag and the start of the next). Whitespace is *only* removed *if* there is only whitespace separating the tags. | |
| removeDecls | bool | Optional, default = true This is a control flag used to modify the behaviour of the parser when it builds the internal XML representation of a document. If this flag is set (true) the parser will filter all XML declarations from the DOM. Declarations are of the form: | |
| removeProcInst | bool | Optional, default = true This is a control flag used to modify the behaviour of the parser when it builds the internal XML representation of a document. If this flag is set (true) the parser will filter all XML comments from the DOM. | |
| root | struct XmlTag | see definition | Required. This is the 'root' of the XML tree. The root is the 'virtual' XML tag element that contains all the top level elements that exist within the document being processed. |
| errors | array of strings | Required. This property is created after calling XmlParser.build()if constructing the tree generated any parsing errors. |
Whitebeam release 1.3.36
(loadtime : 30ms)