SpreadsheetDocument 类

定义

命名空间:

DocumentFormat.OpenXml.Packaging

程序集:

DocumentFormat.OpenXml.dll

包:

DocumentFormat.OpenXml v3.0.1

定义 SpreadsheetDocument - OpenXmlPackage 表示电子表格文档。

public class SpreadsheetDocument : DocumentFormat.OpenXml.Packaging.OpenXmlPackage, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.ThumbnailPart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.WorkbookPart>

type SpreadsheetDocument = class
    inherit OpenXmlPackage
    interface ISupportedRelationship<ThumbnailPart>
    interface ISupportedRelationship<WorkbookPart>

Public Class SpreadsheetDocument
Inherits OpenXmlPackage
Implements ISupportedRelationship(Of ThumbnailPart), ISupportedRelationship(Of WorkbookPart)

继承

Object

OpenXmlPartContainer

OpenXmlPackage

SpreadsheetDocument

实现

ISupportedRelationship<ThumbnailPart> ISupportedRelationship<WorkbookPart>

示例

以下示例创建一个基本的 Excel 文档，一个包含一个工作表的工作簿。 运行代码示例后，查看创建的文件“SpreadsheetDocumentEx.xlsx”，并注意名为“mySheet”的工作表。

using System;  
using DocumentFormat.OpenXml;  
using DocumentFormat.OpenXml.Packaging;  
using DocumentFormat.OpenXml.Spreadsheet;  

namespace SpreadsheetDocumentEx  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            string fileName = @"c:\Users\Public\Documents\SpreadsheetDocumentEx.xlsx";  

            // Create a spreadsheet document by supplying the file name.  
            SpreadsheetDocument spreadsheetDocument = SpreadsheetDocument.  
                Create(fileName, SpreadsheetDocumentType.Workbook);  

            // Add a WorkbookPart to the document.  
            WorkbookPart workbookpart = spreadsheetDocument.AddWorkbookPart();  
            workbookpart.Workbook = new Workbook();  

            // Add a WorksheetPart to the WorkbookPart.  
            WorksheetPart worksheetPart = workbookpart.AddNewPart<WorksheetPart>();  
            worksheetPart.Worksheet = new Worksheet(new SheetData());  

            // Add Sheets to the Workbook.  
            Sheets sheets = spreadsheetDocument.WorkbookPart.Workbook.  
                AppendChild<Sheets>(new Sheets());  

            // Append a new worksheet and associate it with the workbook.  
            Sheet sheet = new Sheet() { Id = spreadsheetDocument.WorkbookPart.  
                GetIdOfPart(worksheetPart), SheetId = 1, Name = "mySheet" };  
            sheets.Append(sheet);  

            // Close the document.  
            spreadsheetDocument.Close();  

            Console.WriteLine("The spreadsheet document has been created.\nPress a key.");  
            Console.ReadKey();  
        }  
    }  
}  

Imports DocumentFormat.OpenXml  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Spreadsheet  
Module Module1  
    Sub Main()  
        ' Create a spreadsheet document by supplying the file name.  
        Dim fileName As String = "c:\Users\Public\Documents\SpreadsheetDocumentEx.xlsx"  
        Dim spreadsheetDocument As SpreadsheetDocument = _  
      spreadsheetDocument.Create(fileName, SpreadsheetDocumentType.Workbook)  

        ' Add a WorkbookPart to the document.  
        Dim workbookpart As WorkbookPart = spreadsheetDocument.AddWorkbookPart  
        workbookpart.Workbook = New Workbook  

        ' Add a WorksheetPart to the WorkbookPart.  
        Dim worksheetPart As WorksheetPart = workbookpart.AddNewPart(Of WorksheetPart)()  
        worksheetPart.Worksheet = New Worksheet(New SheetData())  

        ' Add Sheets to the Workbook.  
        Dim sheets As Sheets = spreadsheetDocument.WorkbookPart.Workbook.AppendChild(Of Sheets)(New Sheets())  

        ' Append a new worksheet and associate it with the workbook.  
        Dim sheet As Sheet = New Sheet  
        sheet.Id = spreadsheetDocument.WorkbookPart.GetIdOfPart(worksheetPart)  
        sheet.SheetId = 1  
        sheet.Name = "mySheet"  
        sheets.Append(sheet)  
        workbookpart.Workbook.Save()  

        ' Close the document.  
        spreadsheetDocument.Close()  

        Console.WriteLine("The spreadsheet document has been created." +  
                          ControlChars.Lf + "Press a key.")  
        Console.ReadKey()  
    End Sub  
End Module  

属性

