System::Xml::XPath Namespace Reference

Classes

class  Details_XPathException
 Provides the exception thrown when an error occurs while processing an XPath expression.
 
class  IXPathNavigable
 Provides an accessor to the XPathNavigator class. More...
 
class  XPathDocument
 Provides a fast, read-only, in-memory representation of an XML document by using the XPath data model. More...
 
class  XPathExpression
 Provides a typed class that represents a compiled XPath expression. More...
 
class  XPathItem
 Represents an item in the XQuery 1.0 and XPath 2.0 Data Model. More...
 
class  XPathNavigator
 Provides a cursor model for navigating and editing XML data. More...
 
class  XPathNodeIterator
 Provides an iterator over a selected set of nodes. More...
 

Typedefs

using XPathException = System::ExceptionWrapper< Details_XPathException >
 

Enumerations

enum  XmlSortOrder { XmlSortOrder::Ascending = 1, XmlSortOrder::Descending = 2 }
 Specifies the sort order. More...
 
enum  XmlCaseOrder { XmlCaseOrder::None = 0, XmlCaseOrder::UpperFirst = 1, XmlCaseOrder::LowerFirst = 2 }
 Specifies the sort order for uppercase and lowercase letters. More...
 
enum  XmlDataType { XmlDataType::Text = 1, XmlDataType::Number = 2 }
 Specifies the data type used to determine sort order. More...
 
enum  XPathResultType {
  XPathResultType::Number = 0, XPathResultType::String = 1, XPathResultType::Boolean = 2, XPathResultType::NodeSet = 3,
  XPathResultType::Navigator = static_cast<int32_t>(XPathResultType::String), XPathResultType::Any = 5, XPathResultType::Error
}
 Specifies the return type of the XPath expression. More...
 
enum  XPathNamespaceScope { XPathNamespaceScope::All, XPathNamespaceScope::ExcludeXml, XPathNamespaceScope::Local }
 Defines the namespace scope. More...
 
enum  XPathNodeType {
  XPathNodeType::Root, XPathNodeType::Element, XPathNodeType::Attribute, XPathNodeType::Namespace,
  XPathNodeType::Text, XPathNodeType::SignificantWhitespace, XPathNodeType::Whitespace, XPathNodeType::ProcessingInstruction,
  XPathNodeType::Comment, XPathNodeType::All
}
 Defines the XPath node types that can be returned from the XPathNavigator class. More...
 

Typedef Documentation

◆ XPathException

using System::Xml::XPath::XPathException = typedef System::ExceptionWrapper<Details_XPathException>

Enumeration Type Documentation

◆ XmlCaseOrder

Specifies the sort order for uppercase and lowercase letters.

Enumerator
None 

Ignore the case.

UpperFirst 

Uppercase letters are sorted before lowercase letters.

LowerFirst 

Lowercase letters are sorted before uppercase letters.

◆ XmlDataType

Specifies the data type used to determine sort order.

Enumerator
Text 

Values are sorted alphabetically.

Number 

Values are sorted numerically.

◆ XmlSortOrder

Specifies the sort order.

Enumerator
Ascending 

Nodes are sorted in ascending order. For example, if the numbers 1,2,3, and 4 are sorted in ascending order, they appear as 1,2,3,4.

Descending 

Nodes are sorted in descending order. For example, if the numbers 1,2,3, and 4 are sorted in descending order, they appear as, 4,3,2,1.

◆ XPathNamespaceScope

Defines the namespace scope.

Enumerator
All 

Returns all namespaces defined in the scope of the current node. This includes the xmlns:xml namespace which is always declared implicitly. The order of the namespaces returned is not defined.

ExcludeXml 

Returns all namespaces defined in the scope of the current node, excluding the xmlns:xml namespace. The xmlns:xml namespace is always declared implicitly. The order of the namespaces returned is not defined.

Local 

Returns all namespaces that are defined locally at the current node.

◆ XPathNodeType

Defines the XPath node types that can be returned from the XPathNavigator class.

Enumerator
Root 

The root node of the XML document or node tree.

Element 

An element, such as <element>.

Attribute 

An attribute, such as id='123'.

Namespace 

A namespace, such as xmlns="namespace".

Text 

The text content of a node. Equivalent to the Document Object Model (DOM) Text and CDATA node types. Contains at least one character.

SignificantWhitespace 

A node with white space characters and xml:space set to preserve.

Whitespace 

A node with only white space characters and no significant white space. White space characters are '\x20', '\x0d', '\x0a', '\x09'.

ProcessingInstruction 

A processing instruction, such as <?pi test?>. This does not include XML declarations, which are not visible to the XPathNavigator class.

Comment 

A comment, such as .

All 

Any of the XPathNodeType node types.

◆ XPathResultType

Specifies the return type of the XPath expression.

Enumerator
Number 

A numeric value.

String 

A String value.

Boolean 

A Boolean true or false value.

NodeSet 

A node collection.

Navigator 

A tree fragment.

Any 

Any of the XPath node types.

Error 

The expression does not evaluate to the correct XPath type.