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
	OpenXmlPackage	Initializes a new instance of the OpenXmlPackage.

Top

Properties

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

Top

See Also

Reference

OpenXmlPackage Class

DocumentFormat.OpenXml.Packaging Namespace