WorksheetPart 类

定义

命名空间:

DocumentFormat.OpenXml.Packaging

程序集:

DocumentFormat.OpenXml.dll

包:

DocumentFormat.OpenXml v3.0.1

定义 WorksheetPart

public class WorksheetPart : DocumentFormat.OpenXml.Packaging.OpenXmlPart, DocumentFormat.OpenXml.Packaging.IFixedContentTypePart, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.CustomPropertyPart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.EmbeddedControlPersistenceBinaryDataPart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.EmbeddedControlPersistencePart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.EmbeddedObjectPart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.EmbeddedPackagePart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.ImagePart>

type WorksheetPart = class
    inherit OpenXmlPart
    interface IFixedContentTypePart
    interface ISupportedRelationship<CustomPropertyPart>
    interface ISupportedRelationship<EmbeddedControlPersistenceBinaryDataPart>
    interface ISupportedRelationship<EmbeddedControlPersistencePart>
    interface ISupportedRelationship<EmbeddedObjectPart>
    interface ISupportedRelationship<EmbeddedPackagePart>
    interface ISupportedRelationship<ImagePart>

Public Class WorksheetPart
Inherits OpenXmlPart
Implements IFixedContentTypePart, ISupportedRelationship(Of CustomPropertyPart), ISupportedRelationship(Of EmbeddedControlPersistenceBinaryDataPart), ISupportedRelationship(Of EmbeddedControlPersistencePart), ISupportedRelationship(Of EmbeddedObjectPart), ISupportedRelationship(Of EmbeddedPackagePart), ISupportedRelationship(Of ImagePart)

继承

Object

OpenXmlPartContainer

OpenXmlPart

WorksheetPart

实现

IFixedContentTypePart ISupportedRelationship<CustomPropertyPart> ISupportedRelationship<EmbeddedControlPersistenceBinaryDataPart> ISupportedRelationship<EmbeddedControlPersistencePart> ISupportedRelationship<EmbeddedObjectPart> ISupportedRelationship<EmbeddedPackagePart> ISupportedRelationship<ImagePart>

示例

下面的代码示例打开一个 zip 文件，并在其中创建电子表格文档。

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

