AdjacentText (XmlDoc property) - Revision history

ELowell: /* Syntax terms */

2015-09-02T21:01:52Z

Syntax terms

← Older revision		Revision as of 21:01, 2 September 2015
Line 4:		Line 4:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%currentXmlAdjacentTextSetting</th>		<tr><th nowrap>%currentXmlAdjacentTextSetting</th>
	<td>The <var>XmlAdjacentTextSetting</var> enumeration value (see below) of <var class="term">doc</var>'s <var>AdjacentText</var> property. </td></tr>		<td>The <var>XmlAdjacentTextSetting</var> enumeration value (see below) of <var class="term">doc</var>'s <var>AdjacentText</var> property. </td></tr>
	<tr><th>doc</th>		<tr><th>doc</th>

JAL: /* Request-cancellation errors (for set method) */

2014-03-03T17:11:49Z

Request-cancellation errors (for set method)

← Older revision		Revision as of 17:11, 3 March 2014
Line 87:		Line 87:

	==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">newXmlAdjacentTextSetting</var> argument is an invalid value.		<li>The <var class="term">newXmlAdjacentTextSetting</var> argument is an invalid value.

JAL: /* XmlAdjacentTextSetting enumeration */

2014-03-03T17:10:47Z

XmlAdjacentTextSetting enumeration

JAL2 at 21:21, 16 August 2011

2011-08-16T21:21:51Z

