OpenXmlPackage Members

Include Protected Members
Include Inherited Members

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Defines a base class for the strong typed Open XML document class.

The OpenXmlPackage type exposes the following members.

Constructors

 

Name

Description

OpenXmlPackage

Initializes a new instance of an OpenXmlPackage class.

Top

Properties

 

Name

Description

CompressionOption

Gets / Sets the compression level for content of new part.

ExternalRelationships

Enumerates all external relationships. (Inherited from OpenXmlPartContainer.)

FileOpenAccess

Gets the current FileAccess IO setting for the document.

Package

Gets the Package of the document.

PackageProperties

Gets the PackageProperties of the Open XML document package.

PartExtensionProvider

Defines a PartExtensionProvider, which provides a map from the ContentType to the part extension.

Parts

Enumerates all parts that are relationship targets of this part. (Inherited from OpenXmlPartContainer.)

Top

Methods

 

Name

Description

AddAnnotation

Adds an object to the annotation list of this PartContainer. (Inherited from OpenXmlPartContainer.)

AddExtendedPart(String, String, String)

Adds an extended part as an application specific part. (Inherited from OpenXmlPartContainer.)

AddExtendedPart(String, String, String, String)

Adds an extended part as an application specific part. (Inherited from OpenXmlPartContainer.)

AddExternalRelationship(String, Uri)

Adds an external relationship. (Inherited from OpenXmlPartContainer.)

AddExternalRelationship(String, Uri, String)

Adds an external relationship. (Inherited from OpenXmlPartContainer.)

AddNewPart<T>()

Adds a new part of type T. (Inherited from OpenXmlPartContainer.)

AddNewPart<T>(String)

Adds a new part of type T. (Inherited from OpenXmlPartContainer.)

AddNewPart<T>(String, String)

Adds a new part of type T. (Inherited from OpenXmlPartContainer.)

AddPart<T>(T)

Adds the part to the document. Must use the returned part to operate the part added to the document. (Overrides OpenXmlPartContainer.AddPart<T>(T).)

AddPart<T>(T)

Adds the part to the document. Must use the returned part to open the part added to the document. (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 the part added to the document. (Inherited from OpenXmlPartContainer.)

Annotation(Type)

Gets the first annotation object of the specified type from this PartContainer. (Inherited from OpenXmlPartContainer.)

Annotation<T>()

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

Close

Saves and closes the OpenXml package plus all underlying part streams.

DeleteExternalRelationship

Deletes the external relationship. (Inherited from OpenXmlPartContainer.)

DeletePart(String)

Deletes the specified child part from this part. (Inherited from OpenXmlPartContainer.)

DeletePart(OpenXmlPart)

Deletes a specified part in the package root layer. (Inherited from OpenXmlPartContainer.)

DeleteParts<T>

Deletes all the parts in the passed-in collection. (Inherited from OpenXmlPartContainer.)

DeletePartsRecursivelyOfType<T>

Recursively deletes all the parts that are the specified part type from the package.

Dispose()

Flushes and saves the content, closes the document, and releases all resources.

Dispose(Boolean)

Flushes and saves the content, closes the document, and releases all resources.

Equals

(Inherited from Object.)

Finalize

(Inherited from Object.)

GetHashCode

(Inherited from Object.)

GetIdOfPart

Gets the relationship ID of the part. (Inherited from OpenXmlPartContainer.)

GetPartById

Gets the child part through the relationship ID. (Inherited from OpenXmlPartContainer.)

GetPartsCountOfType<T>

Gets the count of all parts in type T. (Inherited from OpenXmlPartContainer.)

GetPartsOfType<T>()

Enumerates all the child parts of the specified type "T" of this part. (Inherited from OpenXmlPartContainer.)

GetPartsOfType<T>(ICollection<T>)

Gets all the child parts of the specified type "T" into "partCollection" of this part. (Inherited from OpenXmlPartContainer.)

GetType

(Inherited from Object.)

MemberwiseClone

(Inherited from Object.)

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

Throws an excpetion if the object is disposed. (Overrides OpenXmlPartContainer.ThrowIfObjectDisposed().)

ToString

(Inherited from Object.)

Validate

Validates the package. However, it does not validate the XML content in each part.

Top

See Also

Reference

OpenXmlPackage Class

DocumentFormat.OpenXml.Packaging Namespace