OpenXmlDomReader 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 document reader class.

public class OpenXmlDomReader : DocumentFormat.OpenXml.OpenXmlReader
type OpenXmlDomReader = class
    inherit OpenXmlReader
Public Class OpenXmlDomReader
Inherits OpenXmlReader
Inheritance
Object
OpenXmlReader
OpenXmlDomReader

Constructors

OpenXmlDomReader(OpenXmlElement)

Initializes a new instance of the OpenXmlDomReader class.
OpenXmlDomReader(OpenXmlElement, Boolean)

Initializes a new instance of the OpenXmlDomReader class using the supplied OpenXmlElement and Boolean values.

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 strong typed class of the current element.
Encoding

Gets the encoding of the XML file.

(Inherited from OpenXmlReader)
EOF

Gets a value that indicates whether the reader is positioned at the end of the stream.
HasAttributes

Gets a value indicating whether the current node has any attributes.

(Inherited from OpenXmlReader)
IsEndElement

Gets a value that indicates whether the current node is an element end.
IsMiscNode

Gets a value that indicates whether the current node is a miscellaneous XML node (non element).
IsStartElement

Gets a value that indicates 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.

(Inherited from OpenXmlReader)
StandaloneXml

Gets the standalone property in the XML declaration of the XML stream. The default value is null.

(Inherited from OpenXmlReader)

Methods

Close()

Closes the reader.
Dispose()

Closes the reader, and releases all resources.

(Inherited from OpenXmlReader)
Dispose(Boolean)

Closes the reader, and releases all resources.

(Inherited from OpenXmlReader)
GetLineInfo()

Gets an instance of IXmlLineInfo if available for the current reader.

(Inherited from OpenXmlReader)
GetText()

Gets the text of the element if the element is an OpenXmlLeafTextElement. Returns String.Empty for other elements.
LoadCurrentElement()

Loads the element at the 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 children of the current node.
ThrowIfObjectDisposed()

Thrown if the object is disposed.

(Inherited from OpenXmlReader)

Applies to