OpenXmlReader Class

Represents the Open XML reader class.

Inheritance Hierarchy

SystemObject
  DocumentFormat.OpenXmlOpenXmlReader
    DocumentFormat.OpenXmlOpenXmlDomReader
    DocumentFormat.OpenXmlOpenXmlPartReader

Namespace: DocumentFormat.OpenXml
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll) Version: 2.20.0+Branch.release-v2.20.0.Sha.a873d3fbff9bffe179fea62486da950adf5be65d.a873d3fbff9bffe179fea62486da950adf5be65d

Syntax

C++

Copy

public abstract class OpenXmlReader : IDisposable

Public MustInherit Class OpenXmlReader
	Implements IDisposable

public ref class OpenXmlReader abstract : IDisposable

[<AbstractClassAttribute>]
type OpenXmlReader = 
    class
        interface IDisposable
    end

The OpenXmlReader type exposes the following members.

Properties

	Name	Description
	Attributes	Gets the list of attributes of the current element.
	Depth	Gets the depth of the current node in the XML document. The depth of the root element is 0.
	ElementType	Gets the type of the corresponding strongly typed class of the current element.
	Encoding	Gets the encoding of the XML file.
	EOF	Gets a value indicating whether the reader is positioned at the end of the stream.
	HasAttributes	Gets a value indicating whether the current node has any attributes.
	IsEndElement	Gets a value indicating whether the current node is an element end.
	IsMiscNode	Gets a value indicating whether the current node is a miscellaneous XML node (non element).
	IsStartElement	Gets a value indicating whether the current node is an element start.
	LocalName	Gets the local name of the current node.
	NamespaceDeclarations	Gets the namespace declarations of the current element.
	NamespaceUri	Gets the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned.
	Prefix	Gets the namespace prefix associated with the current node.
	ReadMiscNodes	Gets a value indicating whether the OpenXmlReader will read or skip all miscellaneous nodes.
	StandaloneXml	Gets the standalone property in the XML declaration of the XML stream. The default value is null.

Top

Methods

	Name	Description
	Close	Closes the reader.
	Create(OpenXmlElement)	Creates an OpenXmlReader from the OpenXmlElement (travel the DOM tree).
	Create(OpenXmlPart)	Creates an OpenXmlReader from the specified OpenXmlPart.
	Create(Stream)	Creates an OpenXmlReader from the specified part stream. Obsolete
	Create(OpenXmlElement, Boolean)	Creates an OpenXmlReader from the OpenXmlElement (travel the DOM tree).
	Create(OpenXmlPart, Boolean)	Creates an OpenXmlReader from the specified OpenXmlPart and Boolean values.
	Create(Stream, Boolean)	Creates an OpenXmlReader from the specified part stream and Boolean values. Obsolete
	Create(OpenXmlPart, Boolean, Boolean)	Creates an OpenXmlReader from the specified OpenXmlPart and Boolean values.
	Create(Stream, Boolean, Boolean)	Creates an OpenXmlReader from the specified part stream and Boolean values. Obsolete
	Dispose	Closes the reader, and releases all resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetLineInfo	Gets an instance of IXmlLineInfo if available for the current reader.
	GetText	Gets the text of the element if the element is an OpenXmlLeafTextElement. Returns String.Empty for other elements.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	LoadCurrentElement	Loads the element at current cursor.
	Read	Moves to read the next element.
	ReadFirstChild	Moves to read the first child element.
	ReadNextSibling	Moves to read the next sibling element.
	Skip	Skips the child elements of the current node.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Reference

DocumentFormat.OpenXml Namespace