Document.SelectSingleNode Method

Returns a XMLNode object that represents the first node in the document that matches the XPath parameter.

Namespace:  Microsoft.Office.Tools.Word
Assemblies:   Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)
  Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)

Syntax

'Declaration
Function SelectSingleNode ( _
    XPath As String, _
    PrefixMapping As String, _
    FastSearchSkippingTextNodes As Boolean _
) As XMLNode
XMLNode SelectSingleNode(
    string XPath,
    string PrefixMapping,
    bool FastSearchSkippingTextNodes
)

Parameters

  • XPath
    Type: System.String

    A valid XPath string. For more information about XPath, see XPath Reference.

  • PrefixMapping
    Type: System.String

    Provides the prefix in the schema against which to perform the search. Use the PrefixMapping parameter if your XPath parameter uses names to search for elements.

  • FastSearchSkippingTextNodes
    Type: System.Boolean

    true skips all text nodes while searching for the specified node. false includes text nodes in the search. Default value is false.

Return Value

Type: XMLNode
A XMLNode object that represents the first node that matches the XPath parameter in the document; nulla null reference (Nothing in Visual Basic) if no nodes matching the XPath parameter are found.

Remarks

Setting the FastSearchSkippingTextNodes parameter to true diminishes performance because Microsoft Office Word searches all nodes in a document against the text contained in the node.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

.NET Framework Security

See Also

Reference

Document Interface

Microsoft.Office.Tools.Word Namespace