Workbook Classe

Definição

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Livro.

Esta classe está disponível no Office 2007 e superior.

Quando o objeto é serializado como xml, o nome qualificado é x:workbook.

public class Workbook : DocumentFormat.OpenXml.OpenXmlPartRootElement

Herança

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

Workbook

Exemplos

O seguinte exemplo de código abre um documento de folha de cálculo existente e adiciona uma nova folha de cálculo com o nome "mySheet" e associa-a ao livro.

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  

Comentários

[ISO/IEC 29500-1 1st Edition]

livro (Livro)

O elemento do livro é o elemento de nível superior. Contém elementos e atributos que abrangem o conteúdo de dados do livro. Cada um dos elementos subordinados do livro tem as suas próprias referências de subclausta e estes são apresentados na tabela de elementos subordinados abaixo. Uma lista parcial das estruturas do livro que estes elementos representam são:

• Folhas: representa a coleção de folhas de cálculo no livro. As folhas são a estrutura central num livro e contêm o texto, números, datas, fórmulas e outros elementos de um livro.

• Vistas: a Folha de CálculoML define uma coleção de vistas de Livro que definem as dimensões básicas da janela e a posição do livro, se alguma vez forem apresentadas por uma aplicação de folha de cálculo. Também define uma coleção de Vistas de Livro Personalizadas que permite que a Folha de CálculoML descreva uma ou mais vistas dos dados num livro.

• Propriedades: o livro tem várias coleções de propriedades que armazenam definições básicas do livro, como o sistema de datas a utilizar, definições de proteção de ficheiros, definições de cálculo e comportamentos de etiquetas inteligentes.

• Nomes: palavras ou cadeias de carateres que representam células, intervalos de células, fórmulas ou valores constantes.

[Exemplo:

<?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>  

exemplo final]

Elementos pai
Elemento raiz da peça Livro de Folha de CálculoML

Elementos filho	Subclautilizar
bookViews (Vistas de Livro)	§18.2.1
calcPr (Propriedades de Cálculo)	§18.2.2
customWorkbookViews (Vistas de Livro Personalizadas)	§18.2.4
definedNames (Nomes Definidos)	§18.2.6
externalReferences (Referências Externas)	§18.2.9
extLst (Área de Armazenamento de Dados de Funcionalidades Futuras)	§18.2.10
fileRecoveryPr (Propriedades de Recuperação de Ficheiros)	§18.2.11
fileSharing (Partilha de Ficheiros)	§18.2.12
fileVersion (Versão do Ficheiro)	§18.2.13
functionGroups (Grupos de Funções)	§18.2.15
oleSize (Tamanho do Objeto Incorporado)	§18.2.16
PivotCaches (PivotCaches)	§18.2.18
folhas (Folhas)	§18.2.20
smartTagPr (Propriedades da Etiqueta Inteligente)	§18.2.21
smartTagTypes (Tipos de Etiquetas Inteligentes)	§18.2.23
webPublishing (Propriedades de Publicação na Web)	§18.2.24
webPublishObjects (Objetos de Publicação Web)	§18.2.26
workbookPr (Propriedades do Livro)	§18.2.28
workbookProtection (Proteção do Livro)	§18.2.29