AutoSave	获取一个值，该值指示在释放时是否应保存部件。 (继承自 OpenXmlPackage)
CompressionOption	获取或设置新部件内容的压缩级别 (继承自 OpenXmlPackage)
CoreFilePropertiesPart	获取 SpreadsheetDocument 的 CoreFilePropertiesPart。
CustomFilePropertiesPart	获取 SpreadsheetDocument 的 CustomFilePropertiesPart。
DataPartReferenceRelationships	获取所有 DataPartReferenceRelationship 关系。 (继承自 OpenXmlPartContainer)
DataParts	DataPart获取文档包中的所有部分。 (继承自 OpenXmlPackage)
DigitalSignatureOriginPart	获取 SpreadsheetDocument 的 DigitalSignatureOriginPart。
DocumentType	获取 SpreadsheetDocument 的类型。
ExtendedFilePropertiesPart	获取 SpreadsheetDocument 的 ExtendedFilePropertiesPart。
ExternalRelationships	获取所有外部关系。 不包括超链接关系，请使用 HyperlinkRelationship 属性枚举超链接关系。 (继承自 OpenXmlPartContainer)
Features	获取与此部件关联的特征。
FileOpenAccess	获取文档的 FileAccess 设置。 当前的 I/O 访问设置是：读取、写入或 ReadWrite。 (继承自 OpenXmlPackage)
HyperlinkRelationships	获取所有超链接关系。 (继承自 OpenXmlPartContainer)
LabelInfoPart	获取 SpreadsheetDocument 的 LabelInfoPart，仅在 Office2021 中可用。
MarkupCompatibilityProcessSettings	获取加载时应用的标记兼容性设置。 (继承自 OpenXmlPackage)
MaxCharactersInPart	获取一个值，该值指示 Open XML 部件中允许的最大字符数。 零 (0) 值表示部件的大小没有限制。 非零值指定最大大小（以字符为单位）。 (继承自 OpenXmlPackage)
Package	获取文档的包。 (继承自 OpenXmlPackage)
PackageProperties	获取包属性。 (继承自 OpenXmlPackage)
PartExtensionProvider	获取一个 PartExtensionProvider 部件，该部件提供从 ContentType 到部件扩展的映射。 (继承自 OpenXmlPackage)
Parts	获取属于此部件的关系目标的所有部分。 (继承自 OpenXmlPartContainer)
QuickAccessToolbarCustomizationsPart	获取 SpreadsheetDocument 的 QuickAccessToolbarCustomizationsPart。
RibbonAndBackstageCustomizationsPart	获取 SpreadsheetDocument 的 RibbonAndBackstageCustomizationsPart，仅在 Office2010 中可用。
RibbonExtensibilityPart	获取 SpreadsheetDocument 的 RibbonExtensibilityPart。
RootPart	获取包的根部分。 (继承自 OpenXmlPackage)
StrictRelationshipFound	获取一个值，该值指示此包是否包含从 Strict 转换的过渡关系。 (继承自 OpenXmlPackage)
ThumbnailPart	获取 SpreadsheetDocument 的 ThumbnailPart。
WebExTaskpanesPart	获取 SpreadsheetDocument 的 WebExTaskpanes 部件，仅在 Office2013 中可用。
WorkbookPart	获取 SpreadsheetDocument 的 WorkbookPart。

方法

