AllowXmlElement (XmlDoc property)

From m204wiki
Jump to navigation Jump to search

May Element names begin with "xml"? (XmlDoc class)

The AllowXmlElement property indicates whether or not the method object XmlDoc allows the deserialization of an XML document that contains Element nodes that begin with the character sequence xml (regardless of case).

A Boolean value of True allows such deserializations. The default value, False, cancels the request if such a deserialization is attempted.


%currentBoolean = doc:AllowXmlElement doc:AllowXmlElement = newBoolean

Syntax terms

%currentBoolean The Boolean enumeration value of doc's AllowXmlElement property.
doc An XmlDoc object expression.
newBoolean The Boolean value to assign to doc's AllowXmlElement property.

Usage notes

  • Deserializing Elements whose name begins with "xml" was restricted due to the following excerpt from the XML standard:
    • Names beginning with the string "xml", or any string which would match (('X'|'x') ('M'|'m') ('L'|'l')), are reserved for standardization in this or future versions of this specification.

    Therefore, you should use care with element names: using an element name such as XML makes you vulnerable to a change in the standards that would leave your document incompatible with them.

    Note: This property does not allow the AddElement method to add an element with a name that starts with "xml". However, as shown in the Adding an element to a document example below, it is easy to use the LoadXml method to accomplish this.


Displaying the property

The following example obtains the string value of the AllowXmlElement property:

%str = %doc:AllowXmlElement:ToString

Taking advantage of the implicit-ToString feature, you can print this value directly by using this:

print %doc:AllowXmlElement

Deserializing an entire XML document

The following request:

begin %d object xmlDoc auto new %d:AllowXmlElement = true %d:loadXml('<t>Test<xmlnode></xmlnode></t>') printText{~} is {%d:allowXmlElement} end


%d:allowXmlElement is True

Adding an element to a document

The following request:

begin %d object xmlDoc auto new %n object xmlNode %n = %d:addElement('xyz') %d:allowXmlElement = true %n:LoadXml('<xmlElt/>') %d:print end


<xyz> <xmlElt/> </xyz>

Request-cancellation errors (for set method)

This list is not exhaustive: it does not include all the errors that are request cancelling.

  • The newBoolean argument is an invalid value (that is, not a Boolean value).

See also