text Property

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

Represents the text content of the node or the concatenated text representing the node and its descendants.

Script Syntax

            strValue = oXMLDOMNode.text;

Remarks

Script Parameters

None.

Script Return Value

String. String representing the text content of this node and its descendants. This value varies depending on the value of the nodeType property.

C/C++ Syntax

HRESULT get_text(
  BSTR* text
);

Remarks

C/C++ Parameters

  • text
    [out, retval] String representing the text content of this node and its descendants. This value varies depending on the value of the nodeType property.

C/C++ Return Values

  • S_OK
    Value returned if successful.
  • S_FALSE
    Value returned when there is no text.
  • E_INVALIDARG
    Value returned if text is Null.

Requirements

Header msxml2.h, msxml2.idl
Windows Embedded CE Windows CE .NET 4.0 and later

General Remarks

When concatenated, the text represents the contents of text or CDATA nodes. All concatenated text nodes are normalized according to xml:space attributes and the value of the preserveWhiteSpace switch. Concatenated CDATA text is not normalized. (Child nodes that contain NODE_COMMENT and NODE_PROCESSING_INSTRUCTION nodes are not concatenated.)

Retrieves and sets the string representing the text contents of this node or the concatenated text representing this node and its descendants.

For more precise control over text manipulation in an XML document, use the lower-level nodeValue property, which returns the raw text associated with a NODE_TEXT node.

Consider the "root" element in this example.

<root att="   123   a   <   ">
   <a>   a   a   </a>
   <!--   comment   b   -->
   <?pi   pi   c   ?>
   <![CDATA[   cdata   d   ]]>
   e   f
</root>

The text property for the root element returns the following concatenated text.

"a a   cdata   d    e f"

Note that the white space within the CDATA node is preserved.

This value depends on the value of the nodeType property.

Value Description

NODE_ATTRIBUTE, NODE_DOCUMENT, NODE_ENTITY

Returns a string representing the value of the node. This is the concatenated text of all subnodes with entities expanded.

NODE_CDATA_SECTION, NODE_COMMENT, NODE_PROCESSING_INSTRUCTION, NODE_TEXT

Returns the text contained in the node, which is the same as the nodeValue property.

NODE_DOCUMENT_TYPE, NODE_NOTATION

Returns the empty string (""). These node types do not have associated text.

NODE_DOCUMENT_FRAGMENT

Returns the text comprised of the concatenation of all descendant nodes.

NODE_ELEMENT

Contains a string that represents the element content. Note that this will also include the text content from all child elements, concatenated in document order. For example, consider the following XML:

<count>
  <item>one</item>
  <item>two</item>
  <item>three</item>
  <item>four</item>
</count>

The text property for the <count> element contains the value "one two three four".

NODE_ENTITY_REFERENCE

Returns the string representation of the entity reference.

This property is read/write, and applies to the following objects and interfaces:

IXMLDOMAttribute, IXMLDOMCDATASection, IXMLDOMCharacterData, IXMLDOMComment, DOMDocument, IXMLDOMDocumentFragment, IXMLDOMDocumentType, IXMLDOMElement, IXMLDOMEntity, IXMLDOMEntityReference, IXMLDOMNode, IXMLDOMNotation, IXMLDOMProcessingInstruction, IXMLDOMText, and IXTLRuntime.

See Also

Concepts

nodeType Property
nodeValue Property