Workbook 类

定义

命名空间:

DocumentFormat.OpenXml.Spreadsheet

程序集:

DocumentFormat.OpenXml.dll

包:

DocumentFormat.OpenXml v3.0.1

练习 册。

此类在 Office 2007 及更高版本中可用。

当对象序列化为 xml 时，其限定名称为 x：workbook。

public class Workbook : DocumentFormat.OpenXml.OpenXmlPartRootElement

type Workbook = class
    inherit OpenXmlPartRootElement

Public Class Workbook
Inherits OpenXmlPartRootElement

继承

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

Workbook

示例

下面的代码示例打开一个现有的电子表格文档，并添加名为“mySheet”的新工作表，并将其与工作簿相关联。

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

namespace WorkbookEx  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            string fileName = @"C:\Users\Public\Documents\WorkbookEx.xlsx";  
            // Open an existing spreadsheet document for editing.  
            using (SpreadsheetDocument spreadSheet = SpreadsheetDocument.Open(fileName, true))  
            {  
                // Add a blank WorksheetPart.  
                WorksheetPart newWorksheetPart = spreadSheet.WorkbookPart.AddNewPart<WorksheetPart>();  
                newWorksheetPart.Worksheet = new Worksheet(new SheetData());  

                // Create a Sheets object in the Workbook.  
                Sheets sheets = spreadSheet.WorkbookPart.Workbook.GetFirstChild<Sheets>();  
                string relationshipId = spreadSheet.WorkbookPart.GetIdOfPart(newWorksheetPart);  

                // Create a unique ID for the new worksheet.  
                uint sheetId = 1;  
                if (sheets.Elements<Sheet>().Count() > 0)  
                {  
                    sheetId = sheets.Elements<Sheet>().Select(s => s.SheetId.Value).Max() + 1;  
                }  

                // Give the new worksheet a name.  
                string sheetName = "mySheet" + sheetId;  

                // Append the new worksheet and associate it with the workbook.  
                Sheet sheet = new Sheet() { Id = relationshipId, SheetId = sheetId, Name = sheetName };  
                sheets.Append(sheet);  
            }  
            Console.WriteLine("All done. Press a key.");  
            Console.ReadKey();  
        }  
    }  
}  

Imports System.Linq  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Spreadsheet  
Module Module1  
    Sub Main()  
        Dim fileName As String = "C:\Users\Public\Documents\WorkbookEx.xlsx"  
        ' Open an existing spreadsheet document for editing.  
        Dim spreadSheet As SpreadsheetDocument = SpreadsheetDocument.Open(fileName, True)  
        Using (spreadSheet)  
            ' Add a blank WorksheetPart.  
            Dim newWorksheetPart As WorksheetPart = spreadSheet.WorkbookPart.AddNewPart(Of WorksheetPart)()  
            newWorksheetPart.Worksheet = New Worksheet(New SheetData())  

            ' Create a Sheets object.  
            Dim sheets As Sheets = spreadSheet.WorkbookPart.Workbook.GetFirstChild(Of Sheets)()  
            Dim relationshipId As String = spreadSheet.WorkbookPart.GetIdOfPart(newWorksheetPart)  

            ' Get a unique ID for the new worksheet.  
            Dim sheetId As UInteger = 1  
            If (sheets.Elements(Of Sheet).Count > 0) Then  
                sheetId = sheets.Elements(Of Sheet).Select(Function(s) s.SheetId.Value).Max + 1  
            End If  

            ' Give the new worksheet a name.  
            Dim sheetName As String = ("mySheet" + sheetId.ToString())  

            ' Append the new worksheet and associate it with the workbook.  
            Dim sheet As Sheet = New Sheet  
            sheet.Id = relationshipId  
            sheet.SheetId = sheetId  
            sheet.Name = sheetName  
            sheets.Append(sheet)  
        End Using  
        Console.WriteLine("All done. Press a key.")  
        Console.ReadKey()  
    End Sub  
End Module  

注解

[ISO/IEC 29500-1 第 1 版]

工作簿 (工作簿)

workbook 元素是顶级元素。 它包含包含工作簿的数据内容的元素和属性。 工作簿的子元素各有其自己的子元素引用，这些引用显示在下面的子元素表中。 这些元素表示的工作簿结构的部分列表如下：

• 工作表：表示工作簿中工作表的集合。 工作表是工作簿中的中心结构，包含工作簿的文本、数字、日期、公式和其他元素。

• 视图：SpreadsheetML 定义工作簿视图的集合，这些视图定义工作簿的基本窗口尺寸和位置（如果工作簿曾经由电子表格应用程序显示）。 它还定义了自定义工作簿视图的集合，该集合允许 SpreadsheetML 描述工作簿中数据的一个或多个视图。

