OpenXmlPart Class

Definition

Represents an abstract base class for all OpenXml parts.

public abstract class OpenXmlPart : DocumentFormat.OpenXml.Packaging.OpenXmlPartContainer
type OpenXmlPart = class
    inherit OpenXmlPartContainer
Public MustInherit Class OpenXmlPart
Inherits OpenXmlPartContainer
Inheritance
Derived

Constructors

OpenXmlPart()

Create an instance of OpenXmlPart

Properties

ContentType

Gets the content type (MIME type) of the content data in the part.

DataPartReferenceRelationships

Gets all DataPartReferenceRelationship relationships.

(Inherited from OpenXmlPartContainer)
ExternalRelationships

Gets all external relationships. Hyperlink relationships are not included, use HyperlinkRelationship property to enumerate hyperlink relationships.

(Inherited from OpenXmlPartContainer)
Features

Gets the features associated with this part.

Features

Gets the features associated with this part.

(Inherited from OpenXmlPartContainer)
HyperlinkRelationships

Gets all hyperlink relationships.

(Inherited from OpenXmlPartContainer)
IsRootElementLoaded

Gets a value indicating whether the root element is loaded from the part or it has been set.

OpenXmlPackage

Gets the OpenXmlPackage which contains the current part.

Parts

Gets all parts which are relationship targets of this part.

(Inherited from OpenXmlPartContainer)
RelationshipType

Gets the relationship type of the part.

RootElement

Gets the root element of the current part. Returns null when the current part is empty or is not an XML content type.

Uri

Gets the internal part path in the package.

Methods

AddAnnotation(Object)

Adds an object to the annotation list of this PartContainer.

(Inherited from OpenXmlPartContainer)
AddExtendedPart(String, String, String, String)

Adds an extended part ( Application specific part ).

(Inherited from OpenXmlPartContainer)
AddExtendedPart(String, String, String)

Adds an extended part ( Application specific part ).

(Inherited from OpenXmlPartContainer)
AddExternalRelationship(String, Uri, String)

Adds an external relationship. Do not add hyperlink relationships through this method. Use AddHyperlinkRelationship() instead.

(Inherited from OpenXmlPartContainer)
AddExternalRelationship(String, Uri)

Adds an external relationship. Do not add hyperlink relationships through this method. Use AddHyperlinkRelationship() instead.

(Inherited from OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean, String)

Adds a new hyperlink relationship.

(Inherited from OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean)

Adds a new hyperlink relationship.

(Inherited from OpenXmlPartContainer)
AddNewPart<T>()

Adds a new part of type T.

(Inherited from OpenXmlPartContainer)
AddNewPart<T>(String, String)

Adds a new part of type T.

(Inherited from OpenXmlPartContainer)
AddNewPart<T>(String)

Adds a new part of type T.

(Inherited from OpenXmlPartContainer)
AddPart<T>(T, String)

Adds the part to the document with a given relationship identifier (ID). Must use the returned part to operate on the part added to the document

(Inherited from OpenXmlPartContainer)
AddPart<T>(T)

Adds the part to the document. Must use the returned part to operate on the part added to the document.

(Inherited from OpenXmlPartContainer)
Annotation(Type)

Get the first annotation object of the specified type from this PartContainer.

(Inherited from OpenXmlPartContainer)
Annotation<T>()

Get the first annotation object of the specified type from this PartContainer.

(Inherited from OpenXmlPartContainer)
Annotations(Type)

Gets a collection of annotations of the specified type for this PartContainer.

(Inherited from OpenXmlPartContainer)
Annotations<T>()

Gets a collection of annotations of the specified type for this PartContainer.

(Inherited from OpenXmlPartContainer)
ChangeIdOfPart(OpenXmlPart, String)

Changes the relationship ID of the part.

(Inherited from OpenXmlPartContainer)
CreateRelationshipToPart(OpenXmlPart, String)

Adds a relationship for the specified part to this part.

(Inherited from OpenXmlPartContainer)
CreateRelationshipToPart(OpenXmlPart)

Adds a relationship for the specified part to this part.

(Inherited from OpenXmlPartContainer)
DeleteExternalRelationship(ExternalRelationship)

Deletes the specified external relationship.

(Inherited from OpenXmlPartContainer)
DeleteExternalRelationship(String)