AddAnnotation(Object)	将 对象添加到此 PartContainer 的注释列表中。 (继承自 OpenXmlPartContainer)
AddCoreFilePropertiesPart()	将 CoreFilePropertiesPart 添加到 SpreadsheetDocument。
AddCustomFilePropertiesPart()	将 CustomFilePropertiesPart 添加到 SpreadsheetDocument。
AddDigitalSignatureOriginPart()	将 DigitalSignatureOriginPart 添加到 SpreadsheetDocument。
AddExtendedFilePropertiesPart()	将 ExtendedFilePropertiesPart 添加到 SpreadsheetDocument。
AddExtendedPart(String, String, String, String)	( 特定于应用程序的部件 ) 添加扩展部件。 (继承自 OpenXmlPartContainer)
AddExtendedPart(String, String, String)	( 特定于应用程序的部件 ) 添加扩展部件。 (继承自 OpenXmlPartContainer)
AddExternalRelationship(String, Uri, String)	添加外部关系。 请勿通过此方法添加超链接关系。 请改用 AddHyperlinkRelationship () 。 (继承自 OpenXmlPartContainer)
AddExternalRelationship(String, Uri)	添加外部关系。 请勿通过此方法添加超链接关系。 请改用 AddHyperlinkRelationship () 。 (继承自 OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean, String)	添加新的超链接关系。 (继承自 OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean)	添加新的超链接关系。 (继承自 OpenXmlPartContainer)
AddLabelInfoPart()	将 LabelInfoPart 添加到 SpreadsheetDocument，此部件仅在 Office2021 中可用。
AddNewPart<T>()	添加 T 类型的新部件。 (继承自 OpenXmlPartContainer)
AddNewPart<T>(String, String)	添加 类型的 T新部分。
AddNewPart<T>(String)	添加 T 类型的新部件。 (继承自 OpenXmlPartContainer)
AddPart<T>(T, String)	将具有给定关系标识符 (ID) 的部件添加到文档中。 必须使用返回的部件对添加到文档的部件进行操作 (继承自 OpenXmlPartContainer)
AddPart<T>(T)	将指定部件添加到文档。 使用返回的部件对添加到文档的部件进行操作。 (继承自 OpenXmlPackage)
AddQuickAccessToolbarCustomizationsPart()	将 QuickAccessToolbarCustomizationsPart 添加到 SpreadsheetDocument。
AddRibbonAndBackstageCustomizationsPart()	将 RibbonAndBackstageCustomizationsPart 添加到 SpreadsheetDocument，此部件仅在 Office2010 中可用。
AddRibbonExtensibilityPart()	将 RibbonExtensibilityPart 添加到 SpreadsheetDocument。
AddWebExTaskpanesPart()	将 WebExTaskpanesPart 添加到 SpreadsheetDocument，此部件仅在 Office2013 中可用。
AddWorkbookPart()	创建了 WorkbookPart 并将其添加到此文档。
Annotation(Type)	从此 PartContainer 获取指定类型的第一个批注对象。 (继承自 OpenXmlPartContainer)
Annotation<T>()	从此 PartContainer 获取指定类型的第一个批注对象。 (继承自 OpenXmlPartContainer)
Annotations(Type)	获取此 PartContainer 的指定类型的注释集合。 (继承自 OpenXmlPartContainer)
Annotations<T>()	获取此 PartContainer 的指定类型的注释集合。 (继承自 OpenXmlPartContainer)
ChangeDocumentType(SpreadsheetDocumentType)	更改文档类型。
ChangeIdOfPart(OpenXmlPart, String)	更改部件的关系 ID。 (继承自 OpenXmlPartContainer)
Clone()	创建此 OpenXml 包的可编辑克隆，该克隆在具有可扩展容量的 上使用 MemoryStream 默认 OpenSettings 打开。 (继承自 OpenXmlPackage)
Clone(Package, OpenSettings)	创建此 OpenXml 包的克隆，在指定的 Package 实例上打开。 (继承自 OpenXmlPackage)
Clone(Package)	创建此 OpenXml 包的克隆，在指定的 Package 实例上打开。 将使用此 OpenXml 包相同的 OpenSettings 打开克隆。 (继承自 OpenXmlPackage)
Clone(Stream, Boolean, OpenSettings)	创建此 OpenXml 包的克隆，该包在给定流中打开。 (继承自 OpenXmlPackage)
Clone(Stream, Boolean)	创建此 OpenXml 包的克隆，该包在给定流中打开。 使用与此 OpenXml 包相同的 OpenSettings 打开克隆的 OpenXml 包。 (继承自 OpenXmlPackage)
Clone(Stream)	创建此 OpenXml 包的克隆，该包在给定流中打开。 使用与此 OpenXml 包相同的设置（即 FileOpenAccess 和 OpenSettings）打开克隆的 OpenXml 包。 (继承自 OpenXmlPackage)
Clone(String, Boolean, OpenSettings)	创建从给定文件打开的此 OpenXml 包的克隆 (将通过克隆此 OpenXml 包) 创建。 (继承自 OpenXmlPackage)
Clone(String, Boolean)	创建从给定文件打开的此 OpenXml 包的克隆 (将通过克隆此 OpenXml 包) 创建。 使用与此 OpenXml 包相同的 OpenSettings 打开克隆的 OpenXml 包。 (继承自 OpenXmlPackage)
Clone(String)	创建从给定文件打开的此 OpenXml 包的克隆 (将通过克隆此 OpenXml 包) 创建。 使用与此 OpenXml 包相同的设置（即 FileOpenAccess 和 OpenSettings）打开克隆的 OpenXml 包。 (继承自 OpenXmlPackage)
Close()	保存并关闭 OpenXml 包和所有基础部件流。 (继承自 OpenXmlPackage)
Create(Package, SpreadsheetDocumentType, Boolean)	从指定的包创建 SpreadsheetDocument 类的新实例。
Create(Package, SpreadsheetDocumentType)	从指定的包创建 SpreadsheetDocument 类的新实例。
Create(Stream, SpreadsheetDocumentType, Boolean)	从 IO 流创建 SpreadsheetDocument 类的新实例。
Create(Stream, SpreadsheetDocumentType)	从 IO 流创建 SpreadsheetDocument 类的新实例。
Create(String, SpreadsheetDocumentType, Boolean)	从指定文件创建 SpreadsheetDocument 类的新实例。
Create(String, SpreadsheetDocumentType)	从指定文件创建 SpreadsheetDocument 类的新实例。
CreateClone(Package)	在指定的 Package 实例上创建 OpenXmlPackage 的新实例。 (继承自 OpenXmlPackage)
CreateClone(Stream)	在给定流上创建新的 OpenXmlPackage。 (继承自 OpenXmlPackage)
CreateClone(String)	在给定文件上创建新的 OpenXml 包。 (继承自 OpenXmlPackage)
CreateFromTemplate(String)	从模板创建可编辑的 SpreadsheetDocument，该模板在具有可扩展容量的 MemoryStream 上打开。
CreateMediaDataPart(MediaDataPartType)	在文档包中创建一个新 MediaDataPart 部件。 (继承自 OpenXmlPackage)
CreateMediaDataPart(String, String)	在文档包中创建一个新 MediaDataPart 部件。 (继承自 OpenXmlPackage)
CreateMediaDataPart(String)	在文档包中创建一个新 MediaDataPart 部件。 (继承自 OpenXmlPackage)
CreateRelationshipToPart(OpenXmlPart, String)	将指定部件的关系添加到此部件。 (继承自 OpenXmlPartContainer)
CreateRelationshipToPart(OpenXmlPart)	将指定部件的关系添加到此部件。 (继承自 OpenXmlPartContainer)
DeleteExternalRelationship(ExternalRelationship)	删除指定的外部关系。 (继承自 OpenXmlPartContainer)
DeleteExternalRelationship(String)	删除指定的 ExternalRelationship。 (继承自 OpenXmlPartContainer)
DeletePart(DataPart)	从文档包中删除指定的 DataPart 。 (继承自 OpenXmlPackage)
DeletePart(OpenXmlPart)	删除包根层中的指定部件。 (继承自 OpenXmlPartContainer)
DeletePart(String)	从此部件中删除指定的子部件。 (继承自 OpenXmlPartContainer)
DeleteParts<T>(IEnumerable<T>)	从文档中删除传入的 集合中的所有部分。 (继承自 OpenXmlPartContainer)
DeletePartsRecursivelyOfType<T>()	从包中递归删除具有指定部件类型的所有部件。 (继承自 OpenXmlPackage)
DeleteReferenceRelationship(ReferenceRelationship)	删除指定的引用关系。 (继承自 OpenXmlPartContainer)
DeleteReferenceRelationship(String)	删除指定的引用关系。 (继承自 OpenXmlPartContainer)
Dispose()	刷新并保存内容，关闭文档，并释放所有资源。 (继承自 OpenXmlPackage)
Dispose(Boolean)	刷新并保存内容，关闭文档，并释放所有资源。 (继承自 OpenXmlPackage)
FromFlatOpcDocument(XDocument, Package)	从指定 Package 实例上的平面 OPC 格式的工作簿创建 SpreadsheetDocument 的新实例。
FromFlatOpcDocument(XDocument, Stream, Boolean)	从平面 OPC 格式的工作簿创建 SpreadsheetDocument 的新实例。
FromFlatOpcDocument(XDocument, String, Boolean)	从平面 OPC 格式的工作簿创建 SpreadsheetDocument 的新实例。
FromFlatOpcDocument(XDocument)	从 XDocument 在 上 MemoryStream打开的平面 OPC 格式的 创建 SpreadsheetDocument 的新可编辑实例。
FromFlatOpcString(String, Package)	从平面 OPC 格式的字符串创建 SpreadsheetDocument 的新实例。
FromFlatOpcString(String, Stream, Boolean)	基于 平面 OPC 格式的字符串创建 SpreadsheetDocument 的新实例
FromFlatOpcString(String, String, Boolean)	从平面 OPC 格式的字符串创建 SpreadsheetDocument 的新实例。
FromFlatOpcString(String)	在具有可扩展容量的 上 MemoryStream ，从平面 OPC 格式的字符串创建 SpreadsheetDocument 的新实例。
GetExternalRelationship(String)	获取指定的 ExternalRelationship。 (继承自 OpenXmlPartContainer)
GetIdOfPart(OpenXmlPart)	获取部件的关系 ID。 (继承自 OpenXmlPartContainer)
GetPartById(String)	通过关系 ID 获取子部件。 (继承自 OpenXmlPartContainer)
GetPartsCountOfType<T>()	获取类型 T 的所有部分的计数。 (继承自 OpenXmlPartContainer)
GetPartsOfType<T>()	枚举此部件的指定类型 T 的所有子部分。 (继承自 OpenXmlPartContainer)
GetPartsOfType<T>(ICollection<T>)	获取此部件中指定类型TpartCollection的所有子部分。 (继承自 OpenXmlPartContainer)
GetReferenceRelationship(String)	获取指定的 ReferenceRelationship。 (继承自 OpenXmlPartContainer)
Open(Package, OpenSettings)	从指定的包创建 SpreadsheetDocument 类的新实例。
Open(Package)	从指定的包创建 SpreadsheetDocument 类的新实例。
Open(Stream, Boolean, OpenSettings)	从 IO 流创建 SpreadsheetDocument 类的新实例。
Open(Stream, Boolean)	从 IO 流创建 SpreadsheetDocument 类的新实例。
Open(String, Boolean, OpenSettings)	从指定文件创建 SpreadsheetDocument 类的新实例。
Open(String, Boolean)	从指定文件创建 SpreadsheetDocument 类的新实例。
OpenClone(Stream, Boolean, OpenSettings)	打开给定流上克隆的 OpenXml 包。 (继承自 OpenXmlPackage)
OpenClone(String, Boolean, OpenSettings)	打开给定文件上克隆的 OpenXml 包。 (继承自 OpenXmlPackage)
RemoveAnnotations(Type)	从此 PartContainer 中删除指定类型的注释。 (继承自 OpenXmlPartContainer)
RemoveAnnotations<T>()	从此 PartContainer 中删除指定类型的注释。 (继承自 OpenXmlPartContainer)
Save()	如果 FileOpenAccess 为 ReadWrite，则保存 OpenXml 包中包含的所有部件和关系的内容。 由于 中的 Package限制，某些平台不支持保存，因此请在运行时查询 CanSave ，以了解是否支持完全保存，而无需关闭和释放 OpenXmlPackage。 (继承自 OpenXmlPackage)
SaveAs(String)	将 OpenXml 包中包含的所有部件和关系的内容保存到指定的文件中。 使用用于打开此 OpenXml 包的相同设置打开保存的文档。 (继承自 OpenXmlPackage)
ThrowIfObjectDisposed()	如果释放对象，则引发。 (继承自 OpenXmlPackage)
ToFlatOpcDocument()	将 OPC 格式的 OpenXml 包转换为 XDocument 平面 OPC 格式的 。 (继承自 OpenXmlPackage)
ToFlatOpcDocument(XProcessingInstruction)	将 OPC 格式的 OpenXml 包转换为 XDocument 平面 OPC 格式的 。 (继承自 OpenXmlPackage)
ToFlatOpcString()	将 OPC 格式的 OpenXml 包转换为平面 OPC 格式的字符串。 (继承自 OpenXmlPackage)
TryGetPartById(String, OpenXmlPart)	尝试按关系 ID 获取子部件。 (继承自 OpenXmlPartContainer)
Validate(OpenXmlPackageValidationSettings)	验证包。 此方法不会验证每个部分中的 XML 内容。 (继承自 OpenXmlPackage)