• 属性：工作簿具有多个属性集合，用于存储基本工作簿设置，例如要使用的日期系统、文件保护设置、计算设置和智能标记行为。

• 名称：表示单元格、单元格区域、公式或常量值的字符的单词或字符串。

[示例：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>  
<workbook xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/5/main" mlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">  
  <fileVersion lastEdited="4" lowestEdited="4" rupBuild="4017"/>  
  <workbookPr dateCompatibility="false" vbName="ThisWorkbook" defaultThemeVersion="123820"/>  
  <bookViews>  
    <workbookView xWindow="120" yWindow="45" windowWidth="15135"      windowHeight="7650" activeTab="4"/>  
  </bookViews>  
  <sheets>  
    <sheet name="Sheet1" sheetId="1" r:id="rId1"/>  
    <sheet name="Sheet2" sheetId="2" r:id="rId2"/>  
    <sheet name="Sheet5" sheetId="3" r:id="rId3"/>  
    <sheet name="Chart1" sheetId="4" type="chartsheet" r:id="rId4"/>  
  </sheets>  
  <definedNames>  
    <definedName name="MyDefinedName">Sheet3!$A$1:$C$12</definedName>  
  </definedNames>  
  <calcPr calcId="122211" calcMode="autoNoTable" refMode="R1C1" iterate="1"    fullPrecision="0"/>  
  <customWorkbookViews>  
    <customWorkbookView name="CustomView1"       guid="{CE6681F1-E999-414D-8446-68A031534B57}" maximized="1" xWindow="1"       yWindow="1" windowWidth="1024" windowHeight="547" activeSheetId="1"/>  
  </customWorkbookViews>  
  <pivotCaches>  
    <pivotCache cacheId="0" r:id="rId8"/>  
  </pivotCaches>  
  <smartTagPr embed="1" show="noIndicator"/>  
  <smartTagTypes>  
    <smartTagType namespaceUri="urn:schemas-openxmlformats-org:office:smarttags"       name="date"/>  
  </smartTagTypes>  
  <webPublishing codePage="1252"/>  
</workbook>  

示例结束]

父元素
SpreadsheetML 工作簿部件的根元素

子元素	第
bookViews (工作簿视图)	§18.2.1
calcPr (计算属性)	§18.2.2
customWorkbookViews (自定义工作簿视图)	§18.2.4
definedNames (定义名称)	§18.2.6
externalReferences (外部引用)	§18.2.9
extLst (Future Feature Data Storage Area)	§18.2.10
fileRecoveryPr (文件恢复属性)	§18.2.11
fileSharing (文件共享)	§18.2.12
fileVersion (文件版本)	§18.2.13
functionGroups (函数组)	§18.2.15
oleSize (Embedded 对象大小)	§18.2.16
pivotCaches (PivotCaches)	§18.2.18
工作表 (工作表)	§18.2.20
smartTagPr (智能标记属性)	§18.2.21
smartTagTypes (智能标记类型)	§18.2.23
web 发布 (Web 发布属性)	§18.2.24
webPublishObjects (Web 发布对象)	§18.2.26
workbookPr (工作簿属性)	§18.2.28
workbookProtection (Workbook Protection)	§18.2.29

[注意：此元素的内容模型 (CT_Workbook) 的 W3C XML 架构定义位于 §A.2 中。 注释结束]

ISO/IEC29500：2008。

构造函数

Workbook()	初始化 Workbook 类的新实例。
Workbook(IEnumerable<OpenXmlElement>)	使用指定的子元素初始化 Workbook 类的新实例。
Workbook(OpenXmlElement[])	使用指定的子元素初始化 Workbook 类的新实例。
Workbook(String)	从外部 XML 初始化 Workbook 类的新实例。

属性