Deletes the specified ExternalRelationship.

(Inherited from OpenXmlPartContainer)
DeletePart(OpenXmlPart)

Deletes a specified part in the package root layer.

(Inherited from OpenXmlPartContainer)
DeletePart(String)

Deletes the specified child part from this part.

(Inherited from OpenXmlPartContainer)
DeleteParts<T>(IEnumerable<T>)

Deletes all the parts which are in the passed in collection from the document.

(Inherited from OpenXmlPartContainer)
DeleteReferenceRelationship(ReferenceRelationship)

Deletes the specified reference relationship.

(Inherited from OpenXmlPartContainer)
DeleteReferenceRelationship(String)

Deletes the specified reference relationship.

(Inherited from OpenXmlPartContainer)
FeedData(Stream)

Feeds data into the part stream. The stream of the part will be truncated at first.

GetExternalRelationship(String)

Gets the specified ExternalRelationship.

(Inherited from OpenXmlPartContainer)
GetIdOfPart(OpenXmlPart)

Gets the relationship ID of the part.

(Inherited from OpenXmlPartContainer)
GetParentParts()

Enumerates all parents that reference this part anywhere in the document.

GetPartById(String)

Gets the child part through the relationship ID.

(Inherited from OpenXmlPartContainer)
GetPartsCountOfType<T>()
Obsolete.

Gets the count of all parts of type T.

(Inherited from OpenXmlPartContainer)
GetPartsOfType<T>()

Enumerates all the children parts of the specified type T of this part.

(Inherited from OpenXmlPartContainer)
GetPartsOfType<T>(ICollection<T>)
Obsolete.

Gets all the children parts of the specified type T into partCollection of this part.

(Inherited from OpenXmlPartContainer)
GetReferenceRelationship(String)

Gets the specified ReferenceRelationship.

(Inherited from OpenXmlPartContainer)
GetStream()

Returns the part content data stream.

GetStream(FileMode, FileAccess)

Returns the part content stream that was opened using a specified FileMode and FileAccess.

GetStream(FileMode)

Returns the content stream that was opened using a specified I/O FileMode.

RemoveAnnotations(Type)

Removes the annotations of the specified type from this PartContainer.

(Inherited from OpenXmlPartContainer)
RemoveAnnotations<T>()

Removes the annotations of the specified type from this PartContainer.

(Inherited from OpenXmlPartContainer)
ThrowIfObjectDisposed()

Indicates whether the object is already disposed.

TryGetPartById(String, OpenXmlPart)

Try to get the child part by the relationship ID.

(Inherited from OpenXmlPartContainer)
UnloadRootElement()

Unloads the RootElement.

ValidateXml(String, ValidationEventHandler)
Obsolete.

Validates the XML content of the part by using the specified schema.

ValidateXml(XmlSchemaSet, ValidationEventHandler)
Obsolete.

Validates the XML content of the part by using the specified schema.

Extension Methods

AddDisposableFeature(OpenXmlPart)
AddPartRootEventsFeature(OpenXmlPartContainer)

Adds a feature to track eventing for package life cycle events.

CreateUnknownElement(OpenXmlPartContainer, String)

Creates a new OpenXmlUnknownElement class by using the outer XML.

GetXDocument(OpenXmlPart)

Gets an XDocument representation of the part.

GetXElement(OpenXmlPart)

Gets an XElement representation of the part.

IsRootXElementLoaded(OpenXmlPart)

Gets a value indicating whether the root XElement is loaded from the part or it has been set.

SaveXDocument(OpenXmlPart)

Saves the current XDocument to the part if it and its Root element is not null.

SaveXElement(OpenXmlPart)

Saves the current XDocument to the part if it and its Root element is not null.

SetXDocument(OpenXmlPart, XDocument)

Sets the OpenXmlPart's XDocument to the given XDocument, serializes and writes the XDocument to the OpenXmlPart, and reloads the OpenXmlPart's OpenXmlPartRootElement if it was previously loaded.

SetXElement(OpenXmlPart, XElement)

Sets the OpenXmlPart's root XElement to the given XElement, serializes and writes the XElement to the OpenXmlPart, and reloads the OpenXmlPart's OpenXmlPartRootElement if it was previously loaded.

Applies to