AllowXmlAttribute (XmlDoc property)

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 Attributes 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.

Syntax

%currentBoolean = doc:AllowXmlAttribute doc:AllowXmlAttribute = newBoolean

Syntax terms

%currentBoolean	The Boolean enumeration value of doc's AllowXmlAttribute property. For more information about these enumerations, see Using Boolean enumerations.
doc	An XmlDoc object expression.

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 ch ange 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, it is easy to use the LoadXml method to accomplish this.

  Examples

  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

  Note: Using the PrintText statement is described in printText. Printing an enumeration value without a ToString method is described in the first "Note" in ?? refid=crenums..

  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

  prints

  <xyz xmlAtt="abc"/>

  Request-Cancellation Errors (for set method)

  • newBoolean is an invalid value (ie: not a Boolean value).

  See also

  XmlDoc class XmlNode class XmlNodelist class	List of XmlDoc methods List of XmlNode methods List of XmlNodelist methods List of XmlDoc API methods	XmlDoc methods syntax XmlNode methods syntax XmlNodelist methods syntax
  Notation conventions for methods