AbsolutePath	AbsolutePath，此属性仅在 Office 2013 及更高版本中可用。 表示架构中的以下元素标记：x15ac：absPath。
BookViews	BookViews。 表示架构中的以下元素标记：x：bookViews。
CalculationProperties	CalculationProperties。 表示架构中的以下元素标记：x：calcPr。
ChildElements	获取当前元素的所有子节点。 (继承自 OpenXmlElement)
Conformance	一致性 表示架构中的以下属性：符合性
CustomWorkbookViews	CustomWorkbookViews。 表示架构中的以下元素标记：x：customWorkbookViews。
DefinedNames	DefinedNames。 表示架构中的以下元素标记：x：definedNames。
ExtendedAttributes	获取当前元素的架构) 中未定义的所有扩展属性 (属性。 (继承自 OpenXmlElement)
ExternalReferences	ExternalReferences。 表示架构中的以下元素标记：x：externalReferences。
Features	IFeatureCollection获取当前元素的 。 此功能集合将是只读的，但会从其父部件和包继承功能（如果可用）。 (继承自 OpenXmlElement)
FileSharing	文件共享。 表示架构中的以下元素标记：x：fileSharing。
FileVersion	FileVersion。 表示架构中的以下元素标记：x：fileVersion。
FirstChild	获取当前 OpenXmlElement 元素的第一个子元素。 (继承自 OpenXmlCompositeElement)
FunctionGroups	FunctionGroups。 表示架构中的以下元素标记：x：functionGroups。
HasAttributes	获取一个值，该值指示当前元素是否具有任何属性。 (继承自 OpenXmlElement)
HasChildren	获取一个值，该值指示当前元素是否具有任何子元素。 (继承自 OpenXmlCompositeElement)
InnerText	获取或设置当前节点及其所有子节点的串联值。 (继承自 OpenXmlCompositeElement)
InnerXml	获取或设置仅表示当前节点的子节点的标记。 (继承自 OpenXmlCompositeElement)
LastChild	获取当前 OpenXmlElement 元素的最后一个子元素。 如果没有这样的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlCompositeElement)
LocalName	获取当前元素的本地名称。 (继承自 OpenXmlElement)
MCAttributes	获取或设置标记兼容性属性。 如果未为当前元素定义标记兼容性属性，则返回 null。 (继承自 OpenXmlElement)
NamespaceDeclarations	获取在当前元素中定义的所有命名空间声明。 如果没有命名空间声明，则返回空枚举器。 (继承自 OpenXmlElement)
NamespaceUri	获取当前元素的命名空间 URI。 (继承自 OpenXmlElement)
OleSize	OleSize。 表示架构中的以下元素标记：x：oleSize。
OpenXmlElementContext	获取当前元素的 OpenXmlElementContext。 (继承自 OpenXmlElement)
OpenXmlPart	获取与 DOM 树关联的部分。 当 DOM 树未与部件关联时，它返回 null。 (继承自 OpenXmlPartRootElement)
OuterXml	获取表示当前元素及其所有子元素的标记。 (继承自 OpenXmlElement)
Parent	获取当前元素的父元素。 (继承自 OpenXmlElement)
PivotCaches	PivotCaches。 表示架构中的以下元素标记：x：pivotCaches。
Prefix	获取当前元素的命名空间前缀。 (继承自 OpenXmlElement)
Sheets	床单。 表示架构中的以下元素标记：x：sheets。
WebPublishing	Web 发布。 表示架构中的以下元素标记：x：webPublishing。
WorkbookPart	获取与此元素关联的 WorkbookPart。
WorkbookProperties	WorkbookProperties。 表示架构中的以下元素标记：x：workbookPr。
WorkbookProtection	WorkbookProtection。 表示架构中的以下元素标记：x：workbookProtection。
XmlQualifiedName	获取当前元素的限定名称。 (继承自 OpenXmlElement)
XName	获取当前元素的限定名称。 (继承自 OpenXmlElement)

方法

