XPath Property
Provides a way to point to a specific segment in the document.
Syntax
idocreader.getXPath([callback]) idocreader.setXPath( XPath, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getXPath([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setXPath([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
The path is a series of one or more segment 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 | The first segment of the current container with the given schema name |
name[i] | The i-th segment of the current container with the given schema-name |
[i] | The i-th segment of the current container |
[last()] | The last segment of the current container |
[last()-i] | The segment located at the last location minus i in the current container |
.. | The parent of the current container |
When XPath is set to a valid path, XSegment points to the name of the segment, with XChildren providing the number of children the segment has. The fields of the current segment are provided in the XFields collection.
This property is not available at design time.
Data Type
String