System::Xml Namespace Reference

Namespaces

 Schema
 Represents an exception that is thrown when an error occurs during parsing of XML schema.
 
 Serialization
 
 XPath
 Represents an exception that is thrown when an error occurs during parsing of XPath expression.
 
 Xsl
 

Classes

class  IXmlNamespaceResolver
 Provides read access to a set of namespace and prefix mappings. More...
 
class  NameTable
 Provides single-threaded implementation of XmlNameTable. More...
 
class  XmlAttribute
 Represents an attribute associtaed with an xml element. More...
 
class  XmlAttributeCollection
 Represents a collection of XML attributes. More...
 
class  XmlCDataSection
 Represents a CDATA section. More...
 
class  XmlCharacterData
 Serves as a base class for several classes that represent XML nodes that represent sequences of characters. More...
 
class  XmlComment
 Represents an XML comment node. More...
 
class  XmlConvert
 Contains methods for encoding and decoding XML names and methods for converting between C++ types and XSD types. More...
 
class  XmlDeclaration
 Represents an XML declaration node. More...
 
class  XmlDocument
 Represents an XML document. More...
 
class  XmlDocumentFragment
 Represents a service oject that is useful for tree insert operations. More...
 
class  XmlDocumentType
 Represents the XML document type declaration node. More...
 
class  XmlElement
 Represents an XML element node. More...
 
class  XmlNamedNodeMap
 Represents a collection of XML nodes that can be accessed by index or name. More...
 
class  XmlNamespaceManager
 Represents a collection of XML namespaces and provides scope management for them. More...
 
class  XmlNameTable
 Represents a table of string objects. More...
 
class  XmlNode
 Represents an XML node. More...
 
class  XmlNodeChangedEventArgs
 Represents information about XML node events. More...
 
class  XmlNodeList
 Represents a list of XML nodes. More...
 
class  XmlNodeReader
 Provides non-cached forward-only access to data in an XML node. More...
 
class  XmlParserContext
 Represents context information required by the XmlReader to parse an XML fragment. More...
 
class  XmlProcessingInstruction
 Represents the XML processing instruction node. More...
 
class  XmlReader
 Provides non-cached forward-only access to XML data. More...
 
class  XmlReaderSettings
 Specifies a set of features to support on the XmlReader object created by the Create method. More...
 
class  XmlResolver
 Resolves external XML resources specified by URI. More...
 
class  XmlText
 Represents the text content of an XML element or attribute. More...
 
class  XmlTextReader
 Provides non-cached forward-only access to XML data. More...
 
class  XmlTextWriter
 Represents a non-cached, forward-only writer way of generating streams or files containing XML data. More...
 
class  XmlUrlResolver
 Resolves external XML resources specified by URL. More...
 
class  XmlWriter
 Represents a writer that provides a non-cached, forward-only way to generate XML data. More...
 
class  XmlWriterSettings
 Specifies a set of features to support on the XmlWriter object created by the Create() method. More...
 

Typedefs

typedef System::Collections::Generic::IEnumerable< XmlAttribute::PtrIAttributeEnumerable
 
typedef System::Collections::Generic::IEnumerator< XmlAttribute::PtrIAttrubuteEnumerator
 
typedef SharedPtr< IAttributeEnumerableIAttrubuteEnumerablePtr
 
typedef SharedPtr< IAttrubuteEnumeratorIAttributeEnumeratorPtr
 
typedef std::function< void(SharedPtr< Object >, SharedPtr< XmlNodeChangedEventArgs >)> XmlNodeChangedEventHandler
 An alias for a function object type that is used to handle XML node change events. More...
 
typedef System::Event< void(SharedPtr< Object >, SharedPtr< XmlNodeChangedEventArgs >)> XmlNodeChangedEventSignal
 An alias for an event type that signals that an XML node has been changed. More...
 
typedef System::Collections::Generic::IEnumerable< XmlNode::PtrIXmlNodeEnumerable
 
typedef System::Collections::Generic::IEnumerator< XmlNode::PtrIXmlNodeEnumerator
 

Enumerations

enum  ConformanceLevel { ConformanceLevel::Auto, ConformanceLevel::Document, ConformanceLevel::Fragment }
 Specifies how much input/output checking objects of XmlReader and XmlWriter classes perform. More...
 
enum  DtdProcessing { DtdProcessing::Prohibit = 0, DtdProcessing::Ignore = 1, DtdProcessing::Parse = 2 }
 Specifies the options for processing DTDs. More...
 
enum  EntityHandling { EntityHandling::ExpandEntities = 1, EntityHandling::ExpandCharEntities = 2 }
 Specifies how the entities are handled by XmlTextReader or XmlValidatingReader objects. More...
 
enum  Formatting { Formatting::None = 0, Formatting::Indented = 1 }
 Specifies the formatting options. More...
 