[Nota: a definição de Esquema XML W3C do modelo de conteúdo deste elemento (CT_Workbook) está localizada em {A.2. nota de fim]

ISO/IEC29500: 2008.

Construtores

Workbook()	Inicializa uma nova instância da classe Livro.
Workbook(IEnumerable<OpenXmlElement>)	Inicializa uma nova instância da classe Livro com os elementos subordinados especificados.
Workbook(OpenXmlElement[])	Inicializa uma nova instância da classe Livro com os elementos subordinados especificados.
Workbook(String)	Inicializa uma nova instância da classe Livro a partir de XML externo.

Propriedades

AbsolutePath	AbsolutePath, esta propriedade só está disponível no Office 2013 e posterior. Representa a seguinte etiqueta de elemento no esquema: x15ac:absPath.
BookViews	BookViews. Representa a seguinte etiqueta de elemento no esquema: x:bookViews.
CalculationProperties	CalculationProperties. Representa a seguinte etiqueta de elemento no esquema: x:calcPr.
ChildElements	Obtém todos os nós subordinados do elemento atual. (Herdado de OpenXmlElement)
Conformance	conformidade Representa o seguinte atributo no esquema: conformidade
CustomWorkbookViews	CustomWorkbookViews. Representa a seguinte etiqueta de elemento no esquema: x:customWorkbookViews.
DefinedNames	DefinedNames. Representa a seguinte etiqueta de elemento no esquema: x:definedNames.
ExtendedAttributes	Obtém todos os atributos expandidos (atributos não definidos no esquema) do elemento atual. (Herdado de OpenXmlElement)
ExternalReferences	ExternalReferences. Representa a seguinte etiqueta de elemento no esquema: x:externalReferences.
Features	Obtém um IFeatureCollection para o elemento atual. Esta coleção de funcionalidades será só de leitura, mas herdará as funcionalidades da parte principal e do pacote, se disponível. (Herdado de OpenXmlElement)
FileSharing	Partilha de Ficheiros. Representa a seguinte etiqueta de elemento no esquema: x:fileSharing.
FileVersion	FileVersion. Representa a seguinte etiqueta de elemento no esquema: x:fileVersion.
FirstChild	Obtém o primeiro elemento subordinado do elemento OpenXmlElement atual. (Herdado de OpenXmlCompositeElement)
FunctionGroups	FunctionGroups. Representa a seguinte etiqueta de elemento no esquema: x:functionGroups.
HasAttributes	Obtém um valor que indica se o elemento atual tem atributos. (Herdado de OpenXmlElement)
HasChildren	Obtém um valor que indica se o elemento atual tem elementos subordinados. (Herdado de OpenXmlCompositeElement)
InnerText	Obtém ou define os valores concatenados do nó atual e de todos os respetivos subordinados. (Herdado de OpenXmlCompositeElement)
InnerXml	Obtém ou define a marcação que representa apenas os nós subordinados do nó atual. (Herdado de OpenXmlCompositeElement)
LastChild	Obtém o último elemento subordinado do elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir esse elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement)
LocalName	Obtém o nome local do elemento atual. (Herdado de OpenXmlElement)
MCAttributes	Obtém ou define os atributos de compatibilidade de markup. Devolve nulo se não forem definidos atributos de compatibilidade de markup para o elemento atual. (Herdado de OpenXmlElement)
NamespaceDeclarations	Obtém todas as declarações de espaço de nomes definidas no elemento atual. Devolve um enumerador vazio se não existir nenhuma declaração de espaço de nomes. (Herdado de OpenXmlElement)
NamespaceUri	Obtém o URI do espaço de nomes do elemento atual. (Herdado de OpenXmlElement)
OleSize	OleSize. Representa a seguinte etiqueta de elemento no esquema: x:oleSize.
OpenXmlElementContext	Obtém o OpenXmlElementContext do elemento atual. (Herdado de OpenXmlElement)
OpenXmlPart	Obtém a parte que está associada à árvore DOM. Devolve nulo quando a árvore DOM não está associada a uma peça. (Herdado de OpenXmlPartRootElement)
OuterXml	Obtém a marcação que representa o elemento atual e todos os respetivos elementos subordinados. (Herdado de OpenXmlElement)
Parent	Obtém o elemento principal do elemento atual. (Herdado de OpenXmlElement)
PivotCaches	PivotCaches. Representa a seguinte etiqueta de elemento no esquema: x:pivotCaches.
Prefix	Obtém o prefixo de espaço de nomes do elemento atual. (Herdado de OpenXmlElement)
Sheets	Folhas. Representa a seguinte etiqueta de elemento no esquema: x:sheets.
WebPublishing	WebPublishing. Representa a seguinte etiqueta de elemento no esquema: x:webPublishing.
WorkbookPart	Obtém a Peça de Livro associada a este elemento.
WorkbookProperties	WorkbookProperties. Representa a seguinte etiqueta de elemento no esquema: x:workbookPr.
WorkbookProtection	WorkbookProtection. Representa a seguinte etiqueta de elemento no esquema: x:workbookProtection.
XmlQualifiedName	Obtém o nome qualificado do elemento atual. (Herdado de OpenXmlElement)
XName	Obtém o nome qualificado do elemento atual. (Herdado de OpenXmlElement)

Métodos

AddAnnotation(Object)	Adiciona um objeto à lista de anotações do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adiciona o elemento especificado ao elemento se for um subordinado conhecido. Esta ação adiciona o elemento na localização correta de acordo com o esquema. (Herdado de OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adiciona uma declaração de espaço de nomes ao nó atual. (Herdado de OpenXmlElement)
Ancestors()	Enumera todos os predecessores do elemento atual. (Herdado de OpenXmlElement)
Ancestors<T>()	Enumera apenas os predecessores do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
Annotation(Type)	Obtenha o primeiro objeto de anotação do tipo especificado a partir do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotation<T>()	Obtenha o primeiro objeto de anotação do tipo especificado a partir do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotations(Type)	Obtém uma coleção de anotações com o tipo especificado para o elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotations<T>()	Obtém uma coleção de anotações com o tipo especificado para o elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Acrescenta cada elemento de uma lista de elementos ao fim da lista de elementos subordinados do elemento atual. (Herdado de OpenXmlElement)
Append(OpenXmlElement[])	Acrescenta cada elemento de uma matriz de elementos ao fim da lista de elementos subordinados do elemento atual. (Herdado de OpenXmlElement)
AppendChild<T>(T)	Acrescenta o elemento especificado ao fim da lista de nós subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
ClearAllAttributes()	Limpa todos os atributos, incluindo atributos conhecidos e atributos expandidos. (Herdado de OpenXmlElement)
Clone()	Cria um duplicado do nó atual. (Herdado de OpenXmlElement)
CloneNode(Boolean)	Cria um duplicado deste nó.
Descendants()	Enumera todos os descendentes do elemento atual. (Herdado de OpenXmlElement)
Descendants<T>()	Enumerar todos os descendentes do elemento atual do tipo T. (Herdado de OpenXmlElement)
Elements()	Enumera todos os elementos subordinados do elemento atual. (Herdado de OpenXmlElement)
Elements<T>()	Enumera apenas os subordinados do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
ElementsAfter()	Enumera todos os elementos do elemento colateral que seguem o elemento atual e têm o mesmo elemento principal que o elemento atual. (Herdado de OpenXmlElement)
ElementsBefore()	Enumera todos os elementos do elemento colateral que precedem o elemento atual e têm o mesmo elemento principal que o elemento atual. (Herdado de OpenXmlElement)
GetAttribute(String, String)	Obtém um atributo Open XML com o nome da etiqueta especificado e o URI do espaço de nomes. (Herdado de OpenXmlElement)
GetAttributes()	Obtém uma lista que contém uma cópia de todos os atributos. (Herdado de OpenXmlElement)
GetFirstChild<T>()	Localiza o primeiro elemento subordinado no tipo T. (Herdado de OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Insere o elemento especificado imediatamente após o elemento de referência especificado. (Herdado de OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Insere o elemento especificado imediatamente após o elemento atual. (Herdado de OpenXmlElement)
InsertAt<T>(T, Int32)	Insere o elemento especificado no índice especificado dos subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Insere o elemento especificado imediatamente antes do elemento de referência especificado. (Herdado de OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Insere o elemento especificado imediatamente antes do elemento atual. (Herdado de OpenXmlElement)
IsAfter(OpenXmlElement)	Determina se o elemento atual aparece depois de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
IsBefore(OpenXmlElement)	Determina se o elemento atual aparece antes de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
Load(WorkbookPart)	Carrega o DOM a partir da Peça de Livro
LookupNamespace(String)	Resolve o prefixo do espaço de nomes no contexto do nó atual. (Herdado de OpenXmlElement)
LookupPrefix(String)	Localiza o prefixo correspondente para um URI de espaço de nomes no âmbito do elemento atual. (Herdado de OpenXmlElement)
NextSibling()	Obtém o elemento OpenXmlElement que segue imediatamente o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement seguinte. (Herdado de OpenXmlElement)
NextSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que segue o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir um OpenXmlElement seguinte. (Herdado de OpenXmlElement)
PrependChild<T>(T)	Insere o elemento especificado no início da lista de nós subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
PreviousSibling()	Obtém o elemento OpenXmlElement que precede imediatamente o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
PreviousSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que precede o OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
Reload()	Recarrega o conteúdo da peça para uma árvore DOM Open XML. Este método pode ser chamado várias vezes e, sempre que for chamado, a árvore será recarregada e as alterações anteriores na árvore serão abandonadas. (Herdado de OpenXmlPartRootElement)
Remove()	Remove o elemento atual do respetivo elemento principal. (Herdado de OpenXmlElement)
RemoveAllChildren()	Remove todos os elementos subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remova todos os elementos subordinados do elemento atual que são do tipo T. (Herdado de OpenXmlElement)
RemoveAnnotations(Type)	Remove as anotações do tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
RemoveAnnotations<T>()	Remove as anotações com o tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
RemoveAttribute(String, String)	Remove o atributo do elemento atual. (Herdado de OpenXmlElement)
RemoveChild<T>(T)	Remove o elemento subordinado especificado. (Herdado de OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Remove a declaração de espaço de nomes para o prefixo especificado. Não remove nada se não existir um prefixo. (Herdado de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Substitui um dos elementos subordinados do elemento atual por outro elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement)
Save()	Guarda os dados na árvore DOM novamente na peça. Este método pode ser chamado várias vezes e, sempre que for chamado, o fluxo será descarregado. (Herdado de OpenXmlPartRootElement)
Save(Stream)	Guarda a árvore DOM no fluxo especificado. (Herdado de OpenXmlPartRootElement)
Save(WorkbookPart)	Guarda o DOM na Peça de Livro.
SetAttribute(OpenXmlAttribute)	Define um atributo para o elemento especificado. Se o atributo for um atributo conhecido, o valor do atributo é definido. Se o atributo for um atributo expandido, o "openxmlAttribute" é adicionado à lista de atributos expandidos. (Herdado de OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Define vários atributos para o elemento . Se um atributo for um atributo conhecido, o valor do atributo é definido. Se um atributo for um atributo expandido, o "openxmlAttribute" é adicionado à lista de atributos expandidos. (Herdado de OpenXmlElement)
WriteTo(XmlWriter)	Guarda o nó atual no XmlWriter especificado. (Herdado de OpenXmlPartRootElement)

Implantações explícitas de interface

IEnumerable.GetEnumerator()	Livro. Esta classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, o nome qualificado é x:workbook. (Herdado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Devolve um enumerador que itera através da coleção subordinada. (Herdado de OpenXmlElement)