OpenXmlPackage Members

Include Protected Members
Include Inherited Members

Defines OpenXmlPackage - base class for strong typed Open XML document classes.

The OpenXmlPackage type exposes the following members.

Constructors

  Name Description
Protected method OpenXmlPackage Initializes a new instance of the OpenXmlPackage.

Top

Properties

  Name Description
Public property AutoSave Gets the flag indicating whether the parts should be saved on disposing.
Public property CompressionOption Get / Set the compression level for content of new part.
Public property DataPartReferenceRelationships Enumerates all DataPartReferenceRelationship relationships. (Inherited from OpenXmlPartContainer.)
Public property DataParts Enumerates all the DataPart in the document package.
Public property ExternalRelationships Enumerates all external relationships. Hyperlink relationships are not included, use HyperlinkRelationship property to enumerate hyperlink relationships. (Inherited from OpenXmlPartContainer.)
Public property FileOpenAccess Gets the FileAccess setting for the document. The current IO access setting: Read, Write, or ReadWrite.
Public property HyperlinkRelationships Enumerates all hyperlink relationships. (Inherited from OpenXmlPartContainer.)
Public property MarkupCompatibilityProcessSettings Gets the markup compatibilty settings applied in loading time
Public property MaxCharactersInPart Gets or sets a value indicating the maximum allowable number of characters in an Open XML part. A zero (0) value means no limits on the size of the part. A non-zero value specifies the maximum size, in characters.
Public property Package Gets the Package of the document.
Public property PackageProperties Gets the core properties (PackageProperties) of the Open XML document (package).
Public property PartExtensionProvider PartExtensionProvider which provide map from ContentType to part extension
Public property Parts Enumerates all parts which 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 ( Application specific part ) (Inherited from OpenXmlPartContainer.)
Public method AddExtendedPart(String, String, String, String) Adds an extended part ( Application specific part ) (Inherited from OpenXmlPartContainer.)
Public method AddExternalRelationship(String, Uri) Adds external relationship. Do not add hyperlink relationships through this method. Use AddHyperlinkRelationship() instead. (Inherited from OpenXmlPartContainer.)
Public method AddExternalRelationship(String, Uri, String) Adds external relationship. Do not add hyperlink relationships through this method. Use AddHyperlinkRelationship() instead. (Inherited from OpenXmlPartContainer.)
Public method AddHyperlinkRelationship(Uri, Boolean) Adds a new hyperlink relationship. (Inherited from OpenXmlPartContainer.)
Public method AddHyperlinkRelationship(Uri, Boolean, String) Adds a new hyperlink 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) Add the part to the document. Must use the returned part to opertate the part added to the doucment (Overrides OpenXmlPartContainer.AddPart<T>(T).)
Public method AddPart<T>(T) Adds the part to the document. Must use the returned part to opertate the part added to the doucment (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 opertate the part added to the doucment (Inherited from OpenXmlPartContainer.)
Public method Annotation(Type) Get the first annotation object of the specified type from this PartContainer (Inherited from OpenXmlPartContainer.)
Public method Annotation<T>() Get 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 ChangeIdOfPart Changes the relationship ID of the part. (Inherited from OpenXmlPartContainer.)
Public method Close Saves and closes the OpenXml package plus all underlying part streams.
Public method CreateMediaDataPart(String) Creates a new MediaDataPart to the document package.
Public method CreateMediaDataPart(MediaDataPartType) Creates a new MediaDataPart to the document package.
Public method CreateMediaDataPart(String, String) Creates a new MediaDataPart to the document package.
Public method CreateRelationshipToPart(OpenXmlPart) Adds relationship for the specified part to this part. (Inherited from OpenXmlPartContainer.)
Public method CreateRelationshipToPart(OpenXmlPart, String) Adds relationship for the specified part to this part. (Inherited from OpenXmlPartContainer.)
Public method DeleteExternalRelationship(String) Deletes the sepcified ExternalRelationship. (Inherited from OpenXmlPartContainer.)
Public method DeleteExternalRelationship(ExternalRelationship) Deletes the specified external relationship. (Inherited from OpenXmlPartContainer.)
Public method DeletePart(String) Deletes the specified child part from this part. (Inherited from OpenXmlPartContainer.)
Public method DeletePart(DataPart) Deletes the sepcified DataPart from the document package.
Public method DeletePart(OpenXmlPart) Deletes a specified part in the package root layer. (Inherited from OpenXmlPartContainer.)
Public method DeleteParts<T> Deletes all the parts which in the passed in collection from the document. (Inherited from OpenXmlPartContainer.)
Public method DeletePartsRecursivelyOfType<T> Delete all the parts which is the specified part type from package recursively.
Public method DeleteReferenceRelationship(String) Deletes the sepcified reference relationship. (Inherited from OpenXmlPartContainer.)
Public method DeleteReferenceRelationship(ReferenceRelationship) Deletes the specified reference relationship. (Inherited from OpenXmlPartContainer.)
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 GetExternalRelationship Gets the sepcified ExternalRelationship. (Inherited from OpenXmlPartContainer.)
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 children parts of the specified type "T" of this part. (Inherited from OpenXmlPartContainer.)
Public method GetPartsOfType<T>(ICollection<T>) Gets all the children parts of the specified type "T" into "partCollection" of this part. (Inherited from OpenXmlPartContainer.)
Public method GetReferenceRelationship Gets the sepcified ReferenceRelationship. (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 Throw if object is disposed. (Overrides OpenXmlPartContainer.ThrowIfObjectDisposed().)
Public method ToString (Inherited from Object.)
Public method Validate Obsolete. Validate the package ( do not validate the xml content in each part ).

Top

See Also

Reference

OpenXmlPackage Class

DocumentFormat.OpenXml.Packaging Namespace