XML Document <XmlDocument>

Synopsis

XmlDocument represents the base design (mixin) for XMLParsedDocument.

Mixins

ExternalResource, LightweightPart

Rules

Name	Type	Description
AllowedComponents	list	List of the Design names that may be children of this Design instance. XmlDocument consists only of the XmlElements.
RootElement	part	Returns the Root Part of the document. Corresponds to XML document structure that defines a single root node.

Methods

SaveToFile( outputFileName As String, _
             Optional overwriteIfExists? As Boolean = True, _
             Optional ignoreErrors? As Boolean = False ) As Boolean

Saves the contents of the XML document's RootElement hierarchy into file. For each XMLElement in the hierarchy the function writes the values of their XMLName, Attributes, and Contents rules. Returns True if the operation succeeds.

Argument	Description
outputFileName	The full path and file name of the output file.
overwriteIfExists?	Optional; if True, and file with outputfileName exists, the file will be overwritten; default is True.
ignoreErrors?	Optional; if True, then failure in operation does not result in an exception; default is False.

XSLTransform( xslFileName As String, _
               outputFileName As String, _
               Optional xslArgs As List = {}, _
               Optional overwriteIfExists? As Boolean = True, _
               Optional ignoreErrors? As Boolean = False ) As Boolean

Performs XSL transformation of the XMLDocument. Returns True if the operation succeeds.

Argument	Description
xslFileName	The full path and file name of XSL transformation file.
outputFileName	The full path and file name of the output file.
xslArgs	Optional; additional parameters for XSL transformation in a flattened list (plist) of name/value pairs; default is {}.
overwriteIfExists?	Optional; if True, and file with outputfileName exists, the file will be overwritten; default is True.
ignoreErrors?	Optional; if True, then failure in operation does not result in an exception; default is False.