OpenXmlReader Class

Reference

Definition

Namespace:: DocumentFormat.OpenXml

Assembly:: DocumentFormat.OpenXml.dll

Assembly:: DocumentFormat.OpenXml.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents the Open XML reader class.

public abstract class OpenXmlReader : IDisposable

type OpenXmlReader = class
    interface IDisposable

Public MustInherit Class OpenXmlReader
Implements IDisposable

Inheritance: Object
OpenXmlReader

Derived: DocumentFormat.OpenXml.OpenXmlDomReader

DocumentFormat.OpenXml.OpenXmlPartReader

Implements: IDisposable

Constructors

OpenXmlReader()	Initializes a new instance of the OpenXmlReader class.
OpenXmlReader(Boolean)	Initializes a new instance of the OpenXmlReader class using the supplied Boolean value.

Properties

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	When overridden in a derived class, gets a value that indicates whether the reader is positioned at the end of the stream.
HasAttributes	Gets a value that indicates whether the current node has any attributes.
IsEndElement	When overridden in a derived class, gets a value that indicates whether the current node is an element end.
IsMiscNode	When overridden in a derived class, gets a value that indicates whether the current node is a miscellaneous XML node (non element).
IsStartElement	When overridden in a derived class, gets a value that indicates whether the current node is an element start.
LocalName	When overridden in a derived class, gets the local name of the current node.
NamespaceDeclarations	Gets the namespace declarations of the current element.
NamespaceUri	When overridden in a derived class, gets the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned.
Prefix	When overridden in a derived class, gets the namespace prefix associated with the current node.
ReadMiscNodes	Gets a value that indicates 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.

Methods

Close()	Closes the reader.
Create(OpenXmlElement)	Creates an OpenXmlReader from the OpenXmlElement (travel the DOM tree).
Create(OpenXmlElement, Boolean)	Creates an OpenXmlReader from the OpenXmlElement (travel the DOM tree).
Create(OpenXmlPart)	Creates an OpenXmlReader from the specified OpenXmlPart.
Create(OpenXmlPart, Boolean)	Creates an OpenXmlReader from the specified OpenXmlPart and Boolean values.
Create(Stream)	Creates an OpenXmlReader from the specified part stream.
Create(Stream, Boolean)	Creates an OpenXmlReader from the specified part stream and Boolean values.
Dispose()	Closes the reader, and releases all resources.
Dispose(Boolean)	Closes the reader, and releases all resources.
GetText()	Gets the text of the element if the element is an OpenXmlLeafTextElement. Returns String.Empty for other elements.
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.
ThrowIfObjectDisposed()	Thrown if the object is disposed.

Applies to