# XML Class The XML class can be used to both parse and create XML documents. ## Syntax **ipworks.xml()** ## Remarks The XML class can operate as either a parser or writer of XML. ### Parsing XML The XML class parses XML documents and verifies that they are well formed. The results are provided through a set of events complying with the SAX2 specification. In addition, the document structure may be queried through an [XPath](#xmlxpath-property) mechanism that supports a subset of the XPath specification. The parser is optimized for read applications, with a very fast engine that builds internal Document Object Model (DOM) structures with close to zero heap allocations. Additionally, [BuildDOM](#xmlbuilddom-property) can be set to *false*, which reduces the overhead of creating the DOM and offers a fast, forward-only parsing implementation that fires events to provide the parsed data. When parsing a document, events will fire to provide information about the parsed data. After [Parse](#xmlparse-method) returns, the document may be navigated by setting [XPath](#xmlxpath-property) if [BuildDOM](#xmlbuilddom-property) is *true* (default). If [BuildDOM](#xmlbuilddom-property) is *false*, parsed data are accessible only through the events. Events are fired only when qualifying conditions (e.g., the beginning of a new element) are met. In the meantime, text will be buffered internally. The following events will fire during parsing: - [Characters](#xmlcharacters-event) - [Comment](#xmlcomment-event) - [EndElement](#xmlendelement-event) - [EndPrefixMapping](#xmlendprefixmapping-event) - [EvalEntity](#xmlevalentity-event) - [IgnorableWhitespace](#xmlignorablewhitespace-event) - [Meta](#xmlmeta-event) - [PI](#xmlpi-event) - [SpecialSection](#xmlspecialsection-event) - [StartElement](#xmlstartelement-event) - [StartPrefixMapping](#xmlstartprefixmapping-event) If [BuildDOM](#xmlbuilddom-property) is *true* (default), [XPath](#xmlxpath-property) may be set after this method returns. [XPath](#xmlxpath-property) implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML document. The path is a series of one or more element accessors separated by */*. The path can be absolute (starting with */*) or relative to the current [XPath](#xmlxpath-property) location. The following are possible values for an element accessor: | | | | --- | --- | | 'name' | A particular element name | | name[i] | The i-th subelement of the current element with the given name | | [i] | The i-th subelement of the current element | | [last()] | The last subelement of the current element | | [last()-i] | The subelement located at the last location minus i in the current element | | name[@attrname="attrvalue"] | The subelement containing a particular value for a given attribute (supports single AND double quotes) | | .. | The parent of the current element | When [XPath](#xmlxpath-property) is set to a valid path, [XElement](#xmlxelement-property) points to the name of the element, with [XParent](#xmlxparent-property), [XNamespace](#xmlxnamespace-property), [XPrefix](#xmlxprefix-property), XChildrenName, XChildrenNamespace, XChildrenPrefix, XChildrenXText, and [XText](#xmlxtext-property) providing other properties of the element. The attributes of the current element are provided in the XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue collection. [BuildDOM](#xmlbuilddom-property) must be set to *true* before parsing the document for the [XPath](#xmlxpath-property) functionality to be available. **Example. Setting XPath:** | | | | --- | --- | | Document root | XML.XPath = "/" | | Specific Element | XML.XPath = "/root/SubElement1/SubElement2/" | | i-th Child | XML.XPath = "/root/SubElement1[i]" | **Input Properties** The class will determine the source of the input based on which properties are set. The order in which the input properties are checked is as follows: - [InputFile](#xmlinputfile-property) - [InputData](#xmlinputdata-property) When a valid source is found, the search stops. If parsing multiple documents, call [Reset](#xmlreset-method) between documents to reset the parser. An additional "relaxed" mode allows for lexical parsing of non-XML documents (e.g., HTML). This is enabled by setting [Validate](#xmlvalidate-property) to *false*. In this case, events will be fired as elements, entities, and so on are encountered, but the structure of the document will not be checked for "well-formedness", and the internal DOM structure will not be built. ### Writing XML To use the class, first decide whether or not to write to a file or [OutputData](#xmloutputdata-property). **Output Properties** The class will determine the destination of the output based on which properties are set. The order in which the output properties are checked is as follows: - [OutputFile](#xmloutputfile-property) - [OutputData](#xmloutputdata-property): The output data are written to this property if no other destination is specified. To begin writing the XML document, first optionally set [XMLDeclaration](#xmlxmldeclaration-property). If this is not set, the class will use a default XML declaration at the beginning of the document. Next, begin adding elements to your document. Calling [StartElement](#xmlstartelement-method) will open an element with the specified name. To create a nested structure, continue calling [StartElement](#xmlstartelement-method) to open more child elements. To write a value within an element, call [PutString](#xmlputstring-method). To close the element that was last opened, call [EndElement](#xmlendelement-method). Each time [EndElement](#xmlendelement-method) is called, the element at the current level is closed. Alternatively, calling [PutElement](#xmlputelement-method) will write the element with the value specified and will also close the element. To write an attribute of the current element, call [PutAttr](#xmlputattr-method) after calling [StartElement](#xmlstartelement-method). Call [PutAttr](#xmlputattr-method) multiple times to add multiple attributes. Writing comments or CDATA can be done at any time with the [PutComment](#xmlputcomment-method) and [PutCData](#xmlputcdata-method) methods. To close your XML document, call [Save](#xmlsave-method). You can call [Save](#xmlsave-method) from any location, and it will close any remaining open elements automatically. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BuildDOM](#xmlbuilddom-property) | When set to true, this property creates an internal object model of the XML document. | | [InputData](#xmlinputdata-property) | This property specifies the XML data to parse. | | [InputFile](#xmlinputfile-property) | This property specifies the file to process. | | [Namespaces](#xmlnamespaces-property) | This property includes a collection of namespaces in the current namespace stack. | | [OutputData](#xmloutputdata-property) | The output XML after processing. | | [OutputFile](#xmloutputfile-property) | This property includes the path to a local file where the output will be written. | | [Overwrite](#xmloverwrite-property) | This property indicates whether or not the class should overwrite files. | | [Validate](#xmlvalidate-property) | This property controls whether documents are validated during parsing. | | [XAttributes](#xmlxattributes-property) | This property includes a collection of attributes of the current element. | | [XChildren](#xmlxchildren-property) | This property includes a collection of child elements of the currently selected XML element. | | [XComments](#xmlxcomments-property) | This property includes a collection of comments of the current element. | | [XElement](#xmlxelement-property) | This property includes the name of the current element. | | [XMLDeclaration](#xmlxmldeclaration-property) | This property specifies details of the XML declaration. | | [XNamespace](#xmlxnamespace-property) | This property includes the namespace of the current element. | | [XParent](#xmlxparent-property) | This property includes the parent of the current element. | | [XPath](#xmlxpath-property) | This property provides a way to point to a specific element in the document. | | [XPrefix](#xmlxprefix-property) | This property includes the prefix of the current element. | | [XSubTree](#xmlxsubtree-property) | This property includes a snapshot of the current element in the document. | | [XText](#xmlxtext-property) | This property includes the text of the current element. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Config](#xmlconfig-method) | Sets or retrieves a configuration setting. | | [EndElement](#xmlendelement-method) | This method writes the closing tag of an open XML element. | | [Flush](#xmlflush-method) | This method flushes the parser and checks its end state. | | [GetAttr](#xmlgetattr-method) | This method returns the value of the specified attribute. | | [HasXPath](#xmlhasxpath-method) | This method determines whether a specific element exists in the document. | | [InsertAttr](#xmlinsertattr-method) | This method inserts a new attribute into the current element. | | [InsertElement](#xmlinsertelement-method) | This method inserts a new child element into the current element. | | [Interrupt](#xmlinterrupt-method) | This method interrupts the current method. | | [LoadDOM](#xmlloaddom-method) | This method loads the document object model (DOM) from a file. | | [LoadSchema](#xmlloadschema-method) | This method loads the XML schema. | | [Parse](#xmlparse-method) | This method parses the specified XML data. | | [PutAttr](#xmlputattr-method) | This method writes an XML attribute. | | [PutCData](#xmlputcdata-method) | This method writes an XML CDATA block. | | [PutComment](#xmlputcomment-method) | This method writes an XML comment block. | | [PutElement](#xmlputelement-method) | This method writes a simple XML element with a value. | | [PutRaw](#xmlputraw-method) | This method writes a raw XML fragment. | | [PutString](#xmlputstring-method) | This method writes text inside an XML element. | | [RemoveAttr](#xmlremoveattr-method) | This method removes an attribute from the current element. | | [RemoveChildren](#xmlremovechildren-method) | This method removes the children of the element at the specified XPath. | | [RemoveElement](#xmlremoveelement-method) | This method removes the element at the specified XPath. | | [Reset](#xmlreset-method) | This method resets the parser. | | [Save](#xmlsave-method) | This method saves the current XML output. | | [SaveDOM](#xmlsavedom-method) | This method saves the DOM to a file. | | [SetAttr](#xmlsetattr-method) | This method sets the value of an existing attribute in the current element. | | [SetInputStream](#xmlsetinputstream-method) | This method sets the stream from which the class will read data to parse. | | [SetOutputStream](#xmlsetoutputstream-method) | This method sets the stream to which the class will write the XML. | | [StartElement](#xmlstartelement-method) | This method writes the opening tag of an XML element. | | [TryXPath](#xmltryxpath-method) | This method navigates to the specified XPath if it exists. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Characters](#xmlcharacters-event) | This event is fired for plaintext segments of the input stream. | | [Comment](#xmlcomment-event) | This event is fired when a comment section is encountered. | | [EndElement](#xmlendelement-event) | This event is fired when an end-element tag is encountered. | | [EndPrefixMapping](#xmlendprefixmapping-event) | This event is fired when leaving the scope of a namespace declaration. | | [Error](#xmlerror-event) | Fired when information is available about errors during data delivery. | | [EvalEntity](#xmlevalentity-event) | This event is fired every time an entity needs to be evaluated. | | [IgnorableWhitespace](#xmlignorablewhitespace-event) | This event is fired when a section of ignorable whitespace is encountered. | | [Meta](#xmlmeta-event) | This event fires when a meta section is encountered. | | [PI](#xmlpi-event) | This event is fired when a processing instruction section is encountered. | | [SpecialSection](#xmlspecialsection-event) | This event is fired when a special section is encountered. | | [StartElement](#xmlstartelement-event) | This event is fired when a begin-element tag is encountered in the document. | | [StartPrefixMapping](#xmlstartprefixmapping-event) | This event is fired when entering the scope of a namespace declaration. | | [XML](#xmlxml-event) | This event is fired as XML is written. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CacheContent](#CacheContent) | If true, the original XML is saved in a buffer. | | [Charset](#Charset) | Specifies the charset used when encoding data. | | [EOL](#EOL) | The characters to use for separating lines. | | [ErrorOnEmptyAttr](#ErrorOnEmptyAttr) | If true, passing an invalid attribute to the GetAttr method will throw an exception. | | [ExtraNameChars](#ExtraNameChars) | Extra characters for the parser to consider as name characters. | | [ExtraSpaceChars](#ExtraSpaceChars) | Extra characters for the parser to consider as whitespace. | | [FlushOnEOL](#FlushOnEOL) | If set, the parser flushes its text buffer after every line of text. | | [IgnoreBadAttributePrefixes](#IgnoreBadAttributePrefixes) | If true, bad (unknown) attribute prefixes are ignored. | | [IgnoreBadElementPrefixes](#IgnoreBadElementPrefixes) | If true, bad (unknown) element prefixes are ignored. | | [IncludeElementPrefix](#IncludeElementPrefix) | Whether to include the prefix in the element name. | | [IncludeXMLDeclaration](#IncludeXMLDeclaration) | Whether to include the XML declaration when writing XML. | | [Indent](#Indent) | The characters to use for each indentation level. | | [Interrupt](#Interrupt) | Whether to stop parsing the current XML document. | | [Offset](#Offset) | Current offset of the document being parsed. | | [PreserveAll](#PreserveAll) | Whether to preserve processing instructions and comments. | | [PreserveWhitespace](#PreserveWhitespace) | If true, leading and trailing whitespace in element text is preserved. | | [ProcessNamespace](#ProcessNamespace) | Whether the parser will process namespaces. | | [QuoteChar](#QuoteChar) | Quote character to use for attribute values. | | [StringProcessingOptions](#StringProcessingOptions) | Defines options to use when processing string values. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # [XML](#xml-class).BuildDOM Property When set to true, this property creates an internal object model of the XML document. ## Syntax ```text isBuildDOM(): boolean; setBuildDOM(buildDOM: boolean): void; ``` ## Default Value TRUE ## Remarks Set BuildDOM to *true* when you need to browse the current document through [XPath](#xmlxpath-property). [Validate](#xmlvalidate-property) is automatically set to *true* when BuildDOM is set to *true*. # [XML](#xml-class).InputData Property This property specifies the XML data to parse. ## Syntax ```text getInputData(): string; setInputData(inputData: string): void; ``` ## Default Value "" ## Remarks This property specifies the XML to be processed. Set this property before calling [Parse](#xmlparse-method). This property may be set to a complete XML document or to partial data. When setting partial data, call [Parse](#xmlparse-method) after each chunk of data is set. For instance: ```text //Parse the following in chunks: 1 xml.InputData = "" xml.Parse(); xml.InputData = "1" xml.Parse(); ``` **Input Properties** The class will determine the source of the input based on which properties are set. The order in which the input properties are checked is as follows: - [InputFile](#xmlinputfile-property) - InputData When a valid source is found, the search stops. # [XML](#xml-class).InputFile Property This property specifies the file to process. ## Syntax ```text getInputFile(): string; setInputFile(inputFile: string): void; ``` ## Default Value "" ## Remarks This property specifies the file to be processed. Set this property to the full or relative path to the file that will be processed. After setting this property, call [Parse](#xmlparse-method) to parse the document. **Input Properties** The class will determine the source of the input based on which properties are set. The order in which the input properties are checked is as follows: - InputFile - [InputData](#xmlinputdata-property) When a valid source is found, the search stops. # [XML](#xml-class).Namespaces Property This property includes a collection of namespaces in the current namespace stack. ## Syntax ```text getNamespaces(): XMLNamespaceList; ``` ## Default Value ## Remarks This property contains a collection of XML namespaces, which are standards for providing uniquely named elements and attributes in an XML instance. This property is not available at design time. Please refer to the [XMLNamespace](#xmlnamespace-type) type for a complete list of fields. # [XML](#xml-class).OutputData Property The output XML after processing. ## Syntax ```text getOutputData(): string; setOutputData(outputData: string): void; ``` ## Default Value "" ## Remarks This property will be populated with the output from the operation if [OutputFile](#xmloutputfile-property) is not set. # [XML](#xml-class).OutputFile Property This property includes the path to a local file where the output will be written. ## Syntax ```text getOutputFile(): string; setOutputFile(outputFile: string): void; ``` ## Default Value "" ## Remarks This property specifies the file to which the output will be written. This may be set to an absolute or relative path. **Output Properties** The class will determine the destination of the output based on which properties are set. The order in which the output properties are checked is as follows: - OutputFile - [OutputData](#xmloutputdata-property): The output data are written to this property if no other destination is specified. # [XML](#xml-class).Overwrite Property This property indicates whether or not the class should overwrite files. ## Syntax ```text isOverwrite(): boolean; setOverwrite(overwrite: boolean): void; ``` ## Default Value FALSE ## Remarks This property indicates whether or not the class will overwrite [OutputFile](#xmloutputfile-property). If Overwrite is *false*, an error will be thrown whenever [OutputFile](#xmloutputfile-property) exists before an operation. The default value is *false*. # [XML](#xml-class).Validate Property This property controls whether documents are validated during parsing. ## Syntax ```text isValidate(): boolean; setValidate(validate: boolean): void; ``` ## Default Value TRUE ## Remarks When *true* (default), the document will be validated during parsing. To disable validation set Validate to *false*. Disabling validation may be useful in cases in which data can still be parsed even if the document is not well formed. # [XML](#xml-class).XAttributes Property This property includes a collection of attributes of the current element. ## Syntax ```text getXAttributes(): XMLAttributeList; ``` ## Default Value ## Remarks This collection consists of all attributes of the current XML element. The class parses each attribute into a collection of [XMLAttribute](#xmlattribute-type) objects. This property is not available at design time. Please refer to the [XMLAttribute](#xmlattribute-type) type for a complete list of fields. # [XML](#xml-class).XChildren Property This property includes a collection of child elements of the currently selected XML element. ## Syntax ```text getXChildren(): XMLElementList; ``` ## Default Value ## Remarks This property contains a collection of child elements of the currently selected XML element. The elements are provided in the collection in the same order they are found in the XML document. This property is not available at design time. Please refer to the [XMLElement](#xmlelement-type) type for a complete list of fields. # [XML](#xml-class).XComments Property This property includes a collection of comments of the current element. ## Syntax ```text getXComments(): XMLCommentList; ``` ## Default Value ## Remarks This collection consists of all comments of the element at the current [XPath](#xmlxpath-property). The class parses each comment into a collection of [XMLComment](#xmlcomment-type) objects. **This functionality is not yet implemented.** This property is not available at design time. Please refer to the [XMLComment](#xmlcomment-type) type for a complete list of fields. # [XML](#xml-class).XElement Property This property includes the name of the current element. ## Syntax ```text getXElement(): string; setXElement(XElement: string): void; ``` ## Default Value "" ## Remarks The current element is specified through the [XPath](#xmlxpath-property) property. # [XML](#xml-class).XMLDeclaration Property This property specifies details of the XML declaration. ## Syntax ```text getXMLDeclaration(): XMLDeclaration; setXMLDeclaration(XMLDeclaration: XMLDeclaration): void; ``` ## Default Value ## Remarks This property holds details of the XML declaration for the document being written. This is applicable only when writing XML. Please refer to the [XMLDeclaration](#xmldeclaration-type) type for a complete list of fields. # [XML](#xml-class).XNamespace Property This property includes the namespace of the current element. ## Syntax ```text getXNamespace(): string; setXNamespace(XNamespace: string): void; ``` ## Default Value "" ## Remarks The current element is specified through the [XPath](#xmlxpath-property) property. # [XML](#xml-class).XParent Property This property includes the parent of the current element. ## Syntax ```text getXParent(): string; ``` ## Default Value "" ## Remarks The current element is specified through the [XPath](#xmlxpath-property) property. This property is read-only. # [XML](#xml-class).XPath Property This property provides a way to point to a specific element in the document. ## Syntax ```text getXPath(): string; setXPath(XPath: string): void; ``` ## Default Value "" ## Remarks XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML document. The path is a series of one or more element accessors separated by */*. The path can be absolute (starting with */*) or relative to the current XPath location. The following are possible values for an element accessor: | | | | --- | --- | | 'name' | A particular element name | | name[i] | The i-th subelement of the current element with the given name | | [i] | The i-th subelement of the current element | | [last()] | The last subelement of the current element | | [last()-i] | The subelement located at the last location minus i in the current element | | name[@attrname="attrvalue"] | The subelement containing a particular value for a given attribute (supports single AND double quotes) | | .. | The parent of the current element | When XPath is set to a valid path, [XElement](#xmlxelement-property) points to the name of the element, with [XParent](#xmlxparent-property), [XNamespace](#xmlxnamespace-property), [XPrefix](#xmlxprefix-property), XChildrenName, XChildrenNamespace, XChildrenPrefix, XChildrenXText, and [XText](#xmlxtext-property) providing other properties of the element. The attributes of the current element are provided in the XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue collection. [BuildDOM](#xmlbuilddom-property) must be set to *true* before parsing the document for the XPath functionality to be available. **Example. Setting XPath:** | | | | --- | --- | | Document root | XML.XPath = "/" | | Specific Element | XML.XPath = "/root/SubElement1/SubElement2/" | | i-th Child | XML.XPath = "/root/SubElement1[i]" | # [XML](#xml-class).XPrefix Property This property includes the prefix of the current element. ## Syntax ```text getXPrefix(): string; setXPrefix(XPrefix: string): void; ``` ## Default Value "" ## Remarks The current element is specified through the [XPath](#xmlxpath-property) property. # [XML](#xml-class).XSubTree Property This property includes a snapshot of the current element in the document. ## Syntax ```text getXSubTree(): string; ``` ## Default Value "" ## Remarks The current element is specified through the [XPath](#xmlxpath-property) property. For this property to work, you must set [CacheContent](#CacheContent) to *true*. This property is read-only. # [XML](#xml-class).XText Property This property includes the text of the current element. ## Syntax ```text getXText(): string; setXText(XText: string): void; ``` ## Default Value "" ## Remarks The current element is specified through the [XPath](#xmlxpath-property) property. The XText property can be used to update or change the content of the selected element. **Example. Updating an element via XText:** ```text xml.InputData = "John"; xml.Parse(); xml.XPath = "/person/name"; xml.XText; // John xml.XText = "Mary"; xml.Save(); ``` # [XML](#xml-class).config Method Sets or retrieves a configuration setting. ## Syntax ```text async xml.config(configurationString : string): Promise< string> ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-class-ipworksxml) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-class-ipworksxml), you must call *Config("PROPERTY")*. The value will be returned as a string. # [XML](#xml-class).endElement Method This method writes the closing tag of an open XML element. ## Syntax ```text async xml.endElement(): Promise< void> ``` ## Remarks This method writes the closing tag of the XML element most recently opened using [StartElement](#xmlstartelement-method). If no elements are opened, the call . # [XML](#xml-class).flush Method This method flushes the parser and checks its end state. ## Syntax ```text async xml.flush(): Promise< void> ``` ## Remarks When Flush is called, the parser flushes all its buffers, firing events as necessary, and then checks its end state. If [Validate](#xmlvalidate-property) is *true*, the parser verifies that all open elements were closed, returning an error if not. # [XML](#xml-class).getAttr Method This method returns the value of the specified attribute. ## Syntax ```text async xml.getAttr(attrName : string): Promise< string> ``` ## Remarks This method returns the value of the attribute specified by the *AttrName* parameter. If the attribute does not exist, an empty string is returned. The behavior when an attribute does not exist is controlled by [ErrorOnEmptyAttr](#ErrorOnEmptyAttr). Please refer to the XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue collection for more information. # [XML](#xml-class).hasXPath Method This method determines whether a specific element exists in the document. ## Syntax ```text async xml.hasXPath(XPath : string): Promise< boolean> ``` ## Remarks This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it through [XPath](#xmlxpath-property). This method returns *true* if the *XPath* exists, and *false* if not. See [XPath](#xmlxpath-property) for details on the XPath syntax. # [XML](#xml-class).insertAttr Method This method inserts a new attribute into the current element. ## Syntax ```text async xml.insertAttr(name : string, namespaceURI : string, value : string): Promise< void> ``` ## Remarks This method inserts a new attribute into the element at the current [XPath](#xmlxpath-property). This method requires that [BuildDOM](#xmlbuilddom-property) is set to *true*. If the attribute specified by *Name* already exists in the current element, an error is returned. To update an existing attribute, use [SetAttr](#xmlsetattr-method). To write attributes when building a new document from scratch, use [PutAttr](#xmlputattr-method). # [XML](#xml-class).insertElement Method This method inserts a new child element into the current element. ## Syntax ```text async xml.insertElement(name : string, namespaceURI : string, value : string): Promise< void> ``` ## Remarks This method appends a new child element into the element at the current [XPath](#xmlxpath-property). This method requires that [BuildDOM](#xmlbuilddom-property) is set to *true*. Multiple child elements with the same name may be added. To write elements when building a new document from scratch, use [PutElement](#xmlputelement-method). # [XML](#xml-class).interrupt Method This method interrupts the current method. ## Syntax ```text async xml.interrupt(): Promise< void> ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # [XML](#xml-class).loadDOM Method This method loads the document object model (DOM) from a file. ## Syntax ```text async xml.loadDOM(fileName : string): Promise< void> ``` ## Remarks The LoadDOM method loads a DOM structure previously saved by [SaveDOM](#xmlsavedom-method) from the file specified in *FileName*. Please refer to the [SaveDOM](#xmlsavedom-method) method for more information. # [XML](#xml-class).loadSchema Method This method loads the XML schema. ## Syntax ```text async xml.loadSchema(schema : string): Promise< void> ``` ## Remarks **This functionality is not yet implemented.** This method loads the schema specified in the *Schema* parameter. The *Schema* may be specified as either a string or the path to a file on disk. The class will validate the input data during parsing to verify whether or not it adheres to the schema. # [XML](#xml-class).parse Method This method parses the specified XML data. ## Syntax ```text async xml.parse(): Promise< void> ``` ## Remarks This method parses the specified XML data. When parsing a document, events will fire to provide information about the parsed data. After Parse returns, the document may be navigated by setting [XPath](#xmlxpath-property) if [BuildDOM](#xmlbuilddom-property) is *true* (default). If [BuildDOM](#xmlbuilddom-property) is *false*, parsed data are accessible only through the events. Events are fired only when qualifying conditions (e.g., the beginning of a new element) are met. In the meantime, text will be buffered internally. The following events will fire during parsing: - [Characters](#xmlcharacters-event) - [Comment](#xmlcomment-event) - [EndElement](#xmlendelement-event) - [EndPrefixMapping](#xmlendprefixmapping-event) - [EvalEntity](#xmlevalentity-event) - [IgnorableWhitespace](#xmlignorablewhitespace-event) - [Meta](#xmlmeta-event) - [PI](#xmlpi-event) - [SpecialSection](#xmlspecialsection-event) - [StartElement](#xmlstartelement-event) - [StartPrefixMapping](#xmlstartprefixmapping-event) If [BuildDOM](#xmlbuilddom-property) is *true* (default), [XPath](#xmlxpath-property) may be set after this method returns. [XPath](#xmlxpath-property) implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML document. The path is a series of one or more element accessors separated by */*. The path can be absolute (starting with */*) or relative to the current [XPath](#xmlxpath-property) location. The following are possible values for an element accessor: | | | | --- | --- | | 'name' | A particular element name | | name[i] | The i-th subelement of the current element with the given name | | [i] | The i-th subelement of the current element | | [last()] | The last subelement of the current element | | [last()-i] | The subelement located at the last location minus i in the current element | | name[@attrname="attrvalue"] | The subelement containing a particular value for a given attribute (supports single AND double quotes) | | .. | The parent of the current element | When [XPath](#xmlxpath-property) is set to a valid path, [XElement](#xmlxelement-property) points to the name of the element, with [XParent](#xmlxparent-property), [XNamespace](#xmlxnamespace-property), [XPrefix](#xmlxprefix-property), XChildrenName, XChildrenNamespace, XChildrenPrefix, XChildrenXText, and [XText](#xmlxtext-property) providing other properties of the element. The attributes of the current element are provided in the XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue collection. [BuildDOM](#xmlbuilddom-property) must be set to *true* before parsing the document for the [XPath](#xmlxpath-property) functionality to be available. **Example. Setting XPath:** | | | | --- | --- | | Document root | XML.XPath = "/" | | Specific Element | XML.XPath = "/root/SubElement1/SubElement2/" | | i-th Child | XML.XPath = "/root/SubElement1[i]" | **Input Properties** The class will determine the source of the input based on which properties are set. The order in which the input properties are checked is as follows: - [InputFile](#xmlinputfile-property) - [InputData](#xmlinputdata-property) When a valid source is found, the search stops. If parsing multiple documents, call [Reset](#xmlreset-method) between documents to reset the parser. # [XML](#xml-class).putAttr Method This method writes an XML attribute. ## Syntax ```text async xml.putAttr(name : string, namespaceURI : string, value : string): Promise< void> ``` ## Remarks This method writes an XML attribute in the currently opened XML element. It must be called right after calling [StartElement](#xmlstartelement-method) and before any calls to [PutString](#xmlputstring-method), [PutComment](#xmlputcomment-method), or [PutRaw](#xmlputraw-method). If *Name* is a local name without a prefix, the class will automatically introduce a new xmlns="*NamespaceURI*" attribute, if necessary. If *Name* is in the form *prefix:local*, the class will automatically introduce a new xmlns:prefix="*NamespaceURI*" as necessary. Certain attribute names will be handled in special ways by this method. If *Name* is *xmlns* or uses the *xmlns* prefix, the attribute will be interpreted as a namespace declaration, regardless of the value of *NamespaceURI*. Similarly, any attribute using the *xml* prefix will be interpreted as a special attribute (like *xml:lang*) and *NamespaceURI* will be ignored. To add or modify attributes in an existing parsed document, use [InsertAttr](#xmlinsertattr-method) or [SetAttr](#xmlsetattr-method). # [XML](#xml-class).putCData Method This method writes an XML CDATA block. ## Syntax ```text async xml.putCData(text : string): Promise< void> ``` ## Remarks This method writes a new XML CDATA block with the specified text inside the current element. # [XML](#xml-class).putComment Method This method writes an XML comment block. ## Syntax ```text async xml.putComment(text : string): Promise< void> ``` ## Remarks This method writes a new XML comment block with the specified text. # [XML](#xml-class).putElement Method This method writes a simple XML element with a value. ## Syntax ```text async xml.putElement(name : string, namespaceURI : string, value : string): Promise< void> ``` ## Remarks This method writes a simple XML element with no attributes and the specified value between the opening and closing tags. To add elements to an existing parsed document, use [InsertElement](#xmlinsertelement-method). If *Name* is a local name without a prefix, the class will automatically introduce a new xmlns="*NamespaceURI*" attribute, if necessary. If *Name* is in the form *prefix:local*, the class will automatically introduce a new xmlns:prefix="*NamespaceURI*" as necessary. When calling PutElement or [StartElement](#xmlstartelement-method), if a *NamespaceURI* is not specified, an empty namespace will be defined for the element. If a namespace should be associated with the element, a *NamespaceURI* value must be provided. When creating the XML, the class will determine if the namespace already exists to avoid duplicate definitions of the same namespace. For example, to create this XML: ```text Cheaper by the Dozen 1568491379 ``` Use the following code: ```text xml.StartElement("book", "urn:loc.gov:books"); xml.PutAttr("xmlns:isbn", "", "urn:ISBN:0-395-36341-6"); xml.PutElement("title", "urn:loc.gov:books", "Cheaper by the Dozen"); xml.PutElement("isbn:number", "urn:ISBN:0-395-36341-6", "1568491379"); xmlw.Close(); ``` In this example, the *title* element uses the default namespace *urn:loc.gov:books* and the *number* element uses the *urn:ISBN:0-395-36341-6* namespace as defined for the *isbn* prefix. # [XML](#xml-class).putRaw Method This method writes a raw XML fragment. ## Syntax ```text async xml.putRaw(text : string): Promise< void> ``` ## Remarks This method writes a raw XML fragment to the output, without escaping and without verification. If an XML element opening tag has been written before the raw fragment, the fragment will be written as a child of the current element. Use of this method should be carefully considered as it can easily lead to malformed XML content. # [XML](#xml-class).putString Method This method writes text inside an XML element. ## Syntax ```text async xml.putString(text : string): Promise< void> ``` ## Remarks This method will XML escape the value provided and write the resulting escaped text between the opening and closing tags of an XML element. # [XML](#xml-class).removeAttr Method This method removes an attribute from the current element. ## Syntax ```text async xml.removeAttr(attrName : string): Promise< void> ``` ## Remarks This method removes the attribute specified by *AttrName* from the element at the current [XPath](#xmlxpath-property). This method requires that [BuildDOM](#xmlbuilddom-property) is set to *true*. If the specified attribute does not exist in the current element, the method returns without error. **This functionality is not yet implemented.** # [XML](#xml-class).removeChildren Method This method removes the children of the element at the specified XPath. ## Syntax ```text async xml.removeChildren(): Promise< void> ``` ## Remarks This method removes the children of the element specified by [XPath](#xmlxpath-property). This method requires that [BuildDOM](#xmlbuilddom-property) is set to *true*. When called, the class will remove the children of the element from the internal representation of the XML (the DOM). The element itself remains, with no children. This may be used at any time after [Parse](#xmlparse-method) returns, or from within the [EndElement](#xmlendelement-event) event as a document is parsed to remove sections of a document that will not be needed later. By removing unnecessary elements from the DOM, memory consumption is reduced and overall performance is improved. **Example. RemoveChildren:** Given the XML: ```text red yellow ``` This code removes the children of the *apple* element while leaving the *apple* element in place. ```csharp xml.XPath = "/food/fruits/apple"; xml.RemoveChildren(); ``` The XML stored in the DOM is now: ```text yellow ``` # [XML](#xml-class).removeElement Method This method removes the element at the specified XPath. ## Syntax ```text async xml.removeElement(): Promise< void> ``` ## Remarks This method removes the element specified by [XPath](#xmlxpath-property). This method requires that [BuildDOM](#xmlbuilddom-property) is set to *true*. When called, the class will remove the element and its children from the internal representation of the XML (the DOM). This may be used at any time after [Parse](#xmlparse-method) returns, or from within the [EndElement](#xmlendelement-event) event as a document is parsed to remove sections of a document that will not be needed later. By removing unnecessary elements from the DOM, memory consumption is reduced and overall performance is improved. **Example. RemoveElement:** Given the XML: ```text red yellow ``` This code removes the *apple* element and its children. ```csharp xml.XPath = "/food/fruits/apple"; xml.RemoveElement(); ``` The XML stored in the DOM is now: ```text yellow ``` # [XML](#xml-class).reset Method This method resets the parser. ## Syntax ```text async xml.reset(): Promise< void> ``` ## Remarks When called, the parser flushes all its buffers, firing events as necessary, and then initializes itself to its default state. Reset must also be used as a signal to the parser that the current stream of text has terminated. # [XML](#xml-class).save Method This method saves the current XML output. ## Syntax ```text async xml.save(): Promise< void> ``` ## Remarks When used with the streaming writer (e.g., after [StartElement](#xmlstartelement-method) and [EndElement](#xmlendelement-method) calls), this method closes any open XML elements and then closes the [OutputFile](#xmloutputfile-property) if necessary. When used after parsing and modifying a document via the DOM (e.g., after [InsertAttr](#xmlinsertattr-method), [InsertElement](#xmlinsertelement-method), [SetAttr](#xmlsetattr-method), [RemoveAttr](#xmlremoveattr-method), [RemoveElement](#xmlremoveelement-method), or [RemoveChildren](#xmlremovechildren-method)), this method serializes the modified DOM to [OutputFile](#xmloutputfile-property) . # [XML](#xml-class).saveDOM Method This method saves the DOM to a file. ## Syntax ```text async xml.saveDOM(fileName : string): Promise< void> ``` ## Remarks The SaveDOM method saves the current DOM structure to the file specified in *FileName*. This enables the class to later load the DOM without incurring any parsing overhead. Please refer to the [LoadDOM](#xmlloaddom-method) method for more information. # [XML](#xml-class).setAttr Method This method sets the value of an existing attribute in the current element. ## Syntax ```text async xml.setAttr(name : string, namespaceURI : string, value : string): Promise< void> ``` ## Remarks This method updates the value of an attribute in the element at the current [XPath](#xmlxpath-property). This method requires that [BuildDOM](#xmlbuilddom-property) is set to *true*. If the attribute specified by *Name* does not already exist in the current element, an error is returned. To add a new attribute, use [InsertAttr](#xmlinsertattr-method). # [XML](#xml-class).setInputStream Method This method sets the stream from which the class will read data to parse. ## Syntax ```text async xml.setInputStream(inputStream : ReadableStream): Promise< void> ``` ## Remarks This method specifies a stream from which data will be read when [Parse](#xmlparse-method) is called. **Input Properties** The class will determine the source of the input based on which properties are set. The order in which the input properties are checked is as follows: - [InputFile](#xmlinputfile-property) - [InputData](#xmlinputdata-property) When a valid source is found, the search stops. # [XML](#xml-class).setOutputStream Method This method sets the stream to which the class will write the XML. ## Syntax ```text async xml.setOutputStream(outputStream : WriteableStream): Promise< void> ``` ## Remarks This method sets the stream to which output will be written when writing data. **Output Properties** The class will determine the destination of the output based on which properties are set. The order in which the output properties are checked is as follows: - [OutputFile](#xmloutputfile-property) - [OutputData](#xmloutputdata-property): The output data are written to this property if no other destination is specified. # [XML](#xml-class).startElement Method This method writes the opening tag of an XML element. ## Syntax ```text async xml.startElement(name : string, namespaceURI : string): Promise< void> ``` ## Remarks This method writes the opening tag of a new XML element. If an XML element is already opened, then this element is written as a child. If *Name* is a local name without a prefix, the class will automatically introduce a new xmlns="*NamespaceURI*" attribute, if necessary. If *Name* is in the form *prefix:local*, the class will automatically introduce a new xmlns:prefix="*NamespaceURI*" as necessary. When calling [PutElement](#xmlputelement-method) or StartElement, if a *NamespaceURI* is not specified, an empty namespace will be defined for the element. If a namespace should be associated with the element, a *NamespaceURI* value must be provided. When creating the XML, the class will determine if the namespace already exists to avoid duplicate definitions of the same namespace. For example, to create this XML: ```text Cheaper by the Dozen 1568491379 ``` Use the following code: ```text xml.StartElement("book", "urn:loc.gov:books"); xml.PutAttr("xmlns:isbn", "", "urn:ISBN:0-395-36341-6"); xml.PutElement("title", "urn:loc.gov:books", "Cheaper by the Dozen"); xml.PutElement("isbn:number", "urn:ISBN:0-395-36341-6", "1568491379"); xmlw.Close(); ``` In this example, the *title* element uses the default namespace *urn:loc.gov:books* and the *number* element uses the *urn:ISBN:0-395-36341-6* namespace as defined for the *isbn* prefix. # [XML](#xml-class).tryXPath Method This method navigates to the specified XPath if it exists. ## Syntax ```text async xml.tryXPath(xpath : string): Promise< boolean> ``` ## Remarks This method will attempt to navigate to the specified *XPath* parameter if it exists within the document. If the XPath exists, the [XPath](#xmlxpath-property) property will be updated and this method returns *true*. If the XPath does not exist, the [XPath](#xmlxpath-property) property is not updated and this method returns *false*. # [XML](#xml-class).Characters Event This event is fired for plaintext segments of the input stream. ## Syntax ```text xml.on('Characters', listener: (e: {readonly text: string}) => void ) ``` ## Remarks The Characters event provides the plaintext content of the XML document (i.e., the text inside the tags). The text is provided through the *Text* parameter. The text includes whitespace as well as end-of-line characters, except for ignorable whitespace, which is fired through the [IgnorableWhitespace](#xmlignorablewhitespace-event) event. # [XML](#xml-class).Comment Event This event is fired when a comment section is encountered. ## Syntax ```text xml.on('Comment', listener: (e: {readonly text: string}) => void ) ``` ## Remarks The Comment event is fired whenever a comment section (**) is found in the document. The full text of the comment is provided by the *Text* parameter. # [XML](#xml-class).EndElement Event This event is fired when an end-element tag is encountered. ## Syntax ```text xml.on('EndElement', listener: (e: {readonly nameSpace: string, readonly element: string, readonly QName: string, readonly isEmpty: boolean}) => void ) ``` ## Remarks The EndElement event is fired when an end-element tag is found in the document. The element name is provided by the *Element* parameter. The *IsEmpty* parameter is *true* when the event corresponds to an empty element declaration. # [XML](#xml-class).EndPrefixMapping Event This event is fired when leaving the scope of a namespace declaration. ## Syntax ```text xml.on('EndPrefixMapping', listener: (e: {readonly prefix: string}) => void ) ``` ## Remarks The [StartPrefixMapping](#xmlstartprefixmapping-event) event is fired when entering the scope of a namespace declaration. # [XML](#xml-class).Error Event Fired when information is available about errors during data delivery. ## Syntax ```text xml.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void ) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class . The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-class-ipworksxml) section. # [XML](#xml-class).EvalEntity Event This event is fired every time an entity needs to be evaluated. ## Syntax ```text xml.on('EvalEntity', listener: (e: {readonly entity: string, value: string}) => void ) ``` ## Remarks The *Value* parameter contains a suggested value for the entity (normally the entity name itself). You may set *Value* to a value of your choice, which will later be passed into the text stream. # [XML](#xml-class).IgnorableWhitespace Event This event is fired when a section of ignorable whitespace is encountered. ## Syntax ```text xml.on('IgnorableWhitespace', listener: (e: {readonly text: string}) => void ) ``` ## Remarks The ignorable whitespace section is provided by the *Text* parameter. # [XML](#xml-class).Meta Event This event fires when a meta section is encountered. ## Syntax ```text xml.on('Meta', listener: (e: {readonly text: string}) => void ) ``` ## Remarks The Meta event is fired whenever a meta information section (**) is found in the document. The full text of the meta section is provided by the *Text* parameter. # [XML](#xml-class).PI Event This event is fired when a processing instruction section is encountered. ## Syntax ```text xml.on('PI', listener: (e: {readonly text: string}) => void ) ``` ## Remarks The PI event is fired whenever a processing instruction section (**) is found in the document. The full text of the processing instruction is provided by the *Text* parameter. # [XML](#xml-class).SpecialSection Event This event is fired when a special section is encountered. ## Syntax ```text xml.on('SpecialSection', listener: (e: {readonly sectionId: string, readonly text: string}) => void ) ``` ## Remarks The SpecialSection event is fired whenever a special section (such as **) is found in the document. The full text of the special section is provided by the *Text* parameter, and the *SectionId* parameter provides the section identifier (e.g., *CDATA*). # [XML](#xml-class).StartElement Event This event is fired when a begin-element tag is encountered in the document. ## Syntax ```text xml.on('StartElement', listener: (e: {readonly nameSpace: string, readonly element: string, readonly QName: string, readonly isEmpty: boolean}) => void ) ``` ## Remarks The StartElement event is fired when a begin-element tag is found in the document. The element name is provided through the *Element* parameter. The attribute names and values (if any) are provided through the XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue collection. The *IsEmpty* parameter is *true* when the event corresponds to an empty element declaration. # [XML](#xml-class).StartPrefixMapping Event This event is fired when entering the scope of a namespace declaration. ## Syntax ```text xml.on('StartPrefixMapping', listener: (e: {readonly prefix: string, readonly URI: string}) => void ) ``` ## Remarks The [EndPrefixMapping](#xmlendprefixmapping-event) event is fired when leaving the scope of a namespace declaration. # [XML](#xml-class).XML Event This event is fired as XML is written. ## Syntax ```text xml.on('XML', listener: (e: {readonly text: string}) => void ) ``` ## Remarks This event is fired when XML is output. The *Text* parameter holds the data being written. **This functionality is not yet implemented.** # XMLAttribute Type This type describes an XML attribute from the current XML element. ## Remarks This type describes an XML attribute from the current element. It includes fields to denote information about the attribute being defined. The following fields are available: - [Name](#XMLAttribute_f_Name) - [Namespace](#XMLAttribute_f_Namespace) - [Prefix](#XMLAttribute_f_Prefix) - [Value](#XMLAttribute_f_Value) ## Fields **Name** *string (read-only)* *Default Value: ""* The provides the local name (without prefix) of the attribute. **Namespace** *string (read-only)* *Default Value: ""* This property contains the attribute namespace. **Prefix** *string (read-only)* *Default Value: ""* This property contains the attribute prefix (if any). If the attribute does not have a prefix, this property is empty. **Value** *string (read-only)* *Default Value: ""* This property contains the attribute value. ## Constructors ```text public XMLAttribute(); ``` # XMLComment Type This type holds a comment within the document. ## Remarks This type holds a comment within the XML document. The following fields are available: - [Text](#XMLComment_f_Text) ## Fields **Text** *string* *Default Value: ""* This property holds the comment text. ## Constructors ```text public XMLComment(); ``` ```text public XMLComment(String text); ``` # XMLDeclaration Type This type includes the XML declaration present at the beginning of a document. ## Remarks This type contains details about the XML declaration, which may be set before writing a document. This is applicable only when writing documents. The following fields are available: - [Encoding](#XMLDeclaration_f_Encoding) - [Standalone](#XMLDeclaration_f_Standalone) - [Version](#XMLDeclaration_f_Version) ## Fields **Encoding** *string* *Default Value: "utf-8"* This property specifies the XML encoding to use. This may be set before writing a document. The default value is *UTF-8*. This is applicable only when writing XML. **Standalone** *boolean* *Default Value: True* This property indicates whether the standalone attribute is present in the declaration with a value of *true*. This may be set before writing a document. The default value is *true*. This is applicable only when writing XML. **Version** *string* *Default Value: "1.0"* This property specifies the XML version. This may be set before writing a document. The default value is *1.0*. This is applicable only when writing XML. ## Constructors ```text public XMLDeclaration(); ``` ```text public XMLDeclaration(String version, String encoding, boolean standalone); ``` # XMLElement Type This type describes an element contained within the XML document. ## Remarks This type describes an XML element. The fields for this type describe the element , , and of the given element. The elements are inserted into the array in the same order they are found in the document. The following fields are available: - [Name](#XMLElement_f_Name) - [Namespace](#XMLElement_f_Namespace) - [Prefix](#XMLElement_f_Prefix) - [XText](#XMLElement_f_XText) ## Fields **Name** *string (read-only)* *Default Value: ""* The property provides the local name (without a prefix) of the element. **Namespace** *string (read-only)* *Default Value: ""* This property contains the namespace of the element. **Prefix** *string (read-only)* *Default Value: ""* This property contains the prefix of the element (if any). If the element does not have a prefix, this property is empty. **XText** *string (read-only)* *Default Value: ""* This property contains the inner text of the element. ## Constructors ```text public XMLElement(); ``` # XMLNamespace Type This type describes an XML namespace from the current namespace stack. ## Remarks This type describes an XML namespace from the current stack. It includes fields to denote the and the of the namespace being defined. The default namespace exists at index *0*. The field at index *0* is *xmlns*, and the field contains the default namespace. The following fields are available: - [Prefix](#XMLNamespace_f_Prefix) - [URI](#XMLNamespace_f_URI) ## Fields **Prefix** *string* *Default Value: ""* This property contains the for the namespace. **URI** *string* *Default Value: ""* This property contains the namespace URI associated with the corresponding . This URL is usually pointing to the XML schema for the namespace. ## Constructors ```text public XMLNamespace(); ``` ```text public XMLNamespace(String URI, String prefix); ``` # ReadableStream Type ## Syntax ```text interface ReadableStream { read(buffer: Uint8Array, offset: number, length: number): Promise; readSync(buffer: Uint8Array, offset: number, length: number): number; available(): number; close(): void; mark():void; reset():void; markSupported():boolean; } ``` ## Remarks The XML class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the ReadableStream interface, and pass an instance of this object to the XML class. When implementing the ReadableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur. ```text read(buffer: Uint8Array, offset: number, length: number): Promise { } ``` ```text readSync(buffer: Uint8Array, offset: number, length: number): number { } ``` ```text available(): number { } ``` ```text close(): void { } ``` ```text mark(): void { } ``` ```text reset(): void { } ``` ```text markSupported(): boolean { } ``` | | | | --- | --- | | Methods | | | The following parameters are supported | buffer: The buffer to store the read data.
offset: The starting position within the buffer to write data.
length: The maximum number of bytes to read.
| | read | Reads data from the stream into the provided buffer. This method must be implemented.
Returns a promise resolving to the number of bytes read, -1 if no data is available. | | readSync | Synchronously reads data from the stream into the buffer. Returns the number of bytes read, -1 if no data is available. | | available | Returns the number of bytes available for reading. This method must be implemented.
| | close | Closes the stream and releases associated resources. | | mark | Marks the current position in this stream. | | reset | Repositions this stream to the position at the time the mark method was last called. | | markSupported | Tests if this stream supports the mark and reset methods. Returns true if this stream supports the mark and reset methods; false otherwise. | # WriteableStream Type ## Syntax ```text interface WriteableStream { write(data: Uint8Array, offset: number, length: number): Promise; writeSync(data: Uint8Array, offset: number, length: number): void; close(): void; } ``` ## Remarks The XML class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the WriteableStream interface, and pass an instance of this object to the XML class. When implementing the WriteableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur. ```text write(data: Uint8Array, offset: number, length: number): Promise { } ``` ```text writeSync(data: Uint8Array, offset: number, length: number): void { } ``` ```text close(): void { } ``` | | | | --- | --- | | Methods | | | The following parameters are supported | data: The buffer containing the data to write.
offset: The starting position in the buffer to read data from.
length: The maximum number of bytes to write.
| | write | Asynchronously writes data from the provided buffer to the stream. This method must be implemented.
Returns a promise that resolves when the write operation completes. | | writeSync | Synchronously writes data from the buffer to the stream. | | close | Closes the stream and releases associated resources. | # Config Settings (*class *ipworks.[xml](#xml-class)) The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#xmlconfig-method) method. ### XML Config Settings **CacheContent**: If true, the original XML is saved in a buffer.This configuration setting controls whether or not the class retains the entire original XML in a buffer. This is used to retain the original XML as opposed to returning generated XML after parsing. The default value is *true*. **Charset**: Specifies the charset used when encoding data.This configuration setting specifies the character set used when encoding data. This value will also be used when creating the [XMLDeclaration](#xmlxmldeclaration-property). The default value is *utf-8*. **EOL**: The characters to use for separating lines.If specified, the class will format the output XML using the specified characters to separate multiple lines for nested XML elements. The default value is . This option should be combined with [Indent](#Indent) for full effect. **ErrorOnEmptyAttr**: If true, passing an invalid attribute to the GetAttr method will throw an exception.If an invalid attribute name is passed to the [GetAttr](#xmlgetattr-method) method, the method will return an empty string if this is set to *false*; otherwise, an exception is thrown. **ExtraNameChars**: Extra characters for the parser to consider as name characters.Normally, the parser considers only the following characters as part of an XML identifier: *A* through *Z*, *a* through *z*, *0* through *9*, and *.*, *-*, *_*, and *:*. If you would like any other characters to be considered as name characters, you may set them as a string into this property. **ExtraSpaceChars**: Extra characters for the parser to consider as whitespace.Normally, the parser considers only the following characters as whitespace: * * (space), *\t* (tab), *\n* (newline), *\r* (carriage return), *\f* (form feed), and *\v* (vertical tab). If you would like any other characters to be considered as whitespace, you may set them as a string into this property. **FlushOnEOL**: If set, the parser flushes its text buffer after every line of text.The [FlushOnEOL](#FlushOnEOL) property controls whether or not [Characters](#xmlcharacters-event) events are fired for every line of the input text stream. Normally, lines are buffered internally and delivered in batches, but if the [FlushOnEOL](#FlushOnEOL) flag is set, then a [Characters](#xmlcharacters-event) event is fired for each line. **IgnoreBadAttributePrefixes**: If true, bad (unknown) attribute prefixes are ignored.Normally a trappable error is generated when an unknown attribute prefix is encountered. This configuration setting suppresses the error. The default value is *true*. **IgnoreBadElementPrefixes**: If true, bad (unknown) element prefixes are ignored.Normally a trappable error is generated when an unknown element prefix is encountered. This configuration setting suppresses the error. The default value is *true*. **IncludeElementPrefix**: Whether to include the prefix in the element name.This configuration setting specifies whether or not to include the element prefix in the *Element* parameter of the [StartElement](#xmlstartelement-event) and [EndElement](#xmlendelement-event) events. If *false* (default) and [Validate](#xmlvalidate-property) is set to *false*, the prefix is included in the *Element* parameter (e.g., *ds:DigestMethod*). If *true* and [Validate](#xmlvalidate-property) is set to *false*, the prefix is not included in the *Element* parameter (e.g., *DigestMethod*). This setting is applicable only when [Validate](#xmlvalidate-property) is *false*. **IncludeXMLDeclaration**: Whether to include the XML declaration when writing XML.This configuration setting specifies whether the XML declaration is included in the output XML when writing XML. When set to *true* (default), the XML declaration will be included above any user-specified XML. For instance: ```text ... ``` **Indent**: The characters to use for each indentation level.If specified, the class will format the output XML using the specified characters to denote each indentation level for nested XML elements. This option should be combined with [EOL](#EOL) for full effect. **Interrupt**: Whether to stop parsing the current XML document.This configuration setting can be called from within any event to stop further parsing of the document. The configuration setting only works from within events. For example: ```text void xml_OnStartElement(object sender, XMLStartElementEventArgs e) { xml.Config("Interrupt"); } ``` **Offset**: Current offset of the document being parsed.This property is useful for determining the location of possible XML errors in the document. [Offset](#Offset) values start at *1*. **PreserveAll**: Whether to preserve processing instructions and comments.When set to *true*, the parser will preserve all processing instructions and comments of the input. The default value is *false*. This configuration setting can be used together with [ProcessNamespace](#ProcessNamespace) when filling XML templates. **PreserveWhitespace**: If true, leading and trailing whitespace in element text is preserved.Normally, the leading and trailing whitespace from an element's text is trimmed. When this property is set to *true*, this leading and trailing whitespace is preserved. The default value is *false*. **ProcessNamespace**: Whether the parser will process namespaces.When set to *false*, namespaces will not be parsed or processed. This allows the original namespace information to be preserved as it appeared in the input. The default value is *true*. This configuration setting can be used together with [PreserveAll](#PreserveAll) when filling XML templates. **QuoteChar**: Quote character to use for attribute values.By default, the class will use double quotes around attribute values. This property can be used to specify a different character, such as a single quote. **StringProcessingOptions**: Defines options to use when processing string values.This configuration setting determines what additional processing is performed on string values fired through the [Characters](#xmlcharacters-event) event. NOTE: This applies only when [BuildDOM](#xmlbuilddom-property) is *false*. By default, no additional processing is performed and the string is returned as is from the document. Strings may also be XML unescaped. Possible values are as follows: | | | | --- | --- | | 0 (none - default) | No additional processing is performed. | | 1 | Strings are XML unescaped. | For instance, when set to *0*, the following text may be fired through the [Characters](#xmlcharacters-event) event: *&"<>* When set to *1*, the following text would be fired through the [Characters](#xmlcharacters-event) event: *&"<>* ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. # Trappable Errors (*class *ipworks.[xml](#xml-class)) ### XML Errors | | | | --- | --- | | 101 | Invalid attribute index. | | 102 | No attributes available. | | 103 | Invalid namespace index. | | 104 | No namespaces available. | | 105 | Invalid element index. | | 106 | No elements available. | | 107 | Attribute does not exist. | | 201 | Unbalanced element tag. | | 202 | Unknown element prefix (cannot find namespace). | | 203 | Unknown attribute prefix (cannot find namespace). | | 204 | Invalid XML markup. | | 205 | Invalid end state for parser. | | 206 | Document contains unbalanced elements. | | 207 | Invalid [XPath](#xmlxpath-property). | | 208 | No such child. | | 209 | Top element does not match start of path. | | 210 | DOM tree unavailable (set [BuildDOM](#xmlbuilddom-property) to true and reparse). | | 302 | Cannot open file. | | 401 | Invalid XML would be generated. | | 402 | An invalid XML name has been specified. |