OpenXmlPartRootXElementExtensions.GetXDocument(OpenXmlPart) Method

Definition

Namespace:

DocumentFormat.OpenXml.Packaging

Assembly:

DocumentFormat.OpenXml.Linq.dll

Package:

DocumentFormat.OpenXml.Linq v3.0.1

Gets an XDocument representation of the part.

public static System.Xml.Linq.XDocument GetXDocument (this DocumentFormat.OpenXml.Packaging.OpenXmlPart part);

static member GetXDocument : DocumentFormat.OpenXml.Packaging.OpenXmlPart -> System.Xml.Linq.XDocument

<Extension()>
Public Function GetXDocument (part As OpenXmlPart) As XDocument

Parameters

part

OpenXmlPart

The part to get the contents of.

Returns

XDocument

An XDocument.

Remarks

This method always returns the same XDocument instance, unless that instance is changed via SetXDocument(OpenXmlPart, XDocument). Calling this method has the same effect as calling part.GetXElement().Document.

When called with a given OpenXmlPart for the first time after having opened the containing OpenXmlPackage or saved the strongly-typed OpenXmlPartRootElement to the OpenXmlPart, deserializes, caches, and returns the outer XML of an already loaded OpenXmlPartRootElement or the content of the OpenXmlPart as an XDocument. In the following calls, directly returns the cached XDocument.

See also

• GetXElement(OpenXmlPart)
• SetXDocument(OpenXmlPart, XDocument)
• SaveXDocument(OpenXmlPart)