SpreadsheetDocument Methods

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.

The SpreadsheetDocument type exposes the following members.

Methods

 

Name

Description

AddAnnotation

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

AddCoreFilePropertiesPart

Adds a CoreFilePropertiesPart to the Spreadsheetdocument.

AddCustomFilePropertiesPart

Adds a CustomFilePropertiesPart to the Spreadsheetdocument.

AddDigitalSignatureOriginPart

Adds a DigitalSignatureOriginPart to the Spreadsheetdocument.

AddExtendedFilePropertiesPart

Adds an ExtendedFilePropertiesPart to the Spreadsheetdocument.

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. (Overrides OpenXmlPartContainer.AddNewPart<T>(String, String).)

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

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

AddThumbnailPart(String)

Adds a ThumbnailPart to the Spreadsheetdocument.

AddThumbnailPart(ThumbnailPartType)

Adds a ThumbnailPart to the Spreadsheetdocument.

AddWorkbookPart

Creates the WorkbookPart and adds it to this document.

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

ChangeDocumentType

Changes the document type.

Close

Saves and closes the OpenXml package plus all underlying part streams. (Inherited from OpenXmlPackage.)

Create(Package, SpreadsheetDocumentType)

Creates a new instance of the SpreadsheetDocument class from the specified package.

Create(Stream, SpreadsheetDocumentType)

Creates a new instance of the SpreadsheetDocument class from the IO stream.

Create(String, SpreadsheetDocumentType)

Creates a new instance of the SpreadsheetDocument class from the specified file.

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. (Inherited from OpenXmlPackage.)

Dispose()

Flushes and saves the content, closes the document, and releases all resources. (Inherited from OpenXmlPackage.)

Dispose(Boolean)

Flushes and saves the content, closes the document, and releases all resources. (Inherited from OpenXmlPackage.)

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

Open(Package)

Creates a new instance of the SpreadsheetDocument class from the specified package.

Open(Stream, Boolean)

Creates a new instance of the SpreadsheetDocument class from the IO stream.

Open(String, Boolean)

Creates a new instance of the SpreadsheetDocument class from the specified file.

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. (Inherited from OpenXmlPackage.)

ToString

(Inherited from Object.)

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