扩展方法

GetPackage(OpenXmlPackage)	获取 的package当前 IPackage 。
AddPackageEventsFeature(OpenXmlPackage)	添加了一项功能，用于跟踪包生命周期事件的事件。
AddPartEventsFeature(OpenXmlPackage)	添加一项功能，用于跟踪创建或删除部件的包的事件。
AddPartRootEventsFeature(OpenXmlPartContainer)	添加了一项功能，用于跟踪包生命周期事件的事件。
AddRandomNumberGeneratorFeature(OpenXmlPackage)	将随机数生成器添加到包。
CreateUnknownElement(OpenXmlPartContainer, String)	使用外部 XML 创建新的 OpenXmlUnknownElement 类。
ToFlatOpcDocument(OpenXmlPackage)	将 OPC 格式的 OpenXml 包转换为 XDocument 平面 OPC 格式的 。
ToFlatOpcString(OpenXmlPackage)	将 OPC 格式的 OpenXml 包转换为平面 OPC 格式的字符串。
GetAllParts(OpenXmlPackage)	按广度优先遍历 中的 OpenXmlPackage 部分。
IgnoreCalculationChainPartRelationship(SpreadsheetDocument)	设置 以 spreadsheet 在部件不存在时忽略任何 CalculationChainPart 关系。