Export (0) Print
Expand All

OpenXmlElement class

Represents a base class that all elements in an Office Open XML document derive from. Represents a base class for all elements in an Office Open XML document.

Namespace:  DocumentFormat.OpenXml
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

'Declaration
Public MustInherit Class OpenXmlElement _
	Implements IEnumerable(Of OpenXmlElement), IEnumerable,  _
	ICloneable
'Usage
Dim instance As OpenXmlElement

Annotations will not be cloned when calling .Clone() and .CloneNode(bool)

The following code example shows how to access elements at the same level in a word-processing document. The test file used in the example contains the text “OpenXml Element.”

Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports DocumentFormat.OpenXml.Packaging
Imports DocumentFormat.OpenXml.Wordprocessing

Module Module1
    ' This code example shows how to access elements at the same level  
    ' in a word-processing document. 
    ' The example is using a file that contains the text "OpenXml Element."
    Sub Main()
        Dim fileName As String = "C:\Users\Public\Documents\AccessElementsSameLevel.docx"
        Using wordprocessingDocument As WordprocessingDocument = _
    wordprocessingDocument.Open(fileName, False)
            ' Create a Body object.
            Dim body As DocumentFormat.OpenXml.Wordprocessing.Body = _
    wordprocessingDocument.MainDocumentPart.Document.Body

            ' Create a Paragraph object.
            Dim firstParagraph As DocumentFormat.OpenXml.Wordprocessing.Paragraph = _
    body.Elements(Of Paragraph)().FirstOrDefault()

            ' Get the first child of an OpenXmlElement.
            Dim firstChild As DocumentFormat.OpenXml.OpenXmlElement = _
                firstParagraph.FirstChild
            Dim elementsAfter As IEnumerable(Of Run) = _
                firstChild.ElementsAfter().Where(Function(c) TypeOf c Is Run).Cast(Of Run)()

            ' Get the Run elements before/after the specified element.
            Console.WriteLine("Run elements after the first child are: ")
            For Each run As DocumentFormat.OpenXml.Wordprocessing.Run In elementsAfter
                Console.WriteLine(run.InnerText)
            Next
            Console.ReadKey()
        End Using
    End Sub
End Module
' Output:
' Run elements after the first child are:
' OpenXml
'  Element

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

Show:
© 2014 Microsoft