enum  NewLineHandling { NewLineHandling::Replace = 0, NewLineHandling::Entitize = 1, NewLineHandling::None = 2 }
 Specifies how the line breaks are handled. More...
 
enum  ValidationType {
  ValidationType::None, ValidationType::Auto, ValidationType::DTD, ValidationType::XDR,
  ValidationType::Schema
}
 Specifies the validation type. More...
 
enum  WhitespaceHandling { WhitespaceHandling::All = 0, WhitespaceHandling::Significant = 1, WhitespaceHandling::None = 2 }
 Specifies how to handle the white spaces. More...
 
enum  XmlDateTimeSerializationMode { XmlDateTimeSerializationMode::Local = 0, XmlDateTimeSerializationMode::Utc = 1, XmlDateTimeSerializationMode::Unspecified = 2, XmlDateTimeSerializationMode::RoundtripKind = 3 }
 Specifies how to treat the time value when converting between string and System::DateTime. More...
 
enum  XmlNamespaceScope { XmlNamespaceScope::All, XmlNamespaceScope::ExcludeXml, XmlNamespaceScope::Local }
 Specifies the namespace scope. More...
 
enum  XmlNodeChangedAction { XmlNodeChangedAction::Insert = 0, XmlNodeChangedAction::Remove = 1, XmlNodeChangedAction::Change = 2 }
 Specifies the type of XML node change. More...
 
enum  XmlNodeType {
  XmlNodeType::None = 0, XmlNodeType::Element = 1, XmlNodeType::Attribute = 2, XmlNodeType::Text = 3,
  XmlNodeType::CDATA = 4, XmlNodeType::EntityReference = 5, XmlNodeType::Entity = 6, XmlNodeType::ProcessingInstruction = 7,
  XmlNodeType::Comment = 8, XmlNodeType::Document = 9, XmlNodeType::DocumentType = 10, XmlNodeType::DocumentFragment = 11,
  XmlNodeType::Notation = 12, XmlNodeType::Whitespace = 13, XmlNodeType::SignificantWhitespace = 14, XmlNodeType::EndElement = 15,
  XmlNodeType::EndEntity = 16, XmlNodeType::XmlDeclaration = 17
}
 Specifies an XML node type. More...
 
enum  XmlOutputMethod { XmlOutputMethod::Xml = 0, XmlOutputMethod::Html = 1, XmlOutputMethod::Text = 2, XmlOutputMethod::AutoDetect = 3 }
 Specifies the method of XmlWriter output serialization. More...
 
enum  ReadState {
  ReadState::Initial = 0, ReadState::Interactive = 1, ReadState::Error = 2, ReadState::EndOfFile = 3,
  ReadState::Closed = 4
}
 Indicates XmlReader's state. More...
 
enum  XmlSpace { XmlSpace::None = 0, XmlSpace::Default = 1, XmlSpace::Preserve = 2 }
 Specifies xml:space scope. More...
 
enum  LibxmlError { LIBXML_ER = -1, LIBXML_OK = XML_ERR_OK }
 Specifies the status of a libxml2 operation. More...
 
enum  WriteState {
  WriteState::Start = 0, WriteState::Prolog = 1, WriteState::Element = 2, WriteState::Attribute = 3,
  WriteState::Content = 4, WriteState::Closed = 5, WriteState::Error = 6
}
 Indicates XmlWriter's state. More...
 

Functions

 DECLARE_INHERITED_EXCEPTION (XmlException, SystemException)
 Represents a general exception that is thrown when XML-related errors occur, such as failure to parse invalid XML content. More...
 

Typedef Documentation

◆ IAttributeEnumerable

◆ IAttributeEnumeratorPtr

◆ IAttrubuteEnumerablePtr

◆ IAttrubuteEnumerator

◆ IXmlNodeEnumerable

◆ IXmlNodeEnumerator

◆ XmlNodeChangedEventHandler

An alias for a function object type that is used to handle XML node change events.

◆ XmlNodeChangedEventSignal

An alias for an event type that signals that an XML node has been changed.

Enumeration Type Documentation

◆ ConformanceLevel

Specifies how much input/output checking objects of XmlReader and XmlWriter classes perform.

Enumerator
Auto 

Auto.

Document 

Document-level checking.

Fragment 

Fragment-level checking.

◆ DtdProcessing

Specifies the options for processing DTDs.

Enumerator
Prohibit 

Specifies that when a DTD is encountered, an System.Xml.XmlException is thrown with a message that states that DTDs are prohibited. This is the default behavior.

Ignore 

Causes the DOCTYPE element to be ignored. No DTD processing occurs.

Parse 

Used for parsing DTDs.

◆ EntityHandling

Specifies how the entities are handled by XmlTextReader or XmlValidatingReader objects.

Enumerator
ExpandEntities 

Expand all entities.

ExpandCharEntities 

Expand character entities and return general entities as nodes of EntityReference type.

