Workbook Clase

Definición

Espacio de nombres:

DocumentFormat.OpenXml.Spreadsheet

Ensamblado:

DocumentFormat.OpenXml.dll

Paquete:

DocumentFormat.OpenXml v3.0.1

Libro.

Esta clase está disponible en Office 2007 y versiones posteriores.

Cuando el objeto se serializa como xml, su nombre completo es x:workbook.

public class Workbook : DocumentFormat.OpenXml.OpenXmlPartRootElement

type Workbook = class
    inherit OpenXmlPartRootElement

Public Class Workbook
Inherits OpenXmlPartRootElement

Herencia

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

Workbook

Ejemplos

En el siguiente ejemplo de código se abre un documento de hoja de cálculo existente y se agrega una nueva hoja de cálculo, denominada "mySheet", y se asocia al libro.

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  

Comentarios

[ISO/IEC 29500-1 1.ª edición]

workbook (Workbook)

El elemento workbook es el elemento de nivel superior. Contiene elementos y atributos que abarcan el contenido de datos del libro. Los elementos secundarios del libro tienen sus propias referencias de subclase y se muestran en la tabla de elementos secundarios siguiente. Una lista parcial de las estructuras del libro que representan estos elementos son:

• Sheets: representa la colección de hojas de cálculo del libro. Las hojas son la estructura central dentro de un libro y contienen el texto, los números, las fechas, las fórmulas y otros elementos de un libro.

• Vistas: SpreadsheetML define una colección de vistas workbook que definen las dimensiones básicas de la ventana y la posición del libro si alguna vez la muestra una aplicación de hoja de cálculo. También define una colección de vistas de libro personalizadas que permite a SpreadsheetML describir una o varias vistas de los datos dentro de un libro.

• Propiedades: el libro tiene varias colecciones de propiedades que almacenan la configuración básica del libro, como el sistema de fechas que se va a usar, la configuración de protección de archivos, la configuración de cálculo y los comportamientos de etiqueta inteligente.

• Nombres: palabras o cadenas de caracteres que representan celdas, rangos de celdas, fórmulas o valores constantes.

[Ejemplo:

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

Fin del ejemplo]

Elementos primarios
Elemento raíz del elemento SpreadsheetML Workbook

Elementos secundarios	Subclause
bookViews (vistas de libro)	§18.2.1
calcPr (propiedades de cálculo)	§18.2.2
customWorkbookViews (vistas de libro personalizadas)	§18.2.4
definedNames (nombres definidos)	§18.2.6
externalReferences (referencias externas)	§18.2.9
extLst (Área de almacenamiento de datos de características futuras)	§18.2.10
fileRecoveryPr (propiedades de recuperación de archivos)	§18.2.11
fileSharing (Uso compartido de archivos)	§18.2.12
fileVersion (versión del archivo)	§18.2.13
functionGroups (grupos de funciones)	§18.2.15
oleSize (tamaño de objeto incrustado)	§18.2.16
pivotCaches (PivotCaches)	§18.2.18
hojas (hojas)	§18.2.20
smartTagPr (propiedades de etiqueta inteligente)	§18.2.21
smartTagTypes (tipos de etiquetas inteligentes)	§18.2.23
webPublishing (propiedades de publicación web)	§18.2.24
webPublishObjects (objetos de publicación web)	§18.2.26
workbookPr (propiedades del libro)	§18.2.28
workbookProtection (Protección del libro)	§18.2.29

[Nota: La definición del esquema XML W3C del modelo de contenido de este elemento (CT_Workbook) se encuentra en §A.2. Fin de la nota]

ISO/IEC29500: 2008.

Constructores

Workbook()	Inicializa una nueva instancia de la clase Workbook.
Workbook(IEnumerable<OpenXmlElement>)	Inicializa una nueva instancia de la clase Workbook con los elementos secundarios especificados.
Workbook(OpenXmlElement[])	Inicializa una nueva instancia de la clase Workbook con los elementos secundarios especificados.
Workbook(String)	Inicializa una nueva instancia de la clase Workbook a partir de XML externo.

Propiedades

