FOM Reference > DOM Support > XPath Extensions > fxProcessingInstruction interface
  
fxProcessingInstruction interface
The 3b2 extension to the W3C DOM Level 2 ProcessingInstruction interface.
augFirstChild attribute
This property adds additional support for DOMs attached to an fTag.TYPE_XML_TREE stream.
This returns null.
augFirstChild
Access
read-only
Returns
Node
augLastChild attribute
This property adds additional support for DOMs attached to an fTag.TYPE_XML_TREE stream.
This returns null.
augLastChild
Access
read-only
Returns
Node
augNextSibling attribute
This property adds additional support for DOMs attached to an fTag.TYPE_XML_TREE stream.
This returns the node logically following this node within it's parent, including augmentation. The logical order is: Augmenation Before, Augmentation References, children, Augmenation After. Otherwise, this returns null.
augNextSibling
Access
read-only
Returns
Node
augParentNode attribute
This property adds additional support for DOMs attached to an fTag.TYPE_XML_TREE stream.
The parent of this node. If this node is at the root of augmentation, this returns the Node the augmentation is attached. Otherwise this returns the normal parent.
augParentNode
Access
read-only
Returns
Node
augPreviousSibling attribute
This property adds additional support for DOMs attached to an fTag.TYPE_XML_TREE stream.
This returns the node logically preceding this node within it's parent, including augmentation. The logical order is: Augmenation After, children, Augmentation References, Augmenation Before. Otherwise, this returns null.
augPreviousSibling
Access
read-only
Returns
Node
augRefererNode attribute
This property adds additional support for DOMs attached to a fTag.TYPE_XML_TREE type stream which has augmentation enabled.
If this node is within augmentation, this returns the Node which was used as the primary reference for this node. This will usually be the Node in which the augmenation is attached. If created to replace a matching context, this returns the node which matched. Otherwise, this returns itself.
augRefererNode
Access
read-only
Returns
Node
endContent attribute
Returns the content end position of the fxProcessingInstruction node in a XML stream.
endContent
Access
read-only
Returns
int
endPosition attribute
Returns the end position of the fxProcessingInstruction node in a XML stream.
endPosition
Access
read-only
Returns
int
extendedNodeType attribute
The 3b2 extension to the W3C DOM Level 2 xmlNode interface.
extendedNodeType
Access
read-only
Returns
unsigned short
hasAugmentation attribute
This property adds additional support for DOMs attached to an fTag.TYPE_XML_TREE stream. This returns fxNode.AUGMENTATION_NONE.
hasAugmentation
Access
read-only
Returns
int
namespacesInScope attribute
Pointer to associated namespace.
namespacesInScope
Access
read-only
Returns
fArray
nodeNumber attribute
Returns the id number of the fxProcessingInstruction node in a XML stream.
nodeNumber
Access
read-only
Returns
int
significantWhitespace attribute
3b2 node information ( x3b2NodeInfo) for handling whitespace.
significantWhitespace
Access
read-only
Returns
int
startContent attribute
Returns the content start position of the fxProcessingInstruction node in a XML stream.
startContent
Access
read-only
Returns
int
startPosition attribute
Returns the start position of the fxProcessingInstruction node in a XML stream.
startPosition
Access
read-only
Returns
int
validAttributes attribute
Uses the DTD to return the valid attributes of a node.
validAttributes
Access
read-only
Returns
String
validContent attribute
Uses the DTD to return the valid content of a node.
validContent
Access
read-only
Returns
String
withinAugmentation attribute
This property adds additional support for DOMs attached to an fTag.TYPE_XML_TREE stream. This returns true if the current node is within augmenation of an ancestor.
withinAugmentation
Access
read-only
Returns
boolean
augSerialize method
Serialize an augmented node to a string.
augSerializecontentOnlyprettyPrint
Parameters
booleancontentOnly
If false (the default), the name and attributes of the node are included in the serialization. If true, the name and attributes of the node are omitted. In both cases, all information from the nodes children is included
booleanprettyPrint
If true, will format the serialized augmented node. If contentOnly is true, then it will not format the augmented node.
Returns
String. The serialized version of the augmented node.
evaluateXPath method
Evaluates an XPath expression string.
evaluateXPathexpression
Parameters
Stringexpression
The XPath expression string to be parsed and evaluated.
Returns
XPathResult. The result of the evaluation of the XPath expression.
Throws
XPathException
INVALID_EXPRESSION_ERR: Raised if the expression is not legal according to the rules of the XPathEvaluator.
getNodePath method
Returns an absolute location path for the xmlNode.
getNodePathmode
Parameters
intmode
If not specified, or 0, the returned path uses expanded local-name and namespace-uri syntax for elements within namespaces.
If 1, the returned path uses the specifed prefix on elements within a namespace.
mode 0: /document/chapter[1]/section[5]/node()[ local-name()="title" and namespace-uri()="URN:example:urn" ]
mode 1: /document/chapter[1]/section[5]/ex:title
Returns
String. Returns the absolute location path to this xmlNode.
getPage method
 
getPage
Parameters
None
Returns
fPage
getUserString method
Retrieves the string associated to a key on the xmlNode. The string must first have been set to this node by calling setUserString with the same key.
getUserStringkey
Parameters
Stringkey
The key to the associated string.
Returns
String. The userString associated to the given key on this xmlNode, or NULL if there was none.
getXmlBase method
Used to search for the base URI for this xmlNode. It does not return the base URI for the document.
getXmlBase
Parameters
None
Returns
String. Returns the base URI string.
getXmlLang method
The default definition. This function normally searches for the language of the xmlElement node. This can not be set for the base xmlNode - the relevant derived class will redefine this function to set it.
getXmlLang
Parameters
None
Returns
String. In the default definition, returns an empty string.
getXmlSpace method
The default definition. This function normally searches for the space preserving behaviour of an xmlElement. This can not be set for the base xmlNode - the relevant derived classes will redefine this function to set it.
getXmlSpace
Parameters
None
Returns
String. In the default definition, returns -1.
hasNamespacesInScope method
Used to see if this node has a list of namespaces.
hasNamespacesInScope
Parameters
None
Returns
booleantrue if this node has a list of namespaces, false otherwise.
lookupNamespacePrefix method
Returns the URI associated with the prefix passed in. If the prefix is not associated with a namespace, or a prefix is not passed in, the method returns null.
lookupNamespacePrefixprefix
Parameters
Stringprefix
The prefix to search for.
Returns
String. Returns the associated namespace URI or null if none is found.
serialize method
Serialize the node to a string.
serializecontentOnlyprettyPrint
Parameters
booleancontentOnly
If false (the default), the name and attributes of the node are included in the serialization. If true, the name and attributes of the node are omitted. In both cases, all information from the nodes children is included
booleanprettyPrint
If true, will format the serialized node. If contentOnly is true, then it will not format the node.
Returns
String. The serialized version of the node.
setUserString method
Used to set the userString for a specific xmlNode.
setUserStringkeydata
Parameters
Stringkey
The key to associate the string to.
Stringdata
The string to associate to the given key, or NULL to remove any existing association to that key
Returns
String. The string previously associated to the given key on this node, or NULL if there was none.