WorksheetBase.XmlDataQuery(String, Object, Object) Method

Definition

Namespace:

Microsoft.Office.Tools.Excel

Assembly:

Microsoft.Office.Tools.Excel.v4.0.Utilities.dll

Gets a Range object that represents the cells mapped to a particular XPath. Gets null if the specified XPath has not been mapped to the worksheet, or if the mapped range is empty.

public Microsoft.Office.Interop.Excel.Range XmlDataQuery (string xPath, object selectionNamespaces, object map);

member this.XmlDataQuery : string * obj * obj -> Microsoft.Office.Interop.Excel.Range

Public Function XmlDataQuery (xPath As String, Optional selectionNamespaces As Object, Optional map As Object) As Range

Parameters

xPath

String

The XPath to query for.

selectionNamespaces

Object

A space-delimited string that contains the namespaces referenced in the XPath parameter. A run-time error is generated if one of the specified namespaces cannot be resolved.

map

Object

An XmlMap. Specify an XML map if you want to query for the XPath within a specific map.

Returns

Range

A Range object that represents the cells mapped to a particular XPath; null if the specified XPath has not been mapped to the worksheet, or if the mapped range is empty.

Examples

The following code example uses the XmlDataQuery method to get the Range of cells mapped to a particular XPath.

This example is for a document-level customization.

private void WorksheetQueryXmlData()
{
    string path = "/order/customer/address";
    string namespaces = "xmlns=http://www.contoso.com/orders";
    
    Excel.Range range1 = this.XmlDataQuery(path, namespaces);

    if (range1 == null)
    {
        MessageBox.Show("The specified XPath: '" + path + 
            "' has not been mapped to the worksheet, or the mapped " +
            "range is empty.");
    }
}

Private Sub WorksheetQueryXmlData()
    Dim path As String = "/order/customer/address"
    Dim namespaces As String = "xmlns=http://www.contoso.com/orders"

    Dim range1 As Excel.Range = _
        Me.XmlDataQuery(path, namespaces)

    If range1 Is Nothing Then
        MsgBox("The specified XPath: '" & path & _
            "' has not been mapped to the worksheet, or the mapped " & _
                "range is empty.")
    End If
End Sub

Remarks

XML features, except for saving files in the XML Spreadsheet format, are available only in Microsoft Office Professional Edition 2003 and Microsoft Office Excel 2003.

If the XPath exists within a column in an XML list, the Range object returned does not include the header row or the Insert row.

Optional Parameters

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