AbsolutePath	AbsolutePath, esta propiedad solo está disponible en Office 2013 y versiones posteriores. Representa la siguiente etiqueta de elemento en el esquema: x15ac:absPath.
BookViews	BookViews. Representa la siguiente etiqueta de elemento en el esquema: x:bookViews.
CalculationProperties	CalculationProperties. Representa la siguiente etiqueta de elemento en el esquema: x:calcPr.
ChildElements	Obtiene todos los nodos secundarios del elemento actual. (Heredado de OpenXmlElement)
Conformance	Conformidad Representa el atributo siguiente en el esquema: conformidad
CustomWorkbookViews	CustomWorkbookViews. Representa la siguiente etiqueta de elemento en el esquema: x:customWorkbookViews.
DefinedNames	DefinedNames. Representa la siguiente etiqueta de elemento en el esquema: x:definedNames.
ExtendedAttributes	Obtiene todos los atributos extendidos (atributos no definidos en el esquema) del elemento actual. (Heredado de OpenXmlElement)
ExternalReferences	ExternalReferences. Representa la siguiente etiqueta de elemento en el esquema: x:externalReferences.
Features	Obtiene un IFeatureCollection para el elemento actual. Esta colección de características será de solo lectura, pero heredará características de su elemento primario y paquete si está disponible. (Heredado de OpenXmlElement)
FileSharing	Archivos. Representa la siguiente etiqueta de elemento en el esquema: x:fileSharing.
FileVersion	FileVersion. Representa la siguiente etiqueta de elemento en el esquema: x:fileVersion.
FirstChild	Obtiene el primer elemento secundario del elemento OpenXmlElement actual. (Heredado de OpenXmlCompositeElement)
FunctionGroups	FunctionGroups. Representa la siguiente etiqueta de elemento en el esquema: x:functionGroups.
HasAttributes	Obtiene un valor que indica si el elemento actual tiene atributos. (Heredado de OpenXmlElement)
HasChildren	Obtiene un valor que indica si el elemento actual tiene algún elemento secundario. (Heredado de OpenXmlCompositeElement)
InnerText	Obtiene o establece los valores concatenados del nodo actual y todos sus elementos secundarios. (Heredado de OpenXmlCompositeElement)
InnerXml	Obtiene o establece el marcado que representa solo los nodos secundarios del nodo actual. (Heredado de OpenXmlCompositeElement)
LastChild	Obtiene el último elemento secundario del elemento OpenXmlElement actual. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement de este tipo. (Heredado de OpenXmlCompositeElement)
LocalName	Obtiene el nombre local del elemento actual. (Heredado de OpenXmlElement)
MCAttributes	Obtiene o establece los atributos de compatibilidad de marcado. Devuelve null si no se definen atributos de compatibilidad de marcado para el elemento actual. (Heredado de OpenXmlElement)
NamespaceDeclarations	Obtiene todas las declaraciones de espacio de nombres definidas en el elemento actual. Devuelve un enumerador vacío si no hay ninguna declaración de espacio de nombres. (Heredado de OpenXmlElement)
NamespaceUri	Obtiene el URI del espacio de nombres del elemento actual. (Heredado de OpenXmlElement)
OleSize	OleSize. Representa la siguiente etiqueta de elemento en el esquema: x:oleSize.
OpenXmlElementContext	Obtiene el Objeto OpenXmlElementContext del elemento actual. (Heredado de OpenXmlElement)
OpenXmlPart	Obtiene la parte asociada al árbol DOM. Devuelve null cuando el árbol DOM no está asociado a una parte. (Heredado de OpenXmlPartRootElement)
OuterXml	Obtiene el marcado que representa el elemento actual y todos sus elementos secundarios. (Heredado de OpenXmlElement)
Parent	Obtiene el elemento primario del elemento actual. (Heredado de OpenXmlElement)
PivotCaches	PivotCaches. Representa la siguiente etiqueta de elemento en el esquema: x:pivotCaches.
Prefix	Obtiene el prefijo de espacio de nombres del elemento actual. (Heredado de OpenXmlElement)
Sheets	Hojas. Representa la siguiente etiqueta de elemento en el esquema: x:sheets.
WebPublishing	WebPublishing. Representa la siguiente etiqueta de elemento en el esquema: x:webPublishing.
WorkbookPart	Obtiene el WorkbookPart asociado a este elemento.
WorkbookProperties	WorkbookProperties. Representa la siguiente etiqueta de elemento en el esquema: x:workbookPr.
WorkbookProtection	WorkbookProtection. Representa la siguiente etiqueta de elemento en el esquema: x:workbookProtection.
XmlQualifiedName	Obtiene el nombre completo del elemento actual. (Heredado de OpenXmlElement)
XName	Obtiene el nombre completo del elemento actual. (Heredado de OpenXmlElement)

