OpenXmlReader Class

  • Reference

Definition

Namespace:
DocumentFormat.OpenXml
Assembly:
DocumentFormat.OpenXml.dll
Assembly:
DocumentFormat.OpenXml.Framework.dll
Package:
DocumentFormat.OpenXml v2.10.0
Package:
DocumentFormat.OpenXml v2.10.1
Package:
DocumentFormat.OpenXml v2.11.0
Package:
DocumentFormat.OpenXml v2.11.1
Package:
DocumentFormat.OpenXml v2.11.2
Package:
DocumentFormat.OpenXml v2.11.3
Package:
DocumentFormat.OpenXml v2.12.0
Package:
DocumentFormat.OpenXml v2.12.1
Package:
DocumentFormat.OpenXml v2.12.2
Package:
DocumentFormat.OpenXml v2.12.3
Package:
DocumentFormat.OpenXml v2.13.0
Package:
DocumentFormat.OpenXml v2.13.1
Package:
DocumentFormat.OpenXml v2.14.0
Package:
DocumentFormat.OpenXml v2.15.0
Package:
DocumentFormat.OpenXml v2.16.0
Package:
DocumentFormat.OpenXml v2.17.1
Package:
DocumentFormat.OpenXml v2.18.0
Package:
DocumentFormat.OpenXml v2.19.0
Package:
DocumentFormat.OpenXml v2.20.0
Package:
DocumentFormat.OpenXml v2.7.1
Package:
DocumentFormat.OpenXml v2.7.2
Package:
DocumentFormat.OpenXml v2.8.0
Package:
DocumentFormat.OpenXml v2.8.1
Package:
DocumentFormat.OpenXml v2.9.0
Package:
DocumentFormat.OpenXml v2.9.1
Package:
DocumentFormat.OpenXml.Framework v3.0.0
Package:
DocumentFormat.OpenXml.Framework v3.0.1

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
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

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.

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(OpenXmlPart, Boolean, Boolean)

Creates an OpenXmlReader from the specified OpenXmlPart and Boolean values.
Create(Stream)
Obsolete.

Creates an OpenXmlReader from the specified part stream.
Create(Stream, Boolean)
Obsolete.

Creates an OpenXmlReader from the specified part stream and Boolean values.
Create(Stream, Boolean, Boolean)
Obsolete.

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.
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.
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