DocumentBase.SelectSingleNode Method
Returns a Microsoft.Office.Interop.Word.XMLNode object that represents the first node in the document that matches the XPath parameter.
Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)
Syntax
'Declaration
Public Function SelectSingleNode ( _
xPath As String, _
prefixMapping As String, _
fastSearchSkippingTextNodes As Boolean _
) As XMLNode
public XMLNode SelectSingleNode(
string xPath,
string prefixMapping,
bool fastSearchSkippingTextNodes
)
Parameters
xPath
Type: System.StringA valid XPath string. For more information about XPath, see XPath Reference.
prefixMapping
Type: System.StringProvides 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.Booleantrue skips all text nodes while searching for the specified node. false includes text nodes in the search. Default value is false.
Return Value
Type: Microsoft.Office.Interop.Word.XMLNode
A Microsoft.Office.Interop.Word.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.
Examples
The following code example demonstrates how to specify the XPath and PrefixMapping parameters when calling the SelectSingleNode method. To use this example, run it from the ThisDocument class in a document-level project.
Private Sub DocumentSelectSingleNode()
If Me.XMLSchemaReferences.Count > 0 Then
Dim XPath As String = "/x:catalog/x:book/x:title"
Dim PrefixMapping As String = "xmlns:x=""" + _
Me.XMLSchemaReferences(1).NamespaceURI + """"
Dim node As Word.XMLNode = Me.SelectSingleNode(XPath, _
PrefixMapping, True)
Else
MessageBox.Show("The document does not contain a " + _
"schema reference.")
End If
End Sub
private void DocumentSelectSingleNode()
{
if (this.XMLSchemaReferences.Count > 0)
{
string XPath = "/x:catalog/x:book/x:title";
object key = 1;
string PrefixMapping = "xmlns:x=\"" +
this.XMLSchemaReferences.get_Item(ref key).NamespaceURI +
"\"";
Word.XMLNode node = this.SelectSingleNode(XPath,
PrefixMapping, true);
}
else
{
MessageBox.Show("The document does not contain a " +
"schema reference.");
}
}
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.