Namespace (XmlDoc property): Difference between revisions
Jump to navigation
Jump to search
m (edits, tags and links) |
mNo edit summary |
||
| Line 13: | Line 13: | ||
<td>The <var>XmlNamespaceSetting</var> enumeration value to assign to <var class="term">doc</var>'s <var>Namespace</var> property.</td></tr> | <td>The <var>XmlNamespaceSetting</var> enumeration value to assign to <var class="term">doc</var>'s <var>Namespace</var> property.</td></tr> | ||
</table> | </table> | ||
<h3>XmlNamespaceSetting enumeration</h3> | |||
The values of the <var>Namespace</var> property are of type <var>[[Enumerations|Enumeration]]</var> <var>XmlNamespaceSetting</var>; these values and their meanings are shown below: | |||
< | |||
<dl> | <dl> | ||
<dt>On | <dt>On | ||
<dd>This is the initial value of the <var>Namespace</var> property. With this setting, the requirements imposed by the XML Namespaces Recommendation are followed by <var class="product">[[Janus SOAP | <dd>This is the initial value of the <var>Namespace</var> property. With this setting, the requirements imposed by the XML Namespaces Recommendation are followed by <var class="product">[[Janus SOAP]]</var>. That is, wherever a prefix occurs in the name of an element or attribute in the document, a namespace declaration must be in effect for that prefix. | ||
<dt>Ignore | <dt>Ignore | ||
<dd>With this setting, namespaces are not handled in any way by <var class="product"> | <dd>With this setting, namespaces are not handled in any way by <var class="product">Janus SOAP</var>; specifically: | ||
<ul> | <ul> | ||
<li>Invoking the <var>[[SelectionNamespace_(XmlDoc_property)|SelectionNamespace]]</var> property causes a request cancellation. | <li>Invoking the <var>[[SelectionNamespace_(XmlDoc_property)|SelectionNamespace]]</var> property causes a request cancellation. | ||
<li>Invoking the <var>[[LocalName (XmlDoc/XmlNode function)|LocalName]]</var>, <var>[[Prefix (XmlDoc/XmlNode function)|Prefix]]</var>, or <var>[[URI (XmlDoc/XmlNode function)|URI]]</var> functions | <li>Invoking the <var>[[LocalName (XmlDoc/XmlNode function)|LocalName]]</var>, <var>[[Prefix (XmlDoc/XmlNode function)|Prefix]]</var>, or <var>[[URI (XmlDoc/XmlNode function)|URI]]</var> functions | ||
| Line 36: | Line 30: | ||
<ul> | <ul> | ||
<li>Any name including a colon causes a request cancellation. | <li>Any name including a colon causes a request cancellation. | ||
<li>Any namespace declaration during deserialization causes a request cancellation (prior to <var class="product">[[Sirius Mods | <li>Any namespace declaration during deserialization causes a request cancellation (prior to <var class="product">[[Sirius Mods]]</var> Version 7.7, default namespace declarations were deserialized as if they were attributes). | ||
<li>The request is cancelled if the <var class="term">URI</var> argument is passed by an Element- or Attribute-adding method like <var>[[AddElement (XmlDoc/XmlNode function)|AddElement]]</var>, <var>[[AddAttribute (XmlNode function)|AddAttribute]]</var>, <var>[[InsertElementBefore (XmlNode function)|InsertElementBefore]]</var>, and so on. | <li>The request is cancelled if the <var class="term">URI</var> argument is passed by an Element- or Attribute-adding method like <var>[[AddElement (XmlDoc/XmlNode function)|AddElement]]</var>, <var>[[AddAttribute (XmlNode function)|AddAttribute]]</var>, <var>[[InsertElementBefore (XmlNode function)|InsertElementBefore]]</var>, and so on. | ||
<li>Invoking the <var>SelectionNamespace</var> property causes a request cancellation. | <li>Invoking the <var>SelectionNamespace</var> property causes a request cancellation. | ||
| Line 42: | Line 36: | ||
causes a request cancellation. | causes a request cancellation. | ||
<li>Invoking the <var>[[AddNamespace_(XmlNode_subroutine)|AddNamespace]]</var> subroutine causes a request cancellation. | <li>Invoking the <var>[[AddNamespace_(XmlNode_subroutine)|AddNamespace]]</var> subroutine causes a request cancellation. | ||
</ul> | </ul></dl> | ||
</ | ==Usage notes== | ||
<ul> | |||
<li>The <var>Namespace</var> property may not be changed if an <var>XmlDoc</var> contains an <var>Element</var> node. | |||
<li>Every name in the document is treated as a character string, which may include a colon. | |||
<li>A namespace declaration during deserialization is simply treated as an attribute, whose name begins with the characters "xmlns". | |||
<li>The request is cancelled if the URI argument is passed by an Element- or Attribute-adding method like <var>[[AddElement (XmlDoc/XmlNode function)|AddElement]]</var>, <var>[[AddAttribute (XmlNode function)|AddAttribute]]</var>, <var>[[InsertElementBefore (XmlNode function)|InsertElementBefore]]</var>, and so on. | |||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
The following example obtains the string value of the <var>Namespace</var> property: | The following example obtains the string value of the <var>Namespace</var> property: | ||
<p class="code">%str = doc:namespace:toString | <p class="code">%str = doc:namespace:toString | ||
</p | </p> | ||
==Request-Cancellation Errors (for set method)s== | ==Request-Cancellation Errors (for set method)s== | ||
Revision as of 16:14, 18 May 2011
(Dis)allow or disable prefix handling (XmlDoc class)
Namespace determines namespace handling in the XmlDoc, with the mapping of QName (qualified name) prefixes to namespace URIs.
Syntax
%currentXmlNamespaceSetting = doc:Namespace doc:Namespace = newXmlNamespaceSetting
Syntax terms
| %currentXmlNamespaceSetting | The XmlNamespaceSetting enumeration value of doc's Namespace property. Valid values are On, Ignore, and None, as described in "Usage Notes", below. |
|---|---|
| doc | An XmlDoc object expression. |
| newXmlNamespaceSetting | The XmlNamespaceSetting enumeration value to assign to doc's Namespace property. |
XmlNamespaceSetting enumeration
The values of the Namespace property are of type Enumeration XmlNamespaceSetting; these values and their meanings are shown below:
- On
- This is the initial value of the Namespace property. With this setting, the requirements imposed by the XML Namespaces Recommendation are followed by Janus SOAP. That is, wherever a prefix occurs in the name of an element or attribute in the document, a namespace declaration must be in effect for that prefix.
- Ignore
- With this setting, namespaces are not handled in any way by Janus SOAP; specifically:
- Invoking the SelectionNamespace property causes a request cancellation.
- Invoking the LocalName, Prefix, or URI functions causes a request cancellation.
- Invoking the AddNamespace subroutine causes a request cancellation.
- None
- With this setting, namespaces are not allowed in a document; specifically:
- Any name including a colon causes a request cancellation.
- Any namespace declaration during deserialization causes a request cancellation (prior to Sirius Mods Version 7.7, default namespace declarations were deserialized as if they were attributes).
- The request is cancelled if the URI argument is passed by an Element- or Attribute-adding method like AddElement, AddAttribute, InsertElementBefore, and so on.
- Invoking the SelectionNamespace property causes a request cancellation.
- Invoking the LocalName, Prefix, or URI functions causes a request cancellation.
- Invoking the AddNamespace subroutine causes a request cancellation.
Usage notes
- The Namespace property may not be changed if an XmlDoc contains an Element node.
- Every name in the document is treated as a character string, which may include a colon.
- A namespace declaration during deserialization is simply treated as an attribute, whose name begins with the characters "xmlns".
- The request is cancelled if the URI argument is passed by an Element- or Attribute-adding method like AddElement, AddAttribute, InsertElementBefore, and so on.
Examples
The following example obtains the string value of the Namespace property:
%str = doc:namespace:toString
Request-Cancellation Errors (for set method)s
- XmlDoc contains an Element node.