◆ Formatting

Specifies the formatting options.

Enumerator
None 

No special formatting.

Indented 

Indent child elements according to the System.Xml.XmlTextWriter.Indentation and System.Xml.XmlTextWriter.IndentChar settings.

◆ LibxmlError

Specifies the status of a libxml2 operation.

Enumerator
LIBXML_ER 

Error.

LIBXML_OK 

Success.

◆ NewLineHandling

Specifies how the line breaks are handled.

Enumerator
Replace 

The new line characetrs are replaced by the specified character.

Entitize 

The new line characters are entitized.

None 

The new line characters are not changed.

◆ ReadState

Indicates XmlReader's state.

Enumerator
Initial 

The Read method has not been called yet.

Interactive 

Reading is in progress.

Error 

An error occurred that prevents the XmlReader from continuing.

EndOfFile 

The end of the stream has been reached successfully.

Closed 

The Close() method has been called and the XmlReader object is closed.

◆ ValidationType

Specifies the validation type.

Enumerator
None 

No validation.

Auto 

Validate if schema or DTD information is found.

DTD 

Validate according to DTD.

XDR 

Validate according to XDR schemas.

Schema 

Validate according to XSD schemas.

◆ WhitespaceHandling

Specifies how to handle the white spaces.

Enumerator
All 

Return SignificantWhitespace and Whitespace nodes. This option is default.

Significant 

Return only SignificantWhitespace nodes.

None 

Don't return Whitespace and SignificantWhitespace nodes.

◆ WriteState

Indicates XmlWriter's state.

Enumerator
Start 

A Write() method has not been called yet.

Prolog 

The prolog is being written.

Element 

A start tag of an element is being written.

Attribute 

A value of an attribute is being written.

Content 

Content of an element is being written.

Closed 

Method XmlWriter::Close() has been called.

Error 

An exception has been thrown leaving the System::Xml::XmlWriter in an invalid state. System::Xml::XmlWriter::Close() method can be called to put the System::Xml::XmlWriter in the System::Xml::WriteState::Closed state. Any other System::Xml::XmlWriter method calls result in an System::InvalidOperationException being thrown.

◆ XmlDateTimeSerializationMode

Specifies how to treat the time value when converting between string and System::DateTime.

Enumerator
Local 

The time value represents a local time.

Utc 

The time value represents a UTC time.

Unspecified 

The time value represents a local time if a System::DateTime object is being converted to a string.

RoundtripKind 

Preserve the time zone information when converting.

◆ XmlNamespaceScope

Specifies the namespace scope.

Enumerator
All 

The scope includes all namespaces defined in the scope of the current XML node.

ExcludeXml 

The scope includes all namespaces defined in the scope of the current XML node excluding xmlns:xml.

Local 

The scope includes all namespaces defined locally at the current XML node.

◆ XmlNodeChangedAction

Specifies the type of XML node change.

Enumerator
Insert 

An XML node has been inserted in a nodes tree.

Remove 

An XML node has been removed from a nodes tree.

Change 

A node's value has been changed.

◆ XmlNodeType

Specifies an XML node type.

Enumerator
None 

This is returned by the System::Xml::XmlReader if a Read method has not been called.

Element 

An element.

Attribute 

An attribute.

Text 

The text content of a node.

CDATA 

A CDATA section.

EntityReference 

A reference to an entity.

Entity 

An entity declaration.

ProcessingInstruction 

A processing instruction.

Comment 

A comment.

Document 

A document object that, as the root of the document tree, provides access to the entire XML document.

DocumentType 

The document type declaration.

DocumentFragment 

A document fragment.

Notation 

A notation in the document type declaration.

Whitespace 

White space between markup.

SignificantWhitespace 

White space between markup in a mixed content model or white space within the xml:space="preserve" scope.

EndElement 

An end tag of an element.

EndEntity 

Returned when XmlReader gets to the end of the entity replacement as a result of a call to System::Xml::XmlReader::ResolveEntity().

XmlDeclaration 

The XML declaration.

◆ XmlOutputMethod

Specifies the method of XmlWriter output serialization.

Enumerator
Xml 

Serialize according to the rules of XML 1.0.

Html 

Serialize according to the rules of HTML specified by XSLT.

Text 

Serialize only text blocks.

AutoDetect 

Follow the XSLT rules to choose between the Xml and Html output methods at runtime.

◆ XmlSpace

enum System::Xml::XmlSpace
strong

Specifies xml:space scope.

Enumerator
None 

No xml:space scope.

Default 

The xml:space scope equals default.

Preserve 

The xml:space scope equals preserve.

Function Documentation

◆ DECLARE_INHERITED_EXCEPTION()

System::Xml::DECLARE_INHERITED_EXCEPTION ( XmlException  ,
SystemException   
)

Represents a general exception that is thrown when XML-related errors occur, such as failure to parse invalid XML content.