Métodos

AddAnnotation(Object)	Agrega un objeto a la lista de anotaciones del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Agrega el elemento especificado al elemento si es un elemento secundario conocido. Esto agrega el elemento en la ubicación correcta según el esquema. (Heredado de OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Agrega una declaración de espacio de nombres al nodo actual. (Heredado de OpenXmlElement)
Ancestors()	Enumera todos los antecesores del elemento actual. (Heredado de OpenXmlElement)
Ancestors<T>()	Enumera solo los antecesores del elemento actual que tienen el tipo especificado. (Heredado de OpenXmlElement)
Annotation(Type)	Obtenga el primer objeto de anotación del tipo especificado del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
Annotation<T>()	Obtenga el primer objeto de anotación del tipo especificado del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
Annotations(Type)	Obtiene una colección de anotaciones con el tipo especificado para el elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
Annotations<T>()	Obtiene una colección de anotaciones con el tipo especificado para el elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Anexa cada elemento de una lista de elementos al final de la lista de elementos secundarios del elemento actual. (Heredado de OpenXmlElement)
Append(OpenXmlElement[])	Anexa cada elemento de una matriz de elementos al final de la lista de elementos secundarios del elemento actual. (Heredado de OpenXmlElement)
AppendChild<T>(T)	Anexa el elemento especificado al final de la lista de nodos secundarios del elemento actual. (Heredado de OpenXmlCompositeElement)
ClearAllAttributes()	Borra todos los atributos, incluidos los atributos conocidos y los atributos extendidos. (Heredado de OpenXmlElement)
Clone()	Crea un duplicado del nodo actual. (Heredado de OpenXmlElement)
CloneNode(Boolean)	Crea un duplicado de este nodo.
Descendants()	Enumera todos los descendientes del elemento actual. (Heredado de OpenXmlElement)
Descendants<T>()	Enumera todos los descendientes del elemento actual del tipo T. (Heredado de OpenXmlElement)
Elements()	Enumera todos los elementos secundarios del elemento actual. (Heredado de OpenXmlElement)
Elements<T>()	Enumera solo los elementos secundarios del elemento actual que tienen el tipo especificado. (Heredado de OpenXmlElement)
ElementsAfter()	Enumera todos los elementos del mismo nivel que siguen el elemento actual y tienen el mismo elemento primario que el elemento actual. (Heredado de OpenXmlElement)
ElementsBefore()	Enumera todos los elementos del mismo nivel que preceden al elemento actual y tienen el mismo elemento primario que el elemento actual. (Heredado de OpenXmlElement)
GetAttribute(String, String)	Obtiene un atributo Open XML con el nombre de etiqueta y el URI de espacio de nombres especificados. (Heredado de OpenXmlElement)
GetAttributes()	Obtiene una lista que contiene una copia de todos los atributos. (Heredado de OpenXmlElement)
GetEnumerator()	Devuelve un enumerador que recorre en iteración la colección secundaria. (Heredado de OpenXmlElement)
GetFirstChild<T>()	Busca el primer elemento secundario en el tipo T. (Heredado de OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserta el elemento especificado inmediatamente después del elemento de referencia especificado. (Heredado de OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserta el elemento especificado inmediatamente después del elemento actual. (Heredado de OpenXmlElement)
InsertAt<T>(T, Int32)	Inserta el elemento especificado en el índice especificado de los elementos secundarios del elemento actual. (Heredado de OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserta el elemento especificado inmediatamente antes del elemento de referencia especificado. (Heredado de OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserta el elemento especificado inmediatamente antes del elemento actual. (Heredado de OpenXmlElement)
IsAfter(OpenXmlElement)	Determina si el elemento actual aparece después de un elemento especificado en el orden del documento. (Heredado de OpenXmlElement)
IsBefore(OpenXmlElement)	Determina si el elemento actual aparece antes que un elemento especificado en el orden del documento. (Heredado de OpenXmlElement)
Load(WorkbookPart)	Carga el DOM desde WorkbookPart
LookupNamespace(String)	Resuelve el prefijo de espacio de nombres en el contexto del nodo actual. (Heredado de OpenXmlElement)
LookupPrefix(String)	Busca el prefijo correspondiente para un uri de espacio de nombres en el ámbito del elemento actual. (Heredado de OpenXmlElement)
NextSibling()	Obtiene el elemento OpenXmlElement que sigue inmediatamente al elemento OpenXmlElement actual. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement siguiente. (Heredado de OpenXmlElement)
NextSibling<T>()	Obtiene el elemento OpenXmlElement con el tipo especificado que sigue al elemento OpenXmlElement actual. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement siguiente. (Heredado de OpenXmlElement)
PrependChild<T>(T)	Inserta el elemento especificado al principio de la lista de nodos secundarios del elemento actual. (Heredado de OpenXmlCompositeElement)
PreviousSibling()	Obtiene el elemento OpenXmlElement que precede inmediatamente al elemento OpenXmlElement actual. Devuelve null (Nothing en Visual Basic ) si no hay ningún elemento OpenXmlElement anterior. (Heredado de OpenXmlElement)
PreviousSibling<T>()	Obtiene el elemento OpenXmlElement con el tipo especificado que precede al objeto OpenXmlElement actual. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement anterior. (Heredado de OpenXmlElement)
Reload()	Vuelve a cargar el contenido de la pieza en un árbol DOM de Open XML. Este método se puede llamar varias veces y cada vez que se llama, se volverá a cargar el árbol y se abandonarán los cambios anteriores en el árbol. (Heredado de OpenXmlPartRootElement)
Remove()	Quita el elemento actual de su elemento primario. (Heredado de OpenXmlElement)
RemoveAllChildren()	Quita todos los elementos secundarios del elemento actual. (Heredado de OpenXmlCompositeElement)
RemoveAllChildren<T>()	Quite todos los elementos secundarios del elemento actual que son de tipo T. (Heredado de OpenXmlElement)
RemoveAnnotations(Type)	Quita las anotaciones del tipo especificado del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
RemoveAnnotations<T>()	Quita las anotaciones con el tipo especificado del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
RemoveAttribute(String, String)	Quita el atributo del elemento actual. (Heredado de OpenXmlElement)
RemoveChild<T>(T)	Quita el elemento secundario especificado. (Heredado de OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Quita la declaración de espacio de nombres para el prefijo especificado. No quita nada si no hay ningún prefijo. (Heredado de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Reemplaza uno de los elementos secundarios del elemento actual por otro elemento OpenXmlElement. (Heredado de OpenXmlCompositeElement)
Save()	Guarda los datos del árbol DOM de nuevo en el elemento. Se puede llamar a este método varias veces y cada vez que se llama, se vaciará la secuencia. (Heredado de OpenXmlPartRootElement)
Save(Stream)	Guarda el árbol DOM en la secuencia especificada. (Heredado de OpenXmlPartRootElement)
Save(WorkbookPart)	Guarda el DOM en WorkbookPart.
SetAttribute(OpenXmlAttribute)	Establece un atributo en el elemento especificado. Si el atributo es un atributo conocido, se establece el valor del atributo. Si el atributo es un atributo extendido, el atributo "openxmlAttribute" se agrega a la lista de atributos extendidos. (Heredado de OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Establece una serie de atributos en el elemento . Si un atributo es un atributo conocido, se establece el valor del atributo. Si un atributo es un atributo extendido, el atributo "openxmlAttribute" se agrega a la lista de atributos extendidos. (Heredado de OpenXmlElement)
WriteTo(XmlWriter)	Guarda el nodo actual en el objeto XmlWriter especificado. (Heredado de OpenXmlPartRootElement)

Implementaciones de interfaz explícitas

IEnumerable.GetEnumerator()	Libro. Esta clase está disponible en Office 2007 y versiones posteriores. Cuando el objeto se serializa como xml, su nombre completo es x:workbook. (Heredado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Devuelve un enumerador que recorre en iteración la colección secundaria. (Heredado de OpenXmlElement)