AllowXmlElement (XmlDoc property) - Revision history

JAL at 17:20, 3 March 2014

2014-03-03T17:20:14Z

← Older revision		Revision as of 17:20, 3 March 2014
Line 1:		Line 1:
	{{Template:XmlDoc:AllowXmlElement subtitle}}		{{Template:XmlDoc:AllowXmlElement subtitle}}
	The <var>AllowXmlElement </var> property indicates whether or not the method object <var>XmlDoc</var> allows the deserialization of an XML document that contains ~~Elements~~ that begin with the character sequence <code>xml</code> (regardless of case).		The <var>AllowXmlElement </var> property indicates whether or not the method object <var>XmlDoc</var> allows the deserialization of an XML document that contains [[XmlDoc API#XmlDoc node types\|Element nodes]] that begin with the character sequence <code>xml</code> (regardless of case).

	A <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value of <var>True</var> allows such deserializations. The default value, <var>False</var>, cancels the request if such a deserialization is attempted.		A <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value of <var>True</var> allows such deserializations. The default value, <var>False</var>, cancels the request if such a deserialization is attempted.
Line 6:		Line 6:
	==Syntax==		==Syntax==
	{{Template:XmlDoc:AllowXmlElement syntax}}		{{Template:XmlDoc:AllowXmlElement syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%currentBoolean</th>		<tr><th>%currentBoolean</th>
	<td>The <var>Boolean</var> enumeration value of <var class="term">doc</var>'s <var>AllowXmlElement</var> property. </td></tr>		<td>The <var>Boolean</var> enumeration value of <var class="term">doc</var>'s <var>AllowXmlElement</var> property. </td></tr>

	<tr><th>doc</th>		<tr><th>doc</th>
	<td>An <var>XmlDoc</var> object expression.</td></tr>		<td>An <var>XmlDoc</var> object expression.</td></tr>

	<tr><th>newBoolean</th>		<tr><th>newBoolean</th>
	<td>The <var>Boolean</var> value to assign to <var class="term">doc</var>'s <var>AllowXmlElement</var> property.</td></tr>		<td>The <var>Boolean</var> value to assign to <var class="term">doc</var>'s <var>AllowXmlElement</var> property.</td></tr>
Line 24:		Line 27:
	Therefore, you should use care with element names: using an element name such as <code>XML</code> makes you vulnerable to a change in the standards that would leave your document incompatible with them.		Therefore, you should use care with element names: using an element name such as <code>XML</code> makes you vulnerable to a change in the standards that would leave your document incompatible with them.

	'''Note:''' This property does not allow the <var>[[AddElement_(XmlDoc/XmlNode_function)\|AddElement]]</var> method to add an element with a name that starts with "xml". However, as shown in the [[#Adding an element to a document\|"Adding an element to a document"]] example below, it is easy to use the <var>[[LoadXml_(XmlDoc/XmlNode_function)\|LoadXml]]</var> method to accomplish this.		<p class="note">'''Note:''' This property does not allow the <var>[[AddElement_(XmlDoc/XmlNode_function)\|AddElement]]</var> method to add an element with a name that starts with "xml". However, as shown in the [[#Adding an element to a document\|Adding an element to a document]] example below, it is easy to use the <var>[[LoadXml_(XmlDoc/XmlNode_function)\|LoadXml]]</var> method to accomplish this. </p>
	~~<li>The <var>AllowXmlElement~~</~~var~~> ~~method was introduced in <var class="product">[[Sirius Mods]]</var> Version 7.3, and it has also been provided by maintenance for Version 6.8 and Version 7.2.~~
	</ul>		</ul>

Line 36:		Line 38:
	<p class="code">print %doc:AllowXmlElement		<p class="code">print %doc:AllowXmlElement
	</p>		</p>

	===Deserializing an entire XML document===		===Deserializing an entire XML document===
	The following request:		The following request:
Line 67:		Line 70:

	==Request-cancellation errors (for set method)==		==Request-cancellation errors (for set method)==
			This list is not exhaustive: it does <i>not</i> include all the errors that are request cancelling.
	<ul>		<ul>
	<li>The <var class="term">newBoolean</var> argument is an invalid value (that is, not a <var>Boolean</var> value).		<li>The <var class="term">newBoolean</var> argument is an invalid value (that is, not a <var>Boolean</var> value).

JAL2 at 20:59, 31 May 2011

2011-05-31T20:59:31Z

← Older revision		Revision as of 20:59, 31 May 2011
Line 2:		Line 2:
	The <var>AllowXmlElement </var> property indicates whether or not the method object <var>XmlDoc</var> allows the deserialization of an XML document that contains Elements that begin with the character sequence <code>xml</code> (regardless of case).		The <var>AllowXmlElement </var> property indicates whether or not the method object <var>XmlDoc</var> allows the deserialization of an XML document that contains Elements that begin with the character sequence <code>xml</code> (regardless of case).

	A <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value of <var>True</var> allows such deserializations. The default value, <~~code~~>False</~~code~~>, cancels the request if such a deserialization is attempted.		A <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value of <var>True</var> allows such deserializations. The default value, <var>False</var>, cancels the request if such a deserialization is attempted.

	==Syntax==		==Syntax==
Line 9:		Line 9:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%currentBoolean</th>		<tr><th>%currentBoolean</th>
	<td>The <var>Boolean</var> enumeration value of <var class="term">doc</var>'s <var>AllowXmlElement</var> property~~. For more information about these enumerations, see [[Enumerations#Using_Boolean_enumerations\|"Using Boolean enumerations"]]~~.</td></tr>		<td>The <var>Boolean</var> enumeration value of <var class="term">doc</var>'s <var>AllowXmlElement</var> property. </td></tr>
	<tr><th>doc</th>		<tr><th>doc</th>
	<td>An <var>XmlDoc</var> object expression.</td></tr>		<td>An <var>XmlDoc</var> object expression.</td></tr>
Line 33:		Line 33:
	<p class="code">%str = %doc:AllowXmlElement:ToString		<p class="code">%str = %doc:AllowXmlElement:ToString
	</p>		</p>
	Taking advantage of the implicit-[[ToString]] feature, you can print this value directly by using this:		Taking advantage of the [[Enumerations#Usage Notes\|implicit-ToString]] feature, you can print this value directly by using this:
	<p class="code">print %doc:AllowXmlElement		<p class="code">print %doc:AllowXmlElement
	</p>		</p>
Line 48:		Line 48:
	<p class="output">%d:allowXmlElement is True		<p class="output">%d:allowXmlElement is True
	</p>		</p>
	~~'''Note:''' Using the PrintText statement is described in <var>[[PrintText statement\|printText]]</var>.~~
	~~Printing an enumeration value without a <var>ToString</var> method is described in the first "Note" in [[??]] refid=crenums..~~
	===Adding an element to a document===		===Adding an element to a document===
	The following request:		The following request:
Line 67:		Line 66:
	</nowiki></p>		</nowiki></p>

	==Request-~~Cancellation Errors~~ (for set method)==		==Request-cancellation errors (for set method)==
	<ul>		<ul>
	<li><var class="term">newBoolean</var> is an invalid value (that is, not a ~~[[Enumerations#Using~~ Boolean ~~enumerations\|Boolean]]~~ value).		<li>The <var class="term">newBoolean</var> argument is an invalid value (that is, not a <var>Boolean</var> value).
	</ul>		</ul>

	==See also==		==See also==
	{{Template:XmlDoc:AllowXmlElement footer}}		{{Template:XmlDoc:AllowXmlElement footer}}

JALWiccan: 1 revision

2011-05-24T23:20:38Z

1 revision

← Older revision	Revision as of 23:20, 24 May 2011
(No difference)

JALWiccan: 1 revision

2011-05-24T23:20:37Z

1 revision

← Older revision		Revision as of 23:20, 24 May 2011
Line 69:		Line 69:
	==Request-Cancellation Errors (for set method)==		==Request-Cancellation Errors (for set method)==
	<ul>		<ul>
	<li><var class="term">newBoolean</var> is an invalid value (~~ie:~~ not a [[Enumerations#Using Boolean enumerations\|Boolean]] value).		<li><var class="term">newBoolean</var> is an invalid value (that is, not a [[Enumerations#Using Boolean enumerations\|Boolean]] value).
	</ul>		</ul>

	==See also==		==See also==
	{{Template:XmlDoc:AllowXmlElement footer}}		{{Template:XmlDoc:AllowXmlElement footer}}

JALWiccan: 1 revision

2011-05-24T20:31:56Z

1 revision

← Older revision	Revision as of 20:31, 24 May 2011
(No difference)

JALWiccan: 1 revision

2011-05-24T20:31:54Z

1 revision

← Older revision		Revision as of 20:31, 24 May 2011
Line 2:		Line 2:
	The <var>AllowXmlElement </var> property indicates whether or not the method object <var>XmlDoc</var> allows the deserialization of an XML document that contains Elements that begin with the character sequence <code>xml</code> (regardless of case).		The <var>AllowXmlElement </var> property indicates whether or not the method object <var>XmlDoc</var> allows the deserialization of an XML document that contains Elements that begin with the character sequence <code>xml</code> (regardless of case).

	A <var>[[Boolean]]</var> value of <var>True</var> allows such deserializations. The default value, <code>False</code>, cancels the request if such a deserialization is attempted.		A <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value of <var>True</var> allows such deserializations. The default value, <code>False</code>, cancels the request if such a deserialization is attempted.

	==Syntax==		==Syntax==
Line 69:		Line 69:
	==Request-Cancellation Errors (for set method)==		==Request-Cancellation Errors (for set method)==
	<ul>		<ul>
	<li><var class="term">newBoolean</var> is an invalid value (ie: not a [[Boolean]] value).		<li><var class="term">newBoolean</var> is an invalid value (ie: not a [[Enumerations#Using Boolean enumerations\|Boolean]] value).
	</ul>		</ul>

	==See also==		==See also==
	{{Template:XmlDoc:AllowXmlElement footer}}		{{Template:XmlDoc:AllowXmlElement footer}}

JALWiccan: 1 revision

2011-05-24T17:27:02Z

1 revision

← Older revision	Revision as of 17:27, 24 May 2011
(No difference)

Goff: fix "using boolean enumerations" link

2011-05-24T17:27:01Z

fix "using boolean enumerations" link

← Older revision		Revision as of 17:27, 24 May 2011
Line 25:		Line 25:

	'''Note:''' This property does not allow the <var>[[AddElement_(XmlDoc/XmlNode_function)\|AddElement]]</var> method to add an element with a name that starts with "xml". However, as shown in the [[#Adding an element to a document\|"Adding an element to a document"]] example below, it is easy to use the <var>[[LoadXml_(XmlDoc/XmlNode_function)\|LoadXml]]</var> method to accomplish this.		'''Note:''' This property does not allow the <var>[[AddElement_(XmlDoc/XmlNode_function)\|AddElement]]</var> method to add an element with a name that starts with "xml". However, as shown in the [[#Adding an element to a document\|"Adding an element to a document"]] example below, it is easy to use the <var>[[LoadXml_(XmlDoc/XmlNode_function)\|LoadXml]]</var> method to accomplish this.
	<li>The <var>AllowXmlElement</var> method was introduced in <var class="product">[[Sirius Mods~~\|"Sirius Mods"~~]]</var> Version 7.3, and it has also been provided by maintenance for Version 6.8 and Version 7.2.		<li>The <var>AllowXmlElement</var> method was introduced in <var class="product">[[Sirius Mods]]</var> Version 7.3, and it has also been provided by maintenance for Version 6.8 and Version 7.2.
	</ul>		</ul>

Goff: fix "using boolean enumerations" link

2011-05-19T09:29:31Z

fix "using boolean enumerations" link

← Older revision		Revision as of 09:29, 19 May 2011
Line 69:		Line 69:
	==Request-Cancellation Errors (for set method)==		==Request-Cancellation Errors (for set method)==
	<ul>		<ul>
	<li><var class="term">newBoolean</var> is an invalid value (ie: not a ~~<var>~~[[~~Boolean Enumeration\|~~Boolean]]~~</var>~~ value).		<li><var class="term">newBoolean</var> is an invalid value (ie: not a [[Boolean]] value).
	</ul>		</ul>

	==See also==		==See also==
	{{Template:XmlDoc:AllowXmlElement footer}}		{{Template:XmlDoc:AllowXmlElement footer}}

Goff: fix "using boolean enumerations" link

2011-05-19T09:09:47Z

fix "using boolean enumerations" link

← Older revision		Revision as of 09:09, 19 May 2011
Line 9:		Line 9:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%currentBoolean</th>		<tr><th>%currentBoolean</th>
	<td>The <var>Boolean</var> enumeration value of <var class="term">doc</var>'s <var>AllowXmlElement</var> property. For more information about these enumerations, see [[Using Boolean enumerations]].</td></tr>		<td>The <var>Boolean</var> enumeration value of <var class="term">doc</var>'s <var>AllowXmlElement</var> property. For more information about these enumerations, see [[Enumerations#Using_Boolean_enumerations\|"Using Boolean enumerations"]].</td></tr>
	<tr><th>doc</th>		<tr><th>doc</th>
	<td>An <var>XmlDoc</var> object expression.</td></tr>		<td>An <var>XmlDoc</var> object expression.</td></tr>
Line 15:		Line 15:
	<td>The <var>Boolean</var> value to assign to <var class="term">doc</var>'s <var>AllowXmlElement</var> property.</td></tr>		<td>The <var>Boolean</var> value to assign to <var class="term">doc</var>'s <var>AllowXmlElement</var> property.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>