AddSubtree (XmlDoc/XmlNode function) - Revision history

ELowell: /* Examples */

2015-09-04T16:55:05Z

Examples

← Older revision		Revision as of 16:55, 4 September 2015
Line 75:		Line 75:
	</SOAP-ENV:Body>		</SOAP-ENV:Body>
	</SOAP-ENV:Envelope></nowiki>		</SOAP-ENV:Envelope></nowiki>
	</p>		</p><div id="adsub2"></div>
	~~<li~~><div id="adsub2"></div>In the following request, a source node is added to a target node, and the source node retains the URI value it had in the source <var>XmlDoc</var>:		<li>In the following request, a source node is added to a target node, and the source node retains the URI value it had in the source <var>XmlDoc</var>:
	<p class="code">begin		<p class="code">begin
	%outDoc is object xmlDoc auto new		%outDoc is object xmlDoc auto new

JAL: /* Syntax terms */

2014-07-31T20:53:27Z

Syntax terms

← Older revision		Revision as of 20:53, 31 July 2014
Line 18:		Line 18:
	<tr><th><var>DefaultURI</var></th>		<tr><th><var>DefaultURI</var></th>
	<td>This optional, [[Methods#Named parameters\|name required]] parameter is a <var>Unicode</var> string that controls the URI of the default namespace of some of the <var>Element</var> nodes of the added subtree.		<td>This optional, [[Methods#Named parameters\|name required]] parameter is a <var>Unicode</var> string that controls the URI of the default namespace of some of the <var>Element</var> nodes of the added subtree.
	<p>If a <var>DefaultURI</var> argument is specified, its value becomes the URI that is used for all unprefixed elements in the added subtree that are not already in the scope of a default namespace declaration within the added subtree. For more details, see the [[AddSubtree_(XmlDoc/XmlNode_function)#Usage_notes\|"Usage notes"]] and [[AddSubtree_(XmlDoc/XmlNode_function)#Examples\|"Examples"]] sections, below.</p>		<p>If a <var>DefaultURI</var> argument is specified, its value becomes the URI that is used for all unprefixed elements in the added subtree that are not already in the scope of a default namespace declaration within the added subtree. For more details, see the [[AddSubtree_(XmlDoc/XmlNode_function)#Usage_notes\|Usage notes]] and [[AddSubtree_(XmlDoc/XmlNode_function)#Examples\|Examples]] sections, below.</p>
	</td></tr>		</td></tr>
	</table>		</table>

JAL at 02:08, 1 March 2014

2014-03-01T02:08:53Z

← Older revision		Revision as of 02:08, 1 March 2014
Line 4:		Line 4:
	==Syntax==		==Syntax==
	{{Template:XmlDoc/XmlNode:AddSubtree syntax}}		{{Template:XmlDoc/XmlNode:AddSubtree syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%nod</th>		<tr><th>%nod</th>
	<td>If specified, an <var>XmlNode</var> that is set to point to the top of the subtree that is added.</td></tr>		<td>If specified, an <var>XmlNode</var> that is set to point to the top of the subtree that is added.</td></tr>

	<tr><th>nr</th>		<tr><th>nr</th>
	<td>An <var>XmlDoc</var> or <var>XmlNode</var> that refers to the <var>Root</var> or <var>Element</var> node parent of the added subtree.</td></tr>		<td>An <var>XmlDoc</var> or <var>XmlNode</var> that refers to the <var>Root</var> or <var>Element</var> node parent of the added subtree.</td></tr>

	<tr><th>sourceSubtreeNode</th>		<tr><th>sourceSubtreeNode</th>
	<td><var>XmlNode</var> that points to the non-Root node that is the top of the subtree to be copied.</td></tr>		<td><var>XmlNode</var> that points to the non-Root node that is the top of the subtree to be copied.</td></tr>

	<tr><th><var>DefaultURI</var></th>		<tr><th><var>DefaultURI</var></th>
	<td>This optional, [[Methods#Named parameters\|name required]] parameter is a <var>Unicode</var> string that controls the URI of the default namespace of some of the <var>Element</var> nodes of the added subtree.		<td>This optional, [[Methods#Named parameters\|name required]] parameter is a <var>Unicode</var> string that controls the URI of the default namespace of some of the <var>Element</var> nodes of the added subtree.
	<p>If a <var>DefaultURI</var> argument is specified, its value becomes the URI that is used for all unprefixed elements in the added subtree that are not already in the scope of a default namespace declaration within the added subtree. For more details, see the [[AddSubtree_(XmlDoc/XmlNode_function)#Usage_notes\|"Usage notes"]] and [[AddSubtree_(XmlDoc/XmlNode_function)#Examples\|"Examples"]] sections, below.</p>		<p>If a <var>DefaultURI</var> argument is specified, its value becomes the URI that is used for all unprefixed elements in the added subtree that are not already in the scope of a default namespace declaration within the added subtree. For more details, see the [[AddSubtree_(XmlDoc/XmlNode_function)#Usage_notes\|"Usage notes"]] and [[AddSubtree_(XmlDoc/XmlNode_function)#Examples\|"Examples"]] sections, below.</p>
	~~<p>This parameter is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 6.9.</p>~~</td></tr>		</td></tr>
	</table>		</table>

Line 148:		Line 152:

	==Request-cancellation errors==		==Request-cancellation errors==
			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">nr</var> object is neither the <var>Root</var> nor an <var>Element</var> node.		<li>The <var class="term">nr</var> object is neither the <var>Root</var> nor an <var>Element</var> node.

	<li>The <var class="term">sourceSubtreeNode</var> argument is a <var>Root</var> node.		<li>The <var class="term">sourceSubtreeNode</var> argument is a <var>Root</var> node.

	<li><var class="term">nr</var> is the same as, or a descendant of, <var class="term">sourceSubtreeNode</var>.		<li><var class="term">nr</var> is the same as, or a descendant of, <var class="term">sourceSubtreeNode</var>.

	<li>Source and target <var>XmlDoc</var>s have different <var>[[Namespace (XmlDoc property)\|Namespace]]</var> settings.		<li>Source and target <var>XmlDoc</var>s have different <var>[[Namespace (XmlDoc property)\|Namespace]]</var> settings.

	<li>Any of the errors that would occur based on insertion of the top subtree node at the given target parent, for example, insertion of a duplicate attribute, or insertion of an adjacent Text node when the <var>[[AdjacentText (XmlDoc property)\|AdjacentText]]</var> property value is <var>Disallow</var>. See the "Add" function corresponding to the type of the subtree node (for those examples just cited, <var>[[AddAttribute (XmlNode function)\|AddAttribute]]</var> and <var>[[AddText (XmlNode function)\|AddText]]</var>, respectively).		<li>Any of the errors that would occur based on insertion of the top subtree node at the given target parent, for example, insertion of a duplicate attribute, or insertion of an adjacent Text node when the <var>[[AdjacentText (XmlDoc property)\|AdjacentText]]</var> property value is <var>Disallow</var>. See the "Add" function corresponding to the type of the subtree node (for those examples just cited, <var>[[AddAttribute (XmlNode function)\|AddAttribute]]</var> and <var>[[AddText (XmlNode function)\|AddText]]</var>, respectively).

	<li>Insufficient free space exists in CCATEMP.		<li>Insufficient free space exists in CCATEMP.
	</ul>		</ul>

JAL: /* Examples */

2012-10-10T20:34:19Z

Examples

← Older revision		Revision as of 20:34, 10 October 2012
Line 119:		Line 119:
	This <code>source</code> element URI would '''not''' be used if the declaration of the default namespace in scope at the <var>source</var> element were inside the source subtree, as in the next example.		This <code>source</code> element URI would '''not''' be used if the declaration of the default namespace in scope at the <var>source</var> element were inside the source subtree, as in the next example.
	<div id="adsub4"></div>		<div id="adsub4"></div>
	<li>In the following User Language fragment, the namespace URI of an unprefixed node is preserved (despite the <var>DefaultURI</var> argument), since the namespace declaration is within the added subtree:
			<li>In the following <var class="product">User Language</var> fragment, the namespace URI of an unprefixed node is preserved (despite the <var>DefaultURI</var> argument), since the namespace declaration is within the added subtree:
	<p class="code">%tar = %outDoc:AddElement('target', , 'urn:target')		<p class="code">%tar = %outDoc:AddElement('target', , 'urn:target')
	%src = %inDoc:addElement('source', , 'urn:source')		%src = %inDoc:addElement('source', , 'urn:source')

JALWiccan: 1 revision

2012-06-10T22:20:42Z

1 revision

← Older revision	Revision as of 22:20, 10 June 2012
(No difference)

JAL2 at 22:20, 10 June 2012

2012-06-10T22:20:41Z

← Older revision		Revision as of 22:20, 10 June 2012
Line 13:		Line 13:
	<td><var>XmlNode</var> that points to the non-Root node that is the top of the subtree to be copied.</td></tr>		<td><var>XmlNode</var> that points to the non-Root node that is the top of the subtree to be copied.</td></tr>
	<tr><th><var>DefaultURI</var></th>		<tr><th><var>DefaultURI</var></th>
	<td>This optional, ~~but~~ [[Methods#Named parameters\|name required]] parameter is a <var>Unicode</var> string that controls the URI of the default namespace of some of the <var>Element</var> nodes of the added subtree.		<td>This optional, [[Methods#Named parameters\|name required]] parameter is a <var>Unicode</var> string that controls the URI of the default namespace of some of the <var>Element</var> nodes of the added subtree.
	<p>If a <var>DefaultURI</var> argument is specified, its value becomes the URI that is used for all unprefixed elements in the added subtree that are not already in the scope of a default namespace declaration within the added subtree. For more details, see the [[AddSubtree_(XmlDoc/XmlNode_function)#Usage_notes\|"Usage notes"]] and [[AddSubtree_(XmlDoc/XmlNode_function)#Examples\|"Examples"]] sections, below.</p>		<p>If a <var>DefaultURI</var> argument is specified, its value becomes the URI that is used for all unprefixed elements in the added subtree that are not already in the scope of a default namespace declaration within the added subtree. For more details, see the [[AddSubtree_(XmlDoc/XmlNode_function)#Usage_notes\|"Usage notes"]] and [[AddSubtree_(XmlDoc/XmlNode_function)#Examples\|"Examples"]] sections, below.</p>
	<p>This parameter is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 6.9.</p></td></tr>		<p>This parameter is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 6.9.</p></td></tr>

JAL2 at 20:50, 27 May 2011

2011-05-27T20:50:46Z

Show changes

JALWiccan: 1 revision

2011-05-24T21:09:56Z

1 revision

← Older revision	Revision as of 21:09, 24 May 2011
(No difference)

JALWiccan: 1 revision

2011-05-24T21:09:55Z

1 revision

← Older revision		Revision as of 21:09, 24 May 2011
Line 22:		Line 22:
	<li>Since the return value of <var>AddSubtree</var> is frequently not needed, you may want to <var>[[Notation_conventions_for_methods#Callable_methods\|Call]]</var> it instead of saving its return value.		<li>Since the return value of <var>AddSubtree</var> is frequently not needed, you may want to <var>[[Notation_conventions_for_methods#Callable_methods\|Call]]</var> it instead of saving its return value.
	<li>The target parent and <var>subtree</var> nodes can either be in the same or in different <var>XmlDoc</var>s.		<li>The target parent and <var>subtree</var> nodes can either be in the same or in different <var>XmlDoc</var>s.
	<li>When copying between different <var>XmlDoc</var>s under <var class="product">"Sirius Mods"</var> Version 6.8 or earlier, the <var>XmlDoc</var>s' Namespace properties must be the same, that is, both <code>On</code> or both <code>Off</code>. As of <var class="product">"Sirius Mods"</var> Version 6.9, these conditions also permit such copying:		<li>When copying between different <var>XmlDoc</var>s under <var class="product">Sirius Mods</var> Version 6.8 or earlier, the <var>XmlDoc</var>s' Namespace properties must be the same, that is, both <code>On</code> or both <code>Off</code>. As of <var class="product">Sirius Mods</var> Version 6.9, these conditions also permit such copying:
	<ul>		<ul>
	<li>The source <var>XmlDoc</var> has <code>Namespace=None</code> and the target <var>XmlDoc</var> has <code>Namespace=Ignore</code>.		<li>The source <var>XmlDoc</var> has <code>Namespace=None</code> and the target <var>XmlDoc</var> has <code>Namespace=Ignore</code>.

JALWiccan: 1 revision

2011-05-04T22:31:56Z

1 revision

← Older revision	Revision as of 22:31, 4 May 2011
(No difference)