Online Documentation - Statistics - FAQ - Plugin Parts (All, Dependencies) - Class hierarchy
New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1
The list of the topics, classes, interfaces, controls, modules, global methods by category, global methods by name, screenshots, licenses and examples.
Platforms to show: All Mac Windows Linux Cross-Platform
Back to XMLDOMParserMBS class.
XMLDOMParserMBS.CreateEntityReferenceNodes as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This method allows the user to specify whether the parser should create entity reference nodes in the DOM tree being produced. When the 'create' flag is true, the parser will create EntityReference nodes in the DOM tree.
The EntityReference nodes and their child nodes will be read-only.
When the 'create' flag is false, no EntityReference nodes will be created.
The replacement text of the entity is included in either case, either as a child of the Entity Reference node or in place at the location of the reference.
The default value is 'true'.
(Read and Write property)
XMLDOMParserMBS.DoNamespaces as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This method allows users to enable or disable the parser's namespace processing. When set to true, parser starts enforcing all the constraints and rules specified by the NameSpace specification.
The parser's default state is: false.
(Read and Write property)
XMLDOMParserMBS.DoSchema as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This method allows users to enable or disable the parser's schema processing. When set to false, parser will not process any schema found.
The parser's default state is: false.
Note: If set to true, namespace processing must also be turned on.
(Read and Write property)
XMLDOMParserMBS.ExitOnFirstFatalError as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This method allows users to set the parser's behaviour when it encounters the first fatal error. If set to true, the parser will exit at the first fatal error. If false, then it will report the error and continue processing.
The default value is 'true' and the parser exits on the first fatal error.
(Read and Write property)
XMLDOMParserMBS.ExternalSchemaLocation as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If the targetNamespace of a schema specified using this method matches the targetNamespace of a schema occurring in the instance document in the schemaLocation attribute, or if the targetNamespace matches the namespace attribute of the "import" element, the schema specified by the user using this method will be used (i.e., the schemaLocation attribute in the instance document or on the "import" element will be effectively ignored).
The syntax is the same as for schemaLocation attributes in instance documents: e.g, "http://www.example.com file_name.xsd". The user can specify more than one XML Schema in the list.
(Read and Write property)
XMLDOMParserMBS.GenerateSyntheticAnnotations as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
A synthetic XSAnnotation is created when a schema component has non-schema attributes but has no child annotations so that the non-schema attributes can be recovered under PSVI.
(Read and Write property)
XMLDOMParserMBS.Handle as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
XMLDOMParserMBS.IdentityConstraintChecking as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
By default, the parser does identity constraint checks.
The default value is true.</p>
(Read and Write property)
XMLDOMParserMBS.IncludeIgnorableWhitespace as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This method allows the user to specify whether a validating parser should include ignorable whitespaces as text nodes. It has no effect on non-validating parsers which always include non-markup text.
When set to true (also the default), ignorable whitespaces will be added to the DOM tree as text nodes. The method DOMText.isIgnorableWhitespace() will return true for those text
nodes only.
When set to false, all ignorable whitespace will be discarded and no text node is added to the DOM tree. Note: applications intended to process the "xml:space" attribute should not set this flag to false.
And this flag also overrides any schema datateye whitespace facets, that is, all ignorable whitespace will be discarded even though 'preserve' is set in schema datatype whitespace facets.
(Read and Write property)
XMLDOMParserMBS.Threaded as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If true, the parsing is performed on a preemptive thread, so this function does not block the application and can yield time to other Xojo threads. Must be called in a Xojo thread to enjoy benefits. If called in main thread will block, but keep other background threads running.
(Read only property)
XMLDOMParserMBS.ValidateAnnotations as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The value for specifying whether Annotations should be validated or not.
(Read and Write property)
XMLDOMParserMBS.ValidationConstraintFatal as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If set to true, and the the parser will treat validation error as fatal and will exit depends on the state of "getExitOnFirstFatalError". If false, then it will report the error and continue processing.
Note: setting this true does not mean the validation error will be printed with the word "Fatal Error". It is still printed as "Error", but the parser will exit if "setExitOnFirstFatalError" is set to true.
The default value is 'false'.
(Read and Write property)
XMLDOMParserMBS.ValidationSchemaFullChecking as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Only takes effect if Schema validation is enabled.
If turned off, partial constraint checking is done.
Full schema constraint checking includes those checking that may be time-consuming or memory intensive. Currently, particle unique attribution constraint checking and particle derivation restriction checking are controlled by this option.
The parser's default state is: false.
(Read and Write property)
XMLDOMParserMBS.ValidationScheme as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | XML | MBS XML Plugin | 23.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The value is one of the ValSchemes enumerated values defined by this class:
ValidateNever | turn off validation |
ValidateAlways | turn on validation |
ValidateAuto | turn on validation if any internal/external DTD subset have been seen |
The items on this page are in the following plugins: MBS XML Plugin.