AllowXmlAttribute (XmlDoc property)

From m204wiki
Revision as of 19:43, 12 March 2014 by JAL (talk | contribs) (→‎Examples)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

[Introduced in Sirius Mods 7.9]

The AllowXmlAttribute property indicates whether or not the method object XmlDoc allows the deserialization of an XML document that contains Attribute nodes that begin with the character sequence xml (regardless of case), other than the standard prefixes of xml: or xmlns:.

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


%currentBoolean = doc:AllowXmlAttribute doc:AllowXmlAttribute = newBoolean

Syntax terms

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

Usage notes

  • Deserializing Attributes 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 attribute names: using an attribute name which starts with "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 AddAttribute method to add an attribute with a name that starts with "xml". However, as shown in the "Adding an attribute to an element" example below, you can use the LoadXml, AddSubtree, and DeleteSubtree methods to accomplish this.


Displaying the property

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

%str = %doc:allowXmlAttribute:ToString

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

print %doc:allowXmlAttribute

Deserializing an entire XML document

The following request:

begin %d object xmlDoc auto new %d:allowXmlAttribute = true %d:loadXml('<t xmlAtt="x">Test</t>') printText {~} is {%d:allowXmlAttribute} end


%d:allowXmlAttribute is True

Adding an attribute to an element

The following request:

begin %d object xmlDoc auto new %n1 object xmlNode %n2 object xmlNode %n1 = %d:addElement('xyz') %d:allowXmlAttribute = true %n1:LoadXml('<junk xmlAtt="abc"/>') %n2 = %n1:SelectSingleNode('*/@*') %n1:AddSubtree(%n2) %n1:DeleteSubtree('*') %d:print end


<xyz xmlAtt="abc"/>

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