AdjacentText (XmlDoc property)

Are adjacent text nodes allowed? (XmlDoc class)

AdjacentText is a member of the XmlDoc class.

This property indicates whether or not an operation is allowed that places text nodes adjacent to each other in an XmlDoc.

Syntax

%currentXmlAdjacentTextSetting = doc:AdjacentText doc:AdjacentText = newXmlAdjacentTextSetting

Syntax terms

%curr

The AdjacentTextSetting enumeration value of doc's AdjacentText property. For more information about this enumeration, see ?? reftxt='Usage Notes' refid=unadjtx., below.

doc

An XmlDoc object expression.

newvalue

The AdjacentTextSetting value (see below) to assign to doc's AdjacentText property.

Usage notes

• The values of the AdjacentText property are of type Enumeration AdjacentTextSetting. These values and their meanings are shown below. For more information about enumerations, see Enumerations.

  Combine

  This setting permits without request cancellation the following operations that place text nodes adjacent to each other:

  • DeleteSubtree applied to a subtree that is between Text nodes
  • AddText applied to an Element whose last child is a Text node
  • InsertTextBefore applied to a Text node or to the sibling following a Text node
  • AddSubtree with a Text node source subtree applied to a target Element that has a Text node as its last child
  • InsertSubtreeBefore with a Text node source subtree applied to a target that is a Text node or a target that is the sibling following a Text node

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

  Disallow

  This is the initial value of the AdjacentText property. With this setting, the operations cited above for Combine result in request cancellation, since they place text nodes adjacent to each other.

• This method is new in Sirius Mods version 6.7.

Examples

• The following example obtains the string value of the AdjacentText property:

      %str = %doc:AdjacentText:ToString
  

• The following request shows the effect of using the Combine option: forming a new node, making pointers Null.

      Begin
      %d Object XmlDoc Auto New
      %d:AdjacentText = Combine
      %e Object XmlNode
      %t Object XmlNode
      %t2 Object XmlNode
      %t3 Object XmlNode
  
      %e = %d:AddElement('topElement')
      %t = %e:AddText('Texta.')
      Call %e:AddText('Textb.')
      If %t Is Null Then Print 'First now Null'
      End If
      %d:Print
      %t = %e:SelectSingleNode('node()')
      Print 'Value of first child node:' And %t:Value
  
      %t2 = %e:AddElement('subElement')
      %t3 = %e:AddText('Textc.')
      Call %t2: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.
  

Request-Cancellation Errors (for set method)

• newvalue is an invalid value.