AddAnnotation(Object)	将 对象添加到当前 OpenXmlElement 元素的批注列表中。 (继承自 OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	如果指定元素是已知的子元素，则将其添加到 元素。 这会根据架构将 元素添加到正确的位置。 (继承自 OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	将命名空间声明添加到当前节点。 (继承自 OpenXmlElement)
Ancestors()	枚举当前元素的所有上级。 (继承自 OpenXmlElement)
Ancestors<T>()	仅枚举具有指定类型的当前元素的上级。 (继承自 OpenXmlElement)
Annotation(Type)	从当前 OpenXmlElement 元素获取指定类型的第一个批注对象。 (继承自 OpenXmlElement)
Annotation<T>()	从当前 OpenXmlElement 元素获取指定类型的第一个批注对象。 (继承自 OpenXmlElement)
Annotations(Type)	获取具有当前 OpenXmlElement 元素的指定类型的批注的集合。 (继承自 OpenXmlElement)
Annotations<T>()	获取具有当前 OpenXmlElement 元素的指定类型的批注的集合。 (继承自 OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	将元素列表中的每个元素追加到当前元素的子元素列表的末尾。 (继承自 OpenXmlElement)
Append(OpenXmlElement[])	将元素数组中的每个元素追加到当前元素的子元素列表的末尾。 (继承自 OpenXmlElement)
AppendChild<T>(T)	将指定的元素追加到当前元素的子节点列表的末尾。 (继承自 OpenXmlCompositeElement)
ClearAllAttributes()	清除所有属性，包括已知属性和扩展属性。 (继承自 OpenXmlElement)
Clone()	创建当前节点的副本。 (继承自 OpenXmlElement)
CloneNode(Boolean)	创建此节点的副本。
Descendants()	枚举当前元素的所有后代。 (继承自 OpenXmlElement)
Descendants<T>()	枚举类型为 T 的当前元素的所有后代。 (继承自 OpenXmlElement)
Elements()	枚举当前元素的所有子元素。 (继承自 OpenXmlElement)
Elements<T>()	仅枚举具有指定类型的当前元素的子元素。 (继承自 OpenXmlElement)
ElementsAfter()	枚举与当前元素相同的父级的所有同级元素。 (继承自 OpenXmlElement)
ElementsBefore()	枚举当前元素之前且具有与当前元素相同的父级的所有同级元素。 (继承自 OpenXmlElement)
GetAttribute(String, String)	获取具有指定标记名称和命名空间 URI 的 Open XML 属性。 (继承自 OpenXmlElement)
GetAttributes()	获取一个列表，该列表包含所有属性的副本。 (继承自 OpenXmlElement)
GetEnumerator()	返回循环访问子集合的枚举器。 (继承自 OpenXmlElement)
GetFirstChild<T>()	查找类型 T 中的第一个子元素。 (继承自 OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	在指定的引用元素之后立即插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	在当前元素之后立即插入指定的元素。 (继承自 OpenXmlElement)
InsertAt<T>(T, Int32)	在当前元素的子元素的指定索引处插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	将指定的元素紧接在指定的引用元素之前。 (继承自 OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	将指定的元素紧接在当前元素的前面。 (继承自 OpenXmlElement)
IsAfter(OpenXmlElement)	确定当前元素是否以文档顺序显示在指定元素之后。 (继承自 OpenXmlElement)
IsBefore(OpenXmlElement)	确定当前元素是否按文档顺序显示在指定元素之前。 (继承自 OpenXmlElement)
Load(WorkbookPart)	从 WorkbookPart 加载 DOM
LookupNamespace(String)	解析当前节点上下文中的命名空间前缀。 (继承自 OpenXmlElement)
LookupPrefix(String)	查找当前元素范围内命名空间 URI 的相应前缀。 (继承自 OpenXmlElement)
NextSibling()	获取紧跟在当前 OpenXmlElement 元素后面的 OpenXmlElement 元素。 如果没有下一个 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
NextSibling<T>()	获取具有当前 OpenXmlElement 元素后面的指定类型的 OpenXmlElement 元素。 如果没有下一个 OpenXmlElement，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
PrependChild<T>(T)	在当前元素的子节点列表的开头插入指定的元素。 (继承自 OpenXmlCompositeElement)
PreviousSibling()	获取紧接在当前 OpenXmlElement 元素之前的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic ) 中 Nothing。 (继承自 OpenXmlElement)
PreviousSibling<T>()	获取位于当前 OpenXmlElement 之前的指定类型的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
Reload()	将部件内容重新加载到 Open XML DOM 树中。 此方法可以多次调用，每次调用它时，都会重新加载树，并放弃树上的先前更改。 (继承自 OpenXmlPartRootElement)
Remove()	从其父元素中删除当前元素。 (继承自 OpenXmlElement)
RemoveAllChildren()	删除当前元素的所有子元素。 (继承自 OpenXmlCompositeElement)
RemoveAllChildren<T>()	删除类型为 T 的当前元素的所有子元素。 (继承自 OpenXmlElement)
RemoveAnnotations(Type)	从当前 OpenXmlElement 元素中删除指定类型的注释。 (继承自 OpenXmlElement)
RemoveAnnotations<T>()	从当前 OpenXmlElement 元素中删除具有指定类型的批注。 (继承自 OpenXmlElement)
RemoveAttribute(String, String)	从当前元素中删除 属性。 (继承自 OpenXmlElement)
RemoveChild<T>(T)	删除指定的子元素。 (继承自 OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	删除指定前缀的命名空间声明。 如果没有前缀，则不删除任何内容。 (继承自 OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	将当前元素的子元素之一替换为另一个 OpenXmlElement 元素。 (继承自 OpenXmlCompositeElement)
Save()	将 DOM 树中的数据保存回 部件。 此方法可以多次调用，每次调用时，都会刷新流。 (继承自 OpenXmlPartRootElement)
Save(Stream)	将 DOM 树保存到指定的流。 (继承自 OpenXmlPartRootElement)
Save(WorkbookPart)	将 DOM 保存到 WorkbookPart。
SetAttribute(OpenXmlAttribute)	将特性设置为指定的元素。 如果该属性是已知属性，则设置该特性的值。 如果该属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	设置元素的多个属性。 如果属性是已知属性，则会设置该属性的值。 如果属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
WriteTo(XmlWriter)	将当前节点保存到指定的 XmlWriter。 (继承自 OpenXmlPartRootElement)

显式接口实现

IEnumerable.GetEnumerator()	练习 册。 此类在 Office 2007 及更高版本中可用。 当对象序列化为 xml 时，其限定名称为 x：workbook。 (继承自 OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	返回循环访问子集合的枚举器。 (继承自 OpenXmlElement)