XmlScanner ClassA Sandcastle Documented Class Library

Scans an XML document and returns significant segments, one by one. Segments are (returned properties within parentheses):

  • Attribute (name and value)
  • Characters (text)
  • End tag
  • End of document

Remember to call the

close
method when the scanner will no longer be used. This frees resources used by the scanner.

Inheritance Hierarchy

SystemObject
  Apptus.Util.XmlXmlScanner

Namespace:  Apptus.Util.Xml
Assembly:  Apptus.Esales.ConnectorApi (in Apptus.Esales.ConnectorApi.dll) Version: 4.3.0
Syntax

C#
public class XmlScanner

The XmlScanner type exposes the following members.

Constructors

  NameDescription
Public methodXmlScanner(Stream)
Creates an XML scanner that scans the supplied input stream, positions the scanner on the first significant segment.
Public methodXmlScanner(TextReader)
Creates an XML scanner that scans the supplied reader, positions the scanner on the first significant segment.
Top
Methods

  NameDescription
Public methodAttribute
Returns an Attribute holding the name and value of the current attribute, if such exists. Otherwise returns null.
Public methodCharacters
If the current segment is a characters segment, then returns the entire text as a string and moves to the next segment. Otherwise, returns an empty string.
Public methodEndTag
If the current segment is an end tag with the given name, then moves to the next segment. Otherwise, throws an exception.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodStartTag
If the current segment is a start tag, then returns the name of the tag and moves to the next segment. Otherwise, returns null.
Public methodToString (Inherited from Object.)
Top
See Also

Reference