namespace WorkSheetPartEx  
{  
    class Program  
    {  
        // Create a spreadsheet by Package.  
        static void Main(string[] args)  
        {  
            string fileName = @"C:\users\public\documents\WorkSheetPartEx.zip";  

            // Open a package file.   
            Package package = Package.Open(fileName);  

            // Create the spreadsheet document.  
            SpreadsheetDocument spreadsheetDocument =   
                SpreadsheetDocument.Create(package, SpreadsheetDocumentType.Template);  

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

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

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

            // Append the 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 spreadsheet and the package.  
            spreadsheetDocument.Close();  
            package.Close();  

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

Imports System.IO.Packaging  
Imports DocumentFormat.OpenXml  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Spreadsheet  

Module Module1  
    ' Create a spreadsheet by Package.  
    Sub Main(ByVal args As String())  
        Dim fileName As String = "C:\users\public\documents\WorkSheetPartEx.zip"  

        ' Open a package file.   
        Dim package As Package = package.Open(fileName)  

        ' Create the spreadsheet document.  
        Dim spreadsheetDocument As SpreadsheetDocument = spreadsheetDocument.Create(package, SpreadsheetDocumentType.Template)  

        ' Add a WorkbookPart.  
        Dim workbookpart As WorkbookPart = spreadsheetDocument.AddWorkbookPart()  
        workbookpart.Workbook = New Workbook()  

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

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

        ' Append the new worksheet and associate it with the workbook.  
        Dim sheet As New Sheet() With { _  
         .Id = spreadsheetDocument.WorkbookPart.GetIdOfPart(worksheetPart), _  
         .SheetId = 1, _  
         .Name = "mySheet" _  
        }  
        sheets.Append(sheet)  

        ' Close the spreadsheet and the package.  
        spreadsheetDocument.Close()  
        package.Close()  

        Console.WriteLine("The package has been created." & vbLf & "Press a key.")  
        Console.ReadKey()  
    End Sub  
End Module  

属性

ContentType	获取 ContentType。
ControlPropertiesParts	获取 WorksheetPart 的 ControlPropertiesParts
CustomPropertyParts	获取 WorksheetPart 的 CustomPropertyParts
DataPartReferenceRelationships	获取所有 DataPartReferenceRelationship 关系。 (继承自 OpenXmlPartContainer)
DrawingsPart	获取 WorksheetPart 的绘图部分
EmbeddedControlPersistenceBinaryDataParts	获取 WorksheetPart 的 EmbeddedControlPersistenceBinaryDataParts
EmbeddedControlPersistenceParts	获取 WorksheetPart 的 EmbeddedControlPersistenceParts
EmbeddedObjectParts	获取 WorksheetPart 的 EmbeddedObjectParts
EmbeddedPackageParts	获取 WorksheetPart 的 EmbeddedPackageParts
ExternalRelationships	获取所有外部关系。 不包括超链接关系，请使用 HyperlinkRelationship 属性枚举超链接关系。 (继承自 OpenXmlPartContainer)
Features	获取与此部件关联的特征。
HyperlinkRelationships	获取所有超链接关系。 (继承自 OpenXmlPartContainer)
ImageParts	获取 WorksheetPart 的 ImageParts
IsRootElementLoaded	获取一个值，该值指示根元素是从部件加载还是已设置。 (继承自 OpenXmlPart)
Model3DReferenceRelationshipParts	获取 WorksheetPart 的 Model3DReferenceRelationshipParts
NamedSheetViewsParts	获取 WorksheetPart 的 NamedSheetViewsParts
OpenXmlPackage	获取包含当前部件的 OpenXmlPackage。 (继承自 OpenXmlPart)
Parts	获取属于此部件的关系目标的所有部分。 (继承自 OpenXmlPartContainer)
PivotTableParts	获取 WorksheetPart 的数据透视表部分
QueryTableParts	获取 WorksheetPart 的 QueryTableParts
RelationshipType	获取 RelationshipType。
RootElement	获取当前部件的根元素。 当当前部件为空或不是 XML 内容类型时，返回 null。 (继承自 OpenXmlPart)
SingleCellTablePart	获取 WorksheetPart 的 SingleCellTablePart
SlicersParts	获取 WorksheetPart 的 SlicersParts
SpreadsheetPrinterSettingsParts	获取 WorksheetPart 的 SpreadsheetPrinterSettingsParts
TableDefinitionParts	获取 WorksheetPart 的 TableDefinitionParts
TimeLineParts	获取 WorksheetPart 的 TimeLineParts
Uri	获取包中的内部部件路径。 (继承自 OpenXmlPart)
VmlDrawingParts	获取 WorksheetPart 的 VmlDrawingParts
Worksheet	获取或设置此部件的根元素。
WorksheetCommentsPart	获取 WorksheetPart 的 WorksheetCommentsPart
WorksheetSortMapPart	获取 WorksheetPart 的 WorksheetSortMapPart
WorksheetThreadedCommentsParts	获取 WorksheetPart 的 WorksheetThreadedCommentsParts

方法

AddAnnotation(Object)	将 对象添加到此 PartContainer 的注释列表中。 (继承自 OpenXmlPartContainer)
AddExtendedPart(String, String, String)	( 特定于应用程序的部件 ) 添加扩展部件。 (继承自 OpenXmlPartContainer)
AddExtendedPart(String, String, String, String)	( 特定于应用程序的部件 ) 添加扩展部件。 (继承自 OpenXmlPartContainer)
AddExternalRelationship(String, Uri)	添加外部关系。 请勿通过此方法添加超链接关系。 请改用 AddHyperlinkRelationship () 。 (继承自 OpenXmlPartContainer)
AddExternalRelationship(String, Uri, String)	添加外部关系。 请勿通过此方法添加超链接关系。 请改用 AddHyperlinkRelationship () 。 (继承自 OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean)	添加新的超链接关系。 (继承自 OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean, String)	添加新的超链接关系。 (继承自 OpenXmlPartContainer)
AddNewPart<T>()	添加 T 类型的新部件。 (继承自 OpenXmlPartContainer)
AddNewPart<T>(String)	添加 T 类型的新部件。 (继承自 OpenXmlPartContainer)
AddNewPart<T>(String, String)	添加 T 类型的新部件。 (继承自 OpenXmlPartContainer)
AddPart<T>(T)	将部件添加到文档。 必须使用返回的部件对添加到文档的部件进行操作。 (继承自 OpenXmlPartContainer)
AddPart<T>(T, String)	将具有给定关系标识符 (ID) 的部件添加到文档中。 必须使用返回的部件对添加到文档的部件进行操作 (继承自 OpenXmlPartContainer)
Annotation(Type)	从此 PartContainer 获取指定类型的第一个批注对象。 (继承自 OpenXmlPartContainer)
Annotation<T>()	从此 PartContainer 获取指定类型的第一个批注对象。 (继承自 OpenXmlPartContainer)
Annotations(Type)	获取此 PartContainer 的指定类型的注释集合。 (继承自 OpenXmlPartContainer)
Annotations<T>()	获取此 PartContainer 的指定类型的注释集合。 (继承自 OpenXmlPartContainer)
ChangeIdOfPart(OpenXmlPart, String)	更改部件的关系 ID。 (继承自 OpenXmlPartContainer)
CreateRelationshipToPart(OpenXmlPart)	将指定部件的关系添加到此部件。 (继承自 OpenXmlPartContainer)
CreateRelationshipToPart(OpenXmlPart, String)	将指定部件的关系添加到此部件。 (继承自 OpenXmlPartContainer)
DeleteExternalRelationship(ExternalRelationship)	删除指定的外部关系。 (继承自 OpenXmlPartContainer)
DeleteExternalRelationship(String)	删除指定的 ExternalRelationship。 (继承自 OpenXmlPartContainer)
DeletePart(OpenXmlPart)	删除包根层中的指定部件。 (继承自 OpenXmlPartContainer)
DeletePart(String)	从此部件中删除指定的子部件。 (继承自 OpenXmlPartContainer)
DeleteParts<T>(IEnumerable<T>)	从文档中删除传入的 集合中的所有部分。 (继承自 OpenXmlPartContainer)
DeleteReferenceRelationship(ReferenceRelationship)	删除指定的引用关系。 (继承自 OpenXmlPartContainer)
DeleteReferenceRelationship(String)	删除指定的引用关系。 (继承自 OpenXmlPartContainer)
FeedData(Stream)	将数据馈送到部件流中。 部件的流首先将被截断。 (继承自 OpenXmlPart)
GetExternalRelationship(String)	获取指定的 ExternalRelationship。 (继承自 OpenXmlPartContainer)
GetIdOfPart(OpenXmlPart)	获取部件的关系 ID。 (继承自 OpenXmlPartContainer)
GetParentParts()	枚举文档任意位置引用此部件的所有父级。 (继承自 OpenXmlPart)
GetPartById(String)	通过关系 ID 获取子部件。 (继承自 OpenXmlPartContainer)
GetPartsCountOfType<T>()	获取类型 T 的所有部分的计数。 (继承自 OpenXmlPartContainer)
GetPartsOfType<T>()	枚举此部件的指定类型 T 的所有子部分。 (继承自 OpenXmlPartContainer)
GetPartsOfType<T>(ICollection<T>)	获取此部件中指定类型TpartCollection的所有子部分。 (继承自 OpenXmlPartContainer)
GetReferenceRelationship(String)	获取指定的 ReferenceRelationship。 (继承自 OpenXmlPartContainer)
GetStream()	返回部件内容数据流。 (继承自 OpenXmlPart)
GetStream(FileMode)	返回使用指定的 I/O FileMode 打开的内容流。 (继承自 OpenXmlPart)
GetStream(FileMode, FileAccess)	返回使用指定的 FileMode 和 FileAccess 打开的部件内容流。 (继承自 OpenXmlPart)
RemoveAnnotations(Type)	从此 PartContainer 中删除指定类型的注释。 (继承自 OpenXmlPartContainer)
RemoveAnnotations<T>()	从此 PartContainer 中删除指定类型的注释。 (继承自 OpenXmlPartContainer)
ThrowIfObjectDisposed()	指示对象是否已释放。 (继承自 OpenXmlPart)
TryGetPartById(String, OpenXmlPart)	尝试按关系 ID 获取子部件。 (继承自 OpenXmlPartContainer)
UnloadRootElement()	卸载 RootElement。 (继承自 OpenXmlPart)
ValidateXml(String, ValidationEventHandler)	使用指定的架构验证部件的 XML 内容。 (继承自 OpenXmlPart)
ValidateXml(XmlSchemaSet, ValidationEventHandler)	使用指定的架构验证部件的 XML 内容。 (继承自 OpenXmlPart)

扩展方法

AddPartRootEventsFeature(OpenXmlPartContainer)	添加了一项功能，用于跟踪包生命周期事件的事件。
CreateUnknownElement(OpenXmlPartContainer, String)	使用外部 XML 创建新的 OpenXmlUnknownElement 类。
GetXDocument(OpenXmlPart)	获取 XDocument 的 part表示形式。
GetXElement(OpenXmlPart)	获取 XElement 的 part表示形式。
IsRootXElementLoaded(OpenXmlPart)	获取一个值， XElement 该值指示根是从部件加载还是已设置。
SaveXDocument(OpenXmlPart)	如果部件及其Root元素不是 null，则将当前XDocument保存到部件。
SaveXElement(OpenXmlPart)	如果部件及其Root元素不是 null，则将当前XDocument保存到部件。
SetXDocument(OpenXmlPart, XDocument)	将 OpenXmlPart的 XDocument 设置为给定的 XDocument，序列化 XDocument 并将其写入 OpenXmlPart，如果之前已加载，则重新加载 OpenXmlPart 的 OpenXmlPartRootElement 。
SetXElement(OpenXmlPart, XElement)	将 OpenXmlPart的根 XElement 设置为给定的 XElement，序列化 XElement 并将其写入 OpenXmlPart，如果之前已加载，则重新加载 OpenXmlPart OpenXmlPartRootElement 。