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 издание]

книга (книга)

Элемент книги является элементом верхнего уровня. Он содержит элементы и атрибуты, охватывающие содержимое данных книги. Дочерние элементы книги имеют собственные ссылки на вложенные элементы, которые показаны в таблице дочерних элементов ниже. Частичный список структур книги, которые представляют эти элементы:

• Листы: представляет коллекцию листов в книге. Листы являются центральной структурой в книге и содержат текст, числа, даты, формулы и другие элементы книги.

• Представления. 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 (область хранения данных о будущих компонентах)	§18.2.10
fileRecoveryPr (свойства восстановления файлов)	§18.2.11
fileSharing (общий доступ к файлам)	§18.2.12
fileVersion (версия файла)	§18.2.13
functionGroups (группы функций)	§18.2.15
oleSize (размер внедренного объекта)	§18.2.16
PivotCaches (PivotCaches)	§18.2.18
листы (листы)	§18.2.20
smartTagPr (свойства смарт-тега)	§18.2.21
smartTagTypes (типы смарт-тегов)	§18.2.23
webPublishing (свойства веб-публикации)	§18.2.24
webPublishObjects (объекты веб-публикации)	§18.2.26
workbookPr (свойства книги)	§18.2.28
workbookProtection (Защита книги)	§18.2.29

[Примечание. Определение xml-схемы W3C для модели содержимого этого элемента (CT_Workbook) находится в §A.2. конечная заметка]

ISO/IEC29500: 2008.

Конструкторы

Workbook()	Инициализирует новый экземпляр класса Workbook.
Workbook(IEnumerable<OpenXmlElement>)	Инициализирует новый экземпляр класса Workbook указанными дочерними элементами.
Workbook(OpenXmlElement[])	Инициализирует новый экземпляр класса Workbook указанными дочерними элементами.
Workbook(String)	Инициализирует новый экземпляр класса Workbook из внешнего XML-кода.

Свойства

AbsolutePath	AbsolutePath, это свойство доступно только в Office 2013 и более поздних версиях. Представляет следующий тег элемента в схеме: x15ac:absPath.
BookViews	BookViews. Представляет следующий тег элемента в схеме: x:bookViews.
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. Возвращает значение NULL (Nothing в Visual Basic), если такого элемента OpenXmlElement нет. (Унаследовано от OpenXmlCompositeElement)
LocalName	Возвращает локальное имя текущего элемента. (Унаследовано от OpenXmlElement)
MCAttributes	Возвращает или задает атрибуты совместимости разметки. Возвращает значение NULL, если для текущего элемента не определены атрибуты совместимости разметки. (Унаследовано от OpenXmlElement)
NamespaceDeclarations	Возвращает все объявления пространства имен, определенные в текущем элементе. Возвращает пустой перечислитель, если нет объявления пространства имен. (Унаследовано от OpenXmlElement)
NamespaceUri	Возвращает универсальный код ресурса (URI) пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
OleSize	Olesize. Представляет следующий тег элемента в схеме: x:oleSize.
OpenXmlElementContext	Возвращает openXmlElementContext текущего элемента. (Унаследовано от OpenXmlElement)
OpenXmlPart	Возвращает часть, связанную с деревом DOM. Он возвращает значение NULL, если дерево DOM не связано с частью. (Унаследовано от OpenXmlPartRootElement)
OuterXml	Возвращает разметку, представляющую текущий элемент и все его дочерние элементы. (Унаследовано от OpenXmlElement)
Parent	Возвращает родительский элемент текущего элемента. (Унаследовано от OpenXmlElement)
PivotCaches	Сводные таблицы. Представляет следующий тег элемента в схеме: x:pivotCaches.
Prefix	Возвращает префикс пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
Sheets	Листы. Представляет следующий тег элемента в схеме: x:sheets.
WebPublishing	Веб-публикация. Представляет следующий тег элемента в схеме: 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)	Возвращает атрибут Open XML с указанным именем тега и URI пространства имен. (Унаследовано от 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)	Загружает DOM из WorkbookPart
LookupNamespace(String)	Разрешает префикс пространства имен в контексте текущего узла. (Унаследовано от OpenXmlElement)
LookupPrefix(String)	Находит соответствующий префикс для URI пространства имен в текущем элементе область. (Унаследовано от OpenXmlElement)
NextSibling()	Возвращает элемент OpenXmlElement, который сразу же следует за текущим элементом OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет следующего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
NextSibling<T>()	Возвращает элемент OpenXmlElement с указанным типом, который следует за текущим элементом OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет следующего OpenXmlElement. (Унаследовано от OpenXmlElement)
PrependChild<T>(T)	Вставляет указанный элемент в начало списка дочерних узлов текущего элемента. (Унаследовано от OpenXmlCompositeElement)
PreviousSibling()	Возвращает элемент OpenXmlElement, который непосредственно предшествует текущему элементу OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
PreviousSibling<T>()	Возвращает элемент OpenXmlElement с указанным типом, который предшествует текущему объекту OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Reload()	Перезагружает содержимое части в дерево DOM Open XML. Этот метод можно вызвать несколько раз, и при каждом вызове дерево будет перезагружено, а предыдущие изменения в дереве будут отменены. (Унаследовано от 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)