x_path Property

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

Syntax

def get_x_path() -> str: ...
def set_x_path(value: str) -> None: ...

x_path = property(get_x_path, set_x_path)

Default Value

""

Remarks

x_path 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 x_path location.

The following are possible values for an element accessor:

When x_path is set to a valid path, x_element points to the name of the element, with x_children and x_text 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 has_x_path method to determine if an xpath exists before setting the x_path property.