SpreadsheetDocument 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 the package that represents a spreadsheet document.

The SpreadsheetDocument type exposes the following members.

Constructors

 

Name Description
Protected method SpreadsheetDocument Creates a Spreadsheet document.

Top

Properties

 

Name Description
Public property CompressionOption Gets / Sets the compression level for content of new part. (Inherited from OpenXmlPackage.)
Public property CoreFilePropertiesPart Gets the CoreFilePropertiesPart of the Spreadsheetdocument.
Public property CustomFilePropertiesPart Gets the CustomFilePropertiesPart of the Spreadsheetdocument.
Public property DigitalSignatureOriginPart Gets the DigitalSignatureOriginPart of the Spreadsheetdocument.
Public property DocumentType Gets the type of the Spreadsheetdocument.
Public property ExtendedFilePropertiesPart Gets the ExtendedFilePropertiesPart of the Spreadsheetdocument.
Public property ExternalRelationships Enumerates all external relationships. (Inherited from OpenXmlPartContainer.)
Public property FileOpenAccess Gets the current FileAccess IO setting for the document. (Inherited from OpenXmlPackage.)
Public property Package Gets the Package of the document. (Inherited from OpenXmlPackage.)
Public property PackageProperties Gets the PackageProperties of the Open XML document package. (Inherited from OpenXmlPackage.)
Public property PartExtensionProvider Defines a PartExtensionProvider, which provides a map from the ContentType to the part extension. (Inherited from OpenXmlPackage.)
Public property Parts Enumerates all parts that are relationship targets of this part. (Inherited from OpenXmlPartContainer.)
Public property ThumbnailPart Gets the ThumbnailPart of the Spreadsheetdocument.
Public property WorkbookPart Gets the WorkbookPart of the Spreadsheetdocument.

Top

Methods

 

Name Description
Public method AddAnnotation Adds an object to the annotation list of this PartContainer. (Inherited from OpenXmlPartContainer.)
Public method AddCoreFilePropertiesPart Adds a CoreFilePropertiesPart to the Spreadsheetdocument.
Public method AddCustomFilePropertiesPart Adds a CustomFilePropertiesPart to the Spreadsheetdocument.
Public method AddDigitalSignatureOriginPart Adds a DigitalSignatureOriginPart to the Spreadsheetdocument.
Public method AddExtendedFilePropertiesPart Adds an ExtendedFilePropertiesPart to the Spreadsheetdocument.
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. (Overrides OpenXmlPartContainer.AddNewPart<T>(String, String).)
Public method AddPart<T>(T) Adds the part to the document. Must use the returned part to operate the part added to the document. (Inherited from OpenXmlPackage.)
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 AddThumbnailPart(String) Adds a ThumbnailPart to the Spreadsheetdocument.
Public method AddThumbnailPart(ThumbnailPartType) Adds a ThumbnailPart to the Spreadsheetdocument.
Public method AddWorkbookPart Creates the WorkbookPart and adds it to this document.
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 ChangeDocumentType Changes the document type.
Public method Close Saves and closes the OpenXml package plus all underlying part streams. (Inherited from OpenXmlPackage.)
Public methodStatic member Create(Package, SpreadsheetDocumentType) Creates a new instance of the SpreadsheetDocument class from the specified package.
Public methodStatic member Create(Stream, SpreadsheetDocumentType) Creates a new instance of the SpreadsheetDocument class from the IO stream.
Public methodStatic member Create(String, SpreadsheetDocumentType) Creates a new instance of the SpreadsheetDocument class from the specified file.
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. (Inherited from OpenXmlPackage.)
Public method Dispose() Flushes and saves the content, closes the document, and releases all resources. (Inherited from OpenXmlPackage.)
Protected method Dispose(Boolean) Flushes and saves the content, closes the document, and releases all resources. (Inherited from OpenXmlPackage.)
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 methodStatic member Open(Package) Creates a new instance of the SpreadsheetDocument class from the specified package.
Public methodStatic member Open(Stream, Boolean) Creates a new instance of the SpreadsheetDocument class from the IO stream.
Public methodStatic member Open(String, Boolean) Creates a new instance of the SpreadsheetDocument class from the specified file.
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. (Inherited from OpenXmlPackage.)
Public method ToString (Inherited from Object.)
Public method Validate Validates the package. However, it does not validate the XML content in each part. (Inherited from OpenXmlPackage.)

Top

See Also

Reference

SpreadsheetDocument Class

DocumentFormat.OpenXml.Packaging Namespace