← Older revision		Revision as of 21:21, 16 August 2011
Line 28:		Line 28:
	<dd>This is the initial value of the <var>AdjacentText</var> property. With this setting, the operations cited above for <var>Combine</var> result in request cancellation, since they place <var>Text</var> nodes adjacent to each other.		<dd>This is the initial value of the <var>AdjacentText</var> property. With this setting, the operations cited above for <var>Combine</var> result in request cancellation, since they place <var>Text</var> nodes adjacent to each other.
	</dl>		</dl>

			'''Note:''' As with all enumerations, the <var>ToString</var> method implicitly converts an enumeration value to a character string whose value is the name of the enumeration value. For more information about methods available to all enumerations, see [[Enumerations#Common enumeration methods\|"Common enumeration methods"]].

	==Examples==		==Examples==

JAL2 at 20:45, 31 May 2011

2011-05-31T20:45:20Z

← Older revision		Revision as of 20:45, 31 May 2011
Line 1:		Line 1:
	{{Template:XmlDoc:AdjacentText subtitle}}		{{Template:XmlDoc:AdjacentText subtitle}}
	~~This property indicates whether or not an operation is allowed that places text nodes adjacent to each other in an <var>XmlDoc</var>.~~

	==Syntax==		==Syntax==
	{{Template:XmlDoc:AdjacentText syntax}}		{{Template:XmlDoc:AdjacentText syntax}}
Line 26:		Line 24:
	<li><var>[[InsertSubtreeBefore_(XmlNode_function)\|InsertSubtreeBefore]]</var> with a <var>Text</var> node source subtree applied to a target that is a <var>Text</var> node or a target that is the sibling following a <var>Text</var> node		<li><var>[[InsertSubtreeBefore_(XmlNode_function)\|InsertSubtreeBefore]]</var> with a <var>Text</var> node source subtree applied to a target that is a <var>Text</var> node or a target that is the sibling following a <var>Text</var> node
	</ul>		</ul>
	If one of these operations occurs, the values of the adjacent <var>Text</var> nodes are combined to form a new <var>Text</var> node. The new node takes the place of the former <var>Text</var> node(s), and the former is (are) deleted. Any <var>XmlNode</var> or <var>XmlNodelist</var> pointers to the former <var>Text</var> node(s) are set to Null.		If one of these operations occurs, the values of the adjacent <var>Text</var> nodes are combined to form a new <var>Text</var> node. The new node takes the place of the former <var>Text</var> node(s), and the former is (are) deleted. Any <var>XmlNode</var> or <var>XmlNodelist</var> pointers to the former <var>Text</var> node(s) are set to <var>Null</var>.
	<dt><b>Disallow</b>		<dt><b>Disallow</b>
	<dd>This is the initial value of the <var>AdjacentText</var> property. With this setting, the operations cited above for <~~code~~>Combine</~~code~~> result in request cancellation, since they place ~~text~~ nodes adjacent to each other.		<dd>This is the initial value of the <var>AdjacentText</var> property. With this setting, the operations cited above for <var>Combine</var> result in request cancellation, since they place <var>Text</var> nodes adjacent to each other.
	</dl>		</dl>

Line 80:		Line 78:
	</ol>		</ol>

	==Request-~~Cancellation Errors~~ (for set method)==		==Request-cancellation errors (for set method)==
	<ul>		<ul>
	<li><var class="term">~~newvalue~~</var> is an invalid value.		<li>The <var class="term">newXmlAdjacentTextSetting</var> argument is an invalid value.
	</ul>		</ul>

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

JAL2 at 19:28, 17 May 2011

2011-05-17T19:28:53Z

← Older revision		Revision as of 19:28, 17 May 2011
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%currentXmlAdjacentTextSetting</th>		<tr><th>%currentXmlAdjacentTextSetting</th>
	<td>The <var>~~AdjacentTextSetting~~</var> enumeration value (see below) of <var class="term">doc</var>'s <var>AdjacentText</var> property. </td></tr>		<td>The <var>XmlAdjacentTextSetting</var> enumeration value (see below) of <var class="term">doc</var>'s <var>AdjacentText</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>newXmlAdjacentTextSetting</th>		<tr><th>newXmlAdjacentTextSetting</th>
	<td>The <var>~~AdjacentTextSetting~~</var> value (see below) to assign to <var class="term">doc</var>'s <var>AdjacentText</var> property.</td></tr>		<td>The <var>XmlAdjacentTextSetting</var> value (see below) to assign to <var class="term">doc</var>'s <var>AdjacentText</var> property.</td></tr>
	</table>		</table>

	===~~AdjacentTextSetting~~ enumeration===		===XmlAdjacentTextSetting enumeration===
	The values of the <var>AdjacentText</var> property are of type <var>[[Enumerations\|Enumeration]]</var> <var>~~AdjacentTextSetting~~</var>. These values and their meanings are shown below.		The values of the <var>AdjacentText</var> property are of type <var>[[Enumerations\|Enumeration]]</var> <var>XmlAdjacentTextSetting</var>. These values and their meanings are shown below.
	<dl>		<dl>
	<dt><b>Combine</b>		<dt><b>Combine</b>

JAL2 at 19:24, 17 May 2011

2011-05-17T19:24:50Z

← Older revision		Revision as of 19:24, 17 May 2011
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%currentXmlAdjacentTextSetting</th>		<tr><th>%currentXmlAdjacentTextSetting</th>
	<td>The <var>AdjacentTextSetting</var> enumeration value of <var class="term">doc</var>'s <var>AdjacentText</var> property~~. For more information about this enumeration, see [[AdjacentText_(XmlDoc_property)#Usage_notes\|"Usage Notes"]] below~~.</td></tr>		<td>The <var>AdjacentTextSetting</var> enumeration value (see below) of <var class="term">doc</var>'s <var>AdjacentText</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 14:		Line 14:
	</table>		</table>

	==~~Usage notes~~==		===AdjacentTextSetting enumeration===
	~~<ul>~~		The values of the <var>AdjacentText</var> property are of type <var>[[Enumerations\|Enumeration]]</var> <var>AdjacentTextSetting</var>. These values and their meanings are shown below.
	~~<li>~~The values of the <var>AdjacentText</var> property are of type Enumeration <var>~~AdjacentText~~</var> ~~Setting~~. These values and their meanings are shown below~~. For more information about enumerations, see [[Enumerations]]~~.
	<dl>		<dl>
	<dt><b>Combine</b>		<dt><b>Combine</b>
Line 31:		Line 30:
	<dd>This is the initial value of the <var>AdjacentText</var> property. With this setting, the operations cited above for <code>Combine</code> result in request cancellation, since they place text nodes adjacent to each other.		<dd>This is the initial value of the <var>AdjacentText</var> property. With this setting, the operations cited above for <code>Combine</code> result in request cancellation, since they place text nodes adjacent to each other.
	</dl>		</dl>
	~~</ul>~~

	==Examples==		==Examples==

JAL2: /* Usage notes */

2011-05-04T17:42:15Z

Usage notes

← Older revision		Revision as of 17:42, 4 May 2011
Line 31:		Line 31:
	<dd>This is the initial value of the <var>AdjacentText</var> property. With this setting, the operations cited above for <code>Combine</code> result in request cancellation, since they place text nodes adjacent to each other.		<dd>This is the initial value of the <var>AdjacentText</var> property. With this setting, the operations cited above for <code>Combine</code> result in request cancellation, since they place text nodes adjacent to each other.
	</dl>		</dl>
	~~<li><var>AdjacentText</var> is available in <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 6.7 and later.~~
	</ul>		</ul>

Goff: edits, tags and links

2011-05-04T11:08:30Z

edits, tags and links

New page

{{Template:XmlDoc:AdjacentText subtitle}}
This property indicates whether or not an operation is allowed that places text nodes adjacent to each other in an <var>XmlDoc</var>.

==Syntax==
{{Template:XmlDoc:AdjacentText syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%currentXmlAdjacentTextSetting</th>
<td>The <var>AdjacentTextSetting</var> enumeration value of <var class="term">doc</var>'s <var>AdjacentText</var> property. For more information about this enumeration, see [[AdjacentText_(XmlDoc_property)#Usage_notes|"Usage Notes"]] below.</td></tr>
<tr><th>doc</th>
<td>An <var>XmlDoc</var> object expression.</td></tr>
<tr><th>newXmlAdjacentTextSetting</th>
<td>The <var>AdjacentTextSetting</var> value (see below) to assign to <var class="term">doc</var>'s <var>AdjacentText</var> property.</td></tr>
</table>

==Usage notes==
<ul>
<li>The values of the <var>AdjacentText</var> property are of type Enumeration <var>AdjacentText</var> Setting. These values and their meanings are shown below. For more information about enumerations, see [[Enumerations]].
<dl>
<dt>Combine
<dd>This setting permits without request cancellation the following operations that place text nodes adjacent to each other:
<ul>
<li><var>[[DeleteSubtree_(XmlDoc/XmlNode_subroutine)|DeleteSubtree]]</var> applied to a subtree that is between <var>Text</var> nodes
<li><var>[[AddText_(XmlNode_function)|AddText]]</var> applied to an <var>Element</var> whose last child is a <var>Text</var> node
<li><var>[[InsertTextBefore_(XmlNode_function)|InsertTextBefore]]</var> applied to a <var>Text</var> node or to the sibling following a <var>Text</var> node
<li><var>[[AddSubtree_(XmlDoc/XmlNode_function)|AddSubtree]]</var> with a <var>Text</var> node source subtree applied to a target <var>Element</var> that has a <var>Text</var> node as its last child
<li><var>[[InsertSubtreeBefore_(XmlNode_function)|InsertSubtreeBefore]]</var> with a <var>Text</var> node source subtree applied to a target that is a <var>Text</var> node or a target that is the sibling following a <var>Text</var> node
</ul>
If one of these operations occurs, the values of the adjacent <var>Text</var> nodes are combined to form a new <var>Text</var> node. The new node takes the place of the former <var>Text</var> node(s), and the former is (are) deleted. Any <var>XmlNode</var> or <var>XmlNodelist</var> pointers to the former <var>Text</var> node(s) are set to Null.
<dt>Disallow
<dd>This is the initial value of the <var>AdjacentText</var> property. With this setting, the operations cited above for <code>Combine</code> result in request cancellation, since they place text nodes adjacent to each other.
</dl>
<li><var>AdjacentText</var> is available in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 6.7 and later.
</ul>

==Examples==
<ol>
<li>The following example obtains the string value of the <var>AdjacentText</var> property:
%str = %doc:AdjacentText:toString

<li>The following request shows the effect of using the <code>Combine</code> option forming a new node, making pointers <var>Null</var>:
begin
%d object xmlDoc auto new
%d:adjacentText = Combine
%e object xmlNode
%t object xmlNode
%t2 object xmlNode
%t3 object xmlNode

%e = %d:[[AddElement_(XmlDoc/XmlNode_function)|addElement]]('topElement')
%t = %e:[[AddText_(XmlNode_function)|addText]]('Texta.')
Call %e:addText('Textb.')
if %t is null then
print 'First now Null'
end if
%d:print
%t = %e:[[SelectSingleNode_(XmlDoc/XmlNode_function)|selectSingleNode]]('node()')
print 'Value of first child node:' and %t:value

%t2 = %e:addElement('subElement')
%t3 = %e:addText('Textc.')
Call %t2:[[DeleteSubtree_(XmlDoc/XmlNode_subroutine)|deleteSubtree]]
if %t is null then
print 'First now Null'
end if
if %t3 is null then
print 'Last now Null'
end if
%d:print
%t = %e:selectSingleNode('node()')
print 'Value of first child node:' and %t:value
end

The result of the above request is:
First now Null
<topElement>Texta.Textb.</topElement>
Value of first child node: Texta.Textb.
First now Null
Last now Null
<topElement>Texta.Textb.Textc.</topElement>
Value of first child node: Texta.Textb.Textc.

</ol>

==Request-Cancellation Errors (for set method)==
<ul>
<li><var class="term">newvalue</var> is an invalid value.
</ul>

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

Wiccan: 1 revision

2011-01-25T17:46:05Z

1 revision

← Older revision	Revision as of 17:46, 25 January 2011
(No difference)

← Older revision		Revision as of 17:10, 3 March 2014
Line 18:		Line 18:
	<dd>This setting permits without request cancellation the following operations that place text nodes adjacent to each other:		<dd>This setting permits without request cancellation the following operations that place text nodes adjacent to each other:
	<ul>		<ul>
	<li><var>[[DeleteSubtree_(XmlDoc/XmlNode_subroutine)\|DeleteSubtree]]</var> applied to a subtree that is between ~~<var>~~Text~~</var>~~ nodes		<li><var>[[DeleteSubtree_(XmlDoc/XmlNode_subroutine)\|DeleteSubtree]]</var> applied to a subtree that is between [[XmlDoc API#XmlDoc node types\|Text nodes]]

	<li><var>[[AddText_(XmlNode_function)\|AddText]]</var> applied to an <var>Element</var> whose last child is a <var>Text</var> node		<li><var>[[AddText_(XmlNode_function)\|AddText]]</var> applied to an <var>Element</var> whose last child is a <var>Text</var> node

	<li><var>[[InsertTextBefore_(XmlNode_function)\|InsertTextBefore]]</var> applied to a <var>Text</var> node or to the sibling following a <var>Text</var> node		<li><var>[[InsertTextBefore_(XmlNode_function)\|InsertTextBefore]]</var> applied to a <var>Text</var> node or to the sibling following a <var>Text</var> node

	<li><var>[[AddSubtree_(XmlDoc/XmlNode_function)\|AddSubtree]]</var> with a <var>Text</var> node source subtree applied to a target <var>Element</var> that has a <var>Text</var> node as its last child		<li><var>[[AddSubtree_(XmlDoc/XmlNode_function)\|AddSubtree]]</var> with a <var>Text</var> node source subtree applied to a target <var>Element</var> that has a <var>Text</var> node as its last child

	<li><var>[[InsertSubtreeBefore_(XmlNode_function)\|InsertSubtreeBefore]]</var> with a <var>Text</var> node source subtree applied to a target that is a <var>Text</var> node or a target that is the sibling following a <var>Text</var> node		<li><var>[[InsertSubtreeBefore_(XmlNode_function)\|InsertSubtreeBefore]]</var> with a <var>Text</var> node source subtree applied to a target that is a <var>Text</var> node or a target that is the sibling following a <var>Text</var> node
	</ul>		</ul>

	If one of these operations occurs, the values of the adjacent <var>Text</var> nodes are combined to form a new <var>Text</var> node. The new node takes the place of the former <var>Text</var> node(s), and the former is (are) deleted. Any <var>XmlNode</var> or <var>XmlNodelist</var> pointers to the former <var>Text</var> node(s) are set to <var>Null</var>.		If one of these operations occurs, the values of the adjacent <var>Text</var> nodes are combined to form a new <var>Text</var> node. The new node takes the place of the former <var>Text</var> node(s), and the former is (are) deleted. Any <var>XmlNode</var> or <var>XmlNodelist</var> pointers to the former <var>Text</var> node(s) are set to <var>Null</var>.

	<dt><b>Disallow</b>		<dt><b>Disallow</b>
	<dd>This is the initial value of the <var>AdjacentText</var> property. With this setting, the operations cited above for <var>Combine</var> result in request cancellation, since they place <var>Text</var> nodes adjacent to each other.		<dd>This is the initial value of the <var>AdjacentText</var> property. With this setting, the operations cited above for <var>Combine</var> result in request cancellation, since they place <var>Text</var> nodes adjacent to each other.
	</dl>		</dl>

	'''Note:''' As with all enumerations, the <var>ToString</var> method implicitly converts an enumeration value to a character string whose value is the name of the enumeration value. For more information about methods available to all enumerations, see [[Enumerations#Common enumeration methods\|"Common enumeration methods"]].		<p class="note">'''Note:''' As with all enumerations, the <var>ToString</var> method implicitly converts an enumeration value to a character string whose value is the name of the enumeration value. For more information about methods available to all enumerations, see [[Enumerations#Common enumeration methods\|Common enumeration methods]]. </p>

	==Examples==		==Examples==