XML Configuration
The component 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 component, access to these internal properties is provided through the Config method.
XML Configuration Settings
| CacheContent:
If true, the original XML is saved in a buffer. This config controls whether or not the component 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 setting specifies the character set used when encoding data. This value will also be used when creating the XMLDeclaration. The default value is "utf-8". | |||||
| EOL:
The characters to use for separating lines. If specified, the component will format the output XML, using the specified characters to separate multiple lines for nested XML elements. The default value is CRLF ('#13#10') . This option should be combined with Indent for full effect. | |||||
| ErrorOnEmptyAttr:
If true, passing an invalid attribute to the Attr method will throw an exception. If an invalid attribute name is passed into the GetAttr method, the method will return with 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 '.', '-', '_', ':'. 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 white space. Normally, the parser considers only the following characters as white space: ' ' (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 white space, 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 property controls whether Characters events are fired for every line of the input text stream or not. Normally lines are buffered internally and delivered in batches, but if the FlushOnEOL flag is set, then a Characters 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 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 setting suppresses the error. The default value is True. | |||||
| IncludeElementPrefix:
Whether to include the prefix in the element name. This setting specifies whether to include the element prefix in the Element parameter of the StartElement and EndElement events. If False (default) and Validate is set to False the prefix is included in the Element parameter. For instance: ds:DigestMethod If True and Validate is set to False the prefix is not included in the Element parameter. For instance: DigestMethod This setting is only applicable when Validate is False. | |||||
| IncludeXMLDeclaration:
Whether to include the XML declaration when writing XML. This 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:
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>... | |||||
| Indent:
The characters to use for each indentation level. If specified, the component 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 for full effect. | |||||
| Offset:
Current offset of the document being parsed. This property is useful for determining the location of possible XML errors in the document. Offset values start at 1. | |||||
| 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. | |||||
| QuoteChar:
Quote character to use for attribute values. By default, the component 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 setting determines what additional processing is performed on string values fired through the Characters event.. Note: This only applies when BuildDOM 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:
For instance, when set to 0 the following text may be fired through the Characters event: &"<> When set to 1 the following text would be fired through the Characters event: &'<> |
Base Configuration 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:
The following is a list of valid code page identifiers for Mac OS only:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LicenseInfo:
Information about the current license. When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the component whether or not to use the system security libraries or an internal implementation. By default the component will use the system security libraries to perform cryptographic functions. Setting this to True tells the component to use the internal implementation instead of using the system's security API. |