Workbook Classe

Definição

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Workbook.

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

Quando o objeto é serializado como xml, seu nome qualificado é x:pasta de trabalho.

public class Workbook : DocumentFormat.OpenXml.OpenXmlPartRootElement

type Workbook = class
    inherit OpenXmlPartRootElement

Public Class Workbook
Inherits OpenXmlPartRootElement

Herança

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

Workbook

Exemplos

O exemplo de código a seguir abre um documento de planilha existente e adiciona uma nova planilha, chamada "mySheet", e o associa à pasta de trabalho.

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]

pasta de trabalho (Pasta de Trabalho)

O elemento workbook é o elemento de nível superior. Ele contém elementos e atributos que abrangem o conteúdo de dados da pasta de trabalho. Os elementos filho da pasta de trabalho têm suas próprias referências de subclausa e elas são mostradas na tabela de elementos filho abaixo. Uma lista parcial das estruturas da pasta de trabalho que esses elementos representam são:

• Planilhas: representa a coleção de planilhas na pasta de trabalho. As planilhas são a estrutura central dentro de uma pasta de trabalho e contêm o texto, números, datas, fórmulas e outros elementos de uma pasta de trabalho.

• Exibições: SpreadsheetML define uma coleção de exibições de pasta de trabalho que definem dimensões básicas da janela e posição da pasta de trabalho se ela for exibida por um aplicativo de planilha. Ele também define uma coleção de Exibições de Pasta de Trabalho Personalizadas que permite que o SpreadsheetML descreva uma ou mais exibições dos dados em uma pasta de trabalho.

• Propriedades: a pasta de trabalho tem várias coleções de propriedades que armazenam configurações básicas da pasta de trabalho, como o sistema de data a ser usado, configurações de proteção de arquivo, configurações de cálculo e comportamentos de marca inteligente.

• Nomes: palavras ou cadeias de caracteres 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 parte da pasta de trabalho spreadsheetML

Elementos filho	Subclause
bookViews (Exibições de pasta de trabalho)	§18.2.1
calcPr (propriedades de cálculo)	§18.2.2
customWorkbookViews (Exibições personalizadas da pasta de trabalho)	§18.2.4
definedNames (Nomes Definidos)	§18.2.6
externalReferences (Referências Externas)	§18.2.9
extLst (Área de Armazenamento de Dados de Recursos Futuros)	§18.2.10
fileRecoveryPr (Propriedades de recuperação de arquivo)	§18.2.11
fileSharing (Compartilhamento de Arquivos)	§18.2.12
fileVersion (versão do arquivo)	§18.2.13
functionGroups (Grupos de Funções)	§18.2.15
oleSize (tamanho do objeto inserido)	§18.2.16
pivotCaches (PivotCaches)	§18.2.18
planilhas (Planilhas)	§18.2.20
smartTagPr (Propriedades da Marca Inteligente)	§18.2.21
smartTagTypes (tipos de marca inteligente)	§18.2.23
WebPublishing (Propriedades de publicação da Web)	§18.2.24
WebPublishObjects (Objetos de Publicação da Web)	§18.2.26
workbookPr (Propriedades da pasta de trabalho)	§18.2.28
workbookProtection (Proteção de Pasta de Trabalho)	§18.2.29

[Observação: a definição de esquema XML W3C do modelo de conteúdo desse elemento (CT_Workbook) está localizada em §A.2. nota final]

ISO/IEC29500: 2008.

Construtores

Workbook()	Inicializa uma nova instância da classe Workbook.
Workbook(IEnumerable<OpenXmlElement>)	Inicializa uma nova instância da classe Workbook com os elementos filho especificados.
Workbook(OpenXmlElement[])	Inicializa uma nova instância da classe Workbook com os elementos filho especificados.
Workbook(String)	Inicializa uma nova instância da classe Workbook do XML externo.

Propriedades

AbsolutePath	AbsolutePath, essa propriedade só está disponível no Office 2013 e posterior.. Representa a seguinte marca de elemento no esquema: x15ac:absPath.
BookViews	BookViews. Representa a seguinte marca de elemento no esquema: x:bookViews.
CalculationProperties	CalculationProperties. Representa a seguinte marca de elemento no esquema: x:calcPr.
ChildElements	Obtém todos os nós filho do elemento atual. (Herdado de OpenXmlElement)
Conformance	Conformidade Representa o seguinte atributo no esquema: conformidade
CustomWorkbookViews	CustomWorkbookViews. Representa a seguinte marca de elemento no esquema: x:customWorkbookViews.
DefinedNames	DefinedNames. Representa a seguinte marca de elemento no esquema: x:definedNames.
ExtendedAttributes	Obtém todos os atributos estendidos (atributos não definidos no esquema) do elemento atual. (Herdado de OpenXmlElement)
ExternalReferences	ExternalReferences. Representa a seguinte marca de elemento no esquema: x:externalReferences.
Features	Obtém um IFeatureCollection para o elemento atual. Essa coleção de recursos será somente leitura, mas herdará recursos de sua parte pai e pacote, se disponível. (Herdado de OpenXmlElement)
FileSharing	Filesharing. Representa a seguinte marca de elemento no esquema: x:fileSharing.
FileVersion	Fileversion. Representa a seguinte marca de elemento no esquema: x:fileVersion.
FirstChild	Obtém o primeiro filho do elemento OpenXmlElement atual. (Herdado de OpenXmlCompositeElement)
FunctionGroups	FunctionGroups. Representa a seguinte marca 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 filho. (Herdado de OpenXmlCompositeElement)
InnerText	Obtém ou define os valores concatenados do nó atual e de todos os seus filhos. (Herdado de OpenXmlCompositeElement)
InnerXml	Obtém ou define a marcação que representa apenas os nós filho do nó atual. (Herdado de OpenXmlCompositeElement)
LastChild	Obtém o último filho do elemento OpenXmlElement atual. Retornará nulo (Nada no Visual Basic) se não houver 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 marcação. Retorna nulo se nenhum atributo de compatibilidade de marcação for definido para o elemento atual. (Herdado de OpenXmlElement)
NamespaceDeclarations	Obtém todas as declarações de namespace definidas no elemento atual. Retornará um enumerador vazio se não houver nenhuma declaração de namespace. (Herdado de OpenXmlElement)
NamespaceUri	Obtém o URI do namespace do elemento atual. (Herdado de OpenXmlElement)
OleSize	OleSize. Representa a seguinte marca de elemento no esquema: x:oleSize.
OpenXmlElementContext	Obtém o OpenXmlElementContext do elemento atual. (Herdado de OpenXmlElement)
OpenXmlPart	Obtém a parte associada à árvore DOM. Ele retorna nulo quando a árvore DOM não está associada a uma parte. (Herdado de OpenXmlPartRootElement)
OuterXml	Obtém a marcação que representa o elemento atual e todos os seus elementos filho. (Herdado de OpenXmlElement)
Parent	Obtém o elemento pai do elemento atual. (Herdado de OpenXmlElement)
PivotCaches	PivotCaches. Representa a seguinte marca de elemento no esquema: x:pivotCaches.
Prefix	Obtém o prefixo namespace do elemento atual. (Herdado de OpenXmlElement)
Sheets	Folhas. Representa a seguinte marca de elemento no esquema: x:sheets.
WebPublishing	WebPublishing. Representa a seguinte marca de elemento no esquema: x:webPublishing.
WorkbookPart	Obtém a WorkbookPart associada a esse elemento.
WorkbookProperties	WorkbookProperties. Representa a seguinte marca de elemento no esquema: x:workbookPr.
WorkbookProtection	WorkbookProtection. Representa a seguinte marca 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 ele for uma criança conhecida. Isso adiciona o elemento no local correto de acordo com o esquema. (Herdado de OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adiciona uma declaração de namespace ao nó atual. (Herdado de OpenXmlElement)
Ancestors()	Enumera todos os ancestrais do elemento atual. (Herdado de OpenXmlElement)
Ancestors<T>()	Enumera apenas os ancestrais do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
Annotation(Type)	Obtenha o primeiro objeto de anotação do tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotation<T>()	Obtenha o primeiro objeto de anotação do tipo especificado 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 final da lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
Append(OpenXmlElement[])	Acrescenta cada elemento de uma matriz de elementos até o final da lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
AppendChild<T>(T)	Acrescenta o elemento especificado ao final da lista de nós filho do elemento atual. (Herdado de OpenXmlCompositeElement)
ClearAllAttributes()	Limpa todos os atributos, incluindo atributos conhecidos e atributos estendidos. (Herdado de OpenXmlElement)
Clone()	Cria uma duplicata do nó atual. (Herdado de OpenXmlElement)
CloneNode(Boolean)	Cria uma duplicata desse nó.
Descendants()	Enumera todos os descendentes do elemento atual. (Herdado de OpenXmlElement)
Descendants<T>()	Enumera todos os descendentes do elemento atual do tipo T. (Herdado de OpenXmlElement)
Elements()	Enumera todos os filhos do elemento atual. (Herdado de OpenXmlElement)
Elements<T>()	Enumera apenas os filhos do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
ElementsAfter()	Enumera todos os elementos irmãos que seguem o elemento atual e têm o mesmo pai que o elemento atual. (Herdado de OpenXmlElement)
ElementsBefore()	Enumera todos os elementos irmãos que precedem o elemento atual e têm o mesmo pai que o elemento atual. (Herdado de OpenXmlElement)
GetAttribute(String, String)	Obtém um atributo Open XML com o nome da marca e o URI do namespace especificados. (Herdado de OpenXmlElement)
GetAttributes()	Obtém uma lista que contém uma cópia de todos os atributos. (Herdado de OpenXmlElement)
GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)
GetFirstChild<T>()	Localiza o primeiro elemento filho 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 filhos 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 é exibido após um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
IsBefore(OpenXmlElement)	Determina se o elemento atual é exibido antes de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
Load(WorkbookPart)	Carrega o DOM da WorkbookPart
LookupNamespace(String)	Resolve o prefixo namespace no contexto do nó atual. (Herdado de OpenXmlElement)
LookupPrefix(String)	Localiza o prefixo correspondente para um uri de namespace no escopo do elemento atual. (Herdado de OpenXmlElement)
NextSibling()	Obtém o elemento OpenXmlElement que segue imediatamente o elemento OpenXmlElement atual. Retorna nulo (Nada no Visual Basic) se não houver nenhum próximo elemento OpenXmlElement. (Herdado de OpenXmlElement)
NextSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que segue o elemento OpenXmlElement atual. Retornará nulo (Nada no Visual Basic) se não houver o próximo OpenXmlElement. (Herdado de OpenXmlElement)
PrependChild<T>(T)	Insere o elemento especificado no início da lista de nós filho do elemento atual. (Herdado de OpenXmlCompositeElement)
PreviousSibling()	Obtém o elemento OpenXmlElement que precede imediatamente o elemento OpenXmlElement atual. Retorna nulo (Nada no Visual Basic ) se não houver nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
PreviousSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que precede o OpenXmlElement atual. Retorna nulo (Nada no Visual Basic) se não houver nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
Reload()	Recarrega o conteúdo da parte em uma árvore DOM Open XML. Esse método pode ser chamado várias vezes e cada vez que for chamado, a árvore será recarregada e as alterações anteriores na árvore são abandonadas. (Herdado de OpenXmlPartRootElement)
Remove()	Remove o elemento atual de seu pai. (Herdado de OpenXmlElement)
RemoveAllChildren()	Remove todos os elementos filho do elemento atual. (Herdado de OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remova todos os elementos filho 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 filho especificado. (Herdado de OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Remove a declaração de namespace do prefixo especificado. Não removerá nada se não houver nenhum prefixo. (Herdado de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Substitui um dos elementos filho do elemento atual por outro elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement)
Save()	Salva os dados na árvore DOM de volta para a parte. Esse método pode ser chamado várias vezes e cada vez que for chamado, o fluxo será liberado. (Herdado de OpenXmlPartRootElement)
Save(Stream)	Salva a árvore DOM no fluxo especificado. (Herdado de OpenXmlPartRootElement)
Save(WorkbookPart)	Salva o DOM na WorkbookPart.
SetAttribute(OpenXmlAttribute)	Define um atributo para o elemento especificado. Se o atributo for um atributo conhecido, o valor do atributo será definido. Se o atributo for um atributo estendido, o 'openxmlAttribute' será adicionado à lista de atributos estendidos. (Herdado de OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Define uma série de atributos para o elemento. Se um atributo for um atributo conhecido, o valor do atributo será definido. Se um atributo for um atributo estendido, o 'openxmlAttribute' será adicionado à lista de atributos estendidos. (Herdado de OpenXmlElement)
WriteTo(XmlWriter)	Salva o nó atual no XmlWriter especificado. (Herdado de OpenXmlPartRootElement)

Implantações explícitas de interface

IEnumerable.GetEnumerator()	Workbook. Essa classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, seu nome qualificado é x:pasta de trabalho. (Herdado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)