Share via


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

Protected method

OpenXmlPackage

Initializes a new instance of an OpenXmlPackage class.

Top

Properties

 

Name

Description

Public property

CompressionOption

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

Public property

ExternalRelationships

Enumerates all external relationships. (Inherited from OpenXmlPartContainer.)

Public property

FileOpenAccess

Gets the current FileAccess IO setting for the document.

Public property

Package

Gets the Package of the document.

Public property

PackageProperties

Gets the PackageProperties of the Open XML document package.

Public property

PartExtensionProvider

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

Public property

Parts

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

Top

Methods

 

Name

Description

Public method

AddAnnotation

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

Public method

AddExtendedPart(String, String, String)

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

Public method

AddExtendedPart(String, String, String, String)

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

Public method

AddExternalRelationship(String, Uri)

Adds an external relationship. (Inherited from OpenXmlPartContainer.)

Public method

AddExternalRelationship(String, Uri, String)

Adds an external relationship. (Inherited from OpenXmlPartContainer.)

Public method

AddNewPart<T>()

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

Public method

AddNewPart<T>(String)

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

Public method

AddNewPart<T>(String, String)

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

Public method

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

Public method

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

Public method

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

Public method

Annotation(Type)

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

Public method

Annotation<T>()

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

Public method

Annotations(Type)

Gets a collection of annotations of the specified type for this PartContainer. (Inherited from OpenXmlPartContainer.)

Public method

Annotations<T>()

Gets a collection of annotations of the specified type for this PartContainer. (Inherited from OpenXmlPartContainer.)

Public method

Close

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

Public method

DeleteExternalRelationship

Deletes the external relationship. (Inherited from OpenXmlPartContainer.)

Public method

DeletePart(String)

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

Public method

DeletePart(OpenXmlPart)

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

Public method

DeleteParts<T>

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

Public method

DeletePartsRecursivelyOfType<T>

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

Public method

Dispose()

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

Protected method

Dispose(Boolean)

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

Public method

Equals

(Inherited from Object.)

Protected method

Finalize

(Inherited from Object.)

Public method

GetHashCode

(Inherited from Object.)

Public method

GetIdOfPart

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

Public method

GetPartById

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

Public method

GetPartsCountOfType<T>

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

Public method

GetPartsOfType<T>()

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

Public method

GetPartsOfType<T>(ICollection<T>)

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

Public method

GetType

(Inherited from Object.)

Protected method

MemberwiseClone

(Inherited from Object.)

Public method

RemoveAnnotations(Type)

Removes the annotations of the specified type from this PartContainer. (Inherited from OpenXmlPartContainer.)

Public method

RemoveAnnotations<T>()

Removes the annotations of the specified type from this PartContainer. (Inherited from OpenXmlPartContainer.)

Protected method

ThrowIfObjectDisposed

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

Public method

ToString

(Inherited from Object.)

Public method

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