XPath Property

Provides a way to point to a specific element in the document.

Syntax

C#
VB.NET

public string XPath { get; set; }

Public Property XPath As String

Default Value

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML response.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:


'name'	A particular element name.
[i]	The i-th subelement of the current element, starting at index 1.
..	the parent of the current element.

When XPath is set to a valid path, XElement points to the name of the element, with XChildren and XText providing other properties of the element.

Example (Setting XPath)


 Document root    QBObjectControl.XPath = "/"
 Specific Element QBObjectControl.XPath = "/root/SubElement1/SubElement2/"
 i-th Child       QBObjectControl.XPath = "/root/[i]"

You may use the HasXPath method to determine if an xpath exists before setting the XPath property.

This property is not available at design time.

QuickBooks Integrator 2020 .NET Edition

XPath Property

Syntax

Default Value

Remarks