SpreadsheetDocument Clase

Definición

Espacio de nombres:

DocumentFormat.OpenXml.Packaging

Ensamblado:

DocumentFormat.OpenXml.dll

Paquete:

DocumentFormat.OpenXml v3.0.1

Define SpreadsheetDocument: un OpenXmlPackage representa un documento de hoja de cálculo.

public class SpreadsheetDocument : DocumentFormat.OpenXml.Packaging.OpenXmlPackage, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.ThumbnailPart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.WorkbookPart>

type SpreadsheetDocument = class
    inherit OpenXmlPackage
    interface ISupportedRelationship<ThumbnailPart>
    interface ISupportedRelationship<WorkbookPart>

Public Class SpreadsheetDocument
Inherits OpenXmlPackage
Implements ISupportedRelationship(Of ThumbnailPart), ISupportedRelationship(Of WorkbookPart)

Herencia

Object

OpenXmlPartContainer

OpenXmlPackage

SpreadsheetDocument

Implementaciones

ISupportedRelationship<ThumbnailPart> ISupportedRelationship<WorkbookPart>

Ejemplos

En el ejemplo siguiente se crea un documento básico de Excel, un libro con una hoja de cálculo. Después de ejecutar el ejemplo de código, eche un vistazo al archivo creado, "SpreadsheetDocumentEx.xlsx", y observe la hoja de cálculo denominada "mySheet".

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

namespace SpreadsheetDocumentEx  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            string fileName = @"c:\Users\Public\Documents\SpreadsheetDocumentEx.xlsx";  

            // Create a spreadsheet document by supplying the file name.  
            SpreadsheetDocument spreadsheetDocument = SpreadsheetDocument.  
                Create(fileName, SpreadsheetDocumentType.Workbook);  

            // Add a WorkbookPart to the document.  
            WorkbookPart workbookpart = spreadsheetDocument.AddWorkbookPart();  
            workbookpart.Workbook = new Workbook();  

            // Add a WorksheetPart to the WorkbookPart.  
            WorksheetPart worksheetPart = workbookpart.AddNewPart<WorksheetPart>();  
            worksheetPart.Worksheet = new Worksheet(new SheetData());  

            // Add Sheets to the Workbook.  
            Sheets sheets = spreadsheetDocument.WorkbookPart.Workbook.  
                AppendChild<Sheets>(new Sheets());  

            // Append a new worksheet and associate it with the workbook.  
            Sheet sheet = new Sheet() { Id = spreadsheetDocument.WorkbookPart.  
                GetIdOfPart(worksheetPart), SheetId = 1, Name = "mySheet" };  
            sheets.Append(sheet);  

            // Close the document.  
            spreadsheetDocument.Close();  

            Console.WriteLine("The spreadsheet document has been created.\nPress a key.");  
            Console.ReadKey();  
        }  
    }  
}  

Imports DocumentFormat.OpenXml  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Spreadsheet  
Module Module1  
    Sub Main()  
        ' Create a spreadsheet document by supplying the file name.  
        Dim fileName As String = "c:\Users\Public\Documents\SpreadsheetDocumentEx.xlsx"  
        Dim spreadsheetDocument As SpreadsheetDocument = _  
      spreadsheetDocument.Create(fileName, SpreadsheetDocumentType.Workbook)  

        ' Add a WorkbookPart to the document.  
        Dim workbookpart As WorkbookPart = spreadsheetDocument.AddWorkbookPart  
        workbookpart.Workbook = New Workbook  

        ' Add a WorksheetPart to the WorkbookPart.  
        Dim worksheetPart As WorksheetPart = workbookpart.AddNewPart(Of WorksheetPart)()  
        worksheetPart.Worksheet = New Worksheet(New SheetData())  

        ' Add Sheets to the Workbook.  
        Dim sheets As Sheets = spreadsheetDocument.WorkbookPart.Workbook.AppendChild(Of Sheets)(New Sheets())  

        ' Append a new worksheet and associate it with the workbook.  
        Dim sheet As Sheet = New Sheet  
        sheet.Id = spreadsheetDocument.WorkbookPart.GetIdOfPart(worksheetPart)  
        sheet.SheetId = 1  
        sheet.Name = "mySheet"  
        sheets.Append(sheet)  
        workbookpart.Workbook.Save()  

        ' Close the document.  
        spreadsheetDocument.Close()  

        Console.WriteLine("The spreadsheet document has been created." +  
                          ControlChars.Lf + "Press a key.")  
        Console.ReadKey()  
    End Sub  
End Module  

Propiedades

AutoSave	Obtiene un valor que indica si los elementos deben guardarse cuando se eliminan. (Heredado de OpenXmlPackage)
CompressionOption	Obtiene o establece el nivel de compresión para el contenido de la nueva parte. (Heredado de OpenXmlPackage)
CoreFilePropertiesPart	Obtiene el elemento CoreFilePropertiesPart de SpreadsheetDocument.
CustomFilePropertiesPart	Obtiene el objeto CustomFilePropertiesPart de SpreadsheetDocument.
DataPartReferenceRelationships	Obtiene todas las DataPartReferenceRelationship relaciones. (Heredado de OpenXmlPartContainer)
DataParts	Obtiene todos los DataPart elementos del paquete de documentos. (Heredado de OpenXmlPackage)
DigitalSignatureOriginPart	Obtiene digitalSignatureOriginPart de SpreadsheetDocument.
DocumentType	Obtiene el tipo de SpreadsheetDocument.
ExtendedFilePropertiesPart	Obtiene el extendedFilePropertiesPart de SpreadsheetDocument.
ExternalRelationships	Obtiene todas las relaciones externas. Las relaciones de hipervínculo no se incluyen, use la propiedad HyperlinkRelationship para enumerar las relaciones de hipervínculo. (Heredado de OpenXmlPartContainer)
Features	Obtiene las características asociadas a esta parte.
FileOpenAccess	Obtiene la configuración de FileAccess para el documento. La configuración de acceso de E/S actual es: Lectura, Escritura o ReadWrite. (Heredado de OpenXmlPackage)
HyperlinkRelationships	Obtiene todas las relaciones de hipervínculo. (Heredado de OpenXmlPartContainer)
LabelInfoPart	Obtiene el LabelInfoPart de SpreadsheetDocument, solo disponible en Office2021.
MarkupCompatibilityProcessSettings	Obtiene la configuración de compatibilidad de marcado aplicada en el momento de la carga. (Heredado de OpenXmlPackage)
MaxCharactersInPart	Obtiene un valor que indica el número máximo permitido de caracteres en un elemento Open XML. Un valor cero (0) indica que no hay límites en el tamaño de la pieza. Un valor distinto de cero especifica el tamaño máximo, en caracteres. (Heredado de OpenXmlPackage)
Package	Obtiene el paquete del documento. (Heredado de OpenXmlPackage)
PackageProperties	Obtiene las propiedades del paquete. (Heredado de OpenXmlPackage)
PartExtensionProvider	Obtiene un elemento PartExtensionProvider que proporciona una asignación de ContentType a la extensión part. (Heredado de OpenXmlPackage)
Parts	Obtiene todas las partes que son destinos de relación de esta parte. (Heredado de OpenXmlPartContainer)
QuickAccessToolbarCustomizationsPart	Obtiene el objeto QuickAccessToolbarCustomizationsPart de SpreadsheetDocument.
RibbonAndBackstageCustomizationsPart	Obtiene el RibbonAndBackstageCustomizationsPart de SpreadsheetDocument, solo disponible en Office2010.
RibbonExtensibilityPart	Obtiene el RibbonExtensibilityPart de SpreadsheetDocument.
RootPart	Obtiene la parte raíz del paquete. (Heredado de OpenXmlPackage)
StrictRelationshipFound	Obtiene un valor que indica si este paquete contiene relaciones de transición convertidas de Strict. (Heredado de OpenXmlPackage)
ThumbnailPart	Obtiene el elemento ThumbnailPart de SpreadsheetDocument.
WebExTaskpanesPart	Obtiene el elemento WebExTaskpanesPart de SpreadsheetDocument, solo disponible en Office2013.
WorkbookPart	Obtiene el WorkbookPart de SpreadsheetDocument.

Métodos

AddAnnotation(Object)	Agrega un objeto a la lista de anotaciones de este PartContainer. (Heredado de OpenXmlPartContainer)
AddCoreFilePropertiesPart()	Agregue coreFilePropertiesPart a SpreadsheetDocument.
AddCustomFilePropertiesPart()	Agregue un objeto CustomFilePropertiesPart a SpreadsheetDocument.
AddDigitalSignatureOriginPart()	Agregue digitalSignatureOriginPart a SpreadsheetDocument.
AddExtendedFilePropertiesPart()	Agregue extendedFilePropertiesPart a SpreadsheetDocument.
AddExtendedPart(String, String, String, String)	Agrega un elemento extendido ( parte específica de la aplicación ). (Heredado de OpenXmlPartContainer)
AddExtendedPart(String, String, String)	Agrega un elemento extendido ( parte específica de la aplicación ). (Heredado de OpenXmlPartContainer)
AddExternalRelationship(String, Uri, String)	Agrega una relación externa. No agregue relaciones de hipervínculo a través de este método. En su lugar, use AddHyperlinkRelationship(). (Heredado de OpenXmlPartContainer)
AddExternalRelationship(String, Uri)	Agrega una relación externa. No agregue relaciones de hipervínculo a través de este método. En su lugar, use AddHyperlinkRelationship(). (Heredado de OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean, String)	Agrega una nueva relación de hipervínculo. (Heredado de OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean)	Agrega una nueva relación de hipervínculo. (Heredado de OpenXmlPartContainer)
AddLabelInfoPart()	Agrega un LabelInfoPart a SpreadsheetDocument, esta parte solo está disponible en Office2021.
AddNewPart<T>()	Agrega una nueva parte del tipo T. (Heredado de OpenXmlPartContainer)
AddNewPart<T>(String, String)	Agrega una nueva parte del tipo T.
AddNewPart<T>(String)	Agrega una nueva parte del tipo T. (Heredado de OpenXmlPartContainer)
AddPart<T>(T, String)	Agrega la parte al documento con un identificador de relación (ID) determinado. Debe usar la parte devuelta para funcionar en la pieza agregada al documento. (Heredado de OpenXmlPartContainer)
AddPart<T>(T)	Agrega la parte especificada al documento. Use la parte devuelta para operar en la pieza agregada al documento. (Heredado de OpenXmlPackage)
AddQuickAccessToolbarCustomizationsPart()	Agrega un objeto QuickAccessToolbarCustomizationsPart a SpreadsheetDocument.
AddRibbonAndBackstageCustomizationsPart()	Agrega un RibbonAndBackstageCustomizationsPart a SpreadsheetDocument; este elemento solo está disponible en Office2010.
AddRibbonExtensibilityPart()	Agrega un RibbonExtensibilityPart a SpreadsheetDocument.
AddWebExTaskpanesPart()	Agrega un elemento WebExTaskpanesPart a SpreadsheetDocument; este elemento solo está disponible en Office2013.
AddWorkbookPart()	Creó WorkbookPart y agréguelo a este documento.
Annotation(Type)	Obtenga el primer objeto de anotación del tipo especificado de este PartContainer. (Heredado de OpenXmlPartContainer)
Annotation<T>()	Obtenga el primer objeto de anotación del tipo especificado de este PartContainer. (Heredado de OpenXmlPartContainer)
Annotations(Type)	Obtiene una colección de anotaciones del tipo especificado para este PartContainer. (Heredado de OpenXmlPartContainer)
Annotations<T>()	Obtiene una colección de anotaciones del tipo especificado para este PartContainer. (Heredado de OpenXmlPartContainer)
ChangeDocumentType(SpreadsheetDocumentType)	Cambia el tipo de documento.
ChangeIdOfPart(OpenXmlPart, String)	Cambia el identificador de relación del elemento. (Heredado de OpenXmlPartContainer)
Clone()	Crea un clon modificable de este paquete OpenXml, abierto en un MemoryStream con capacidad ampliable y usando OpenSettings predeterminado. (Heredado de OpenXmlPackage)
Clone(Package, OpenSettings)	Crea un clon de este paquete OpenXml, abierto en la instancia especificada de Package. (Heredado de OpenXmlPackage)
Clone(Package)	Crea un clon de este paquete OpenXml, abierto en la instancia especificada de Package. El clon se abrirá con los mismos OpenSettings que este paquete OpenXml. (Heredado de OpenXmlPackage)
Clone(Stream, Boolean, OpenSettings)	Crea un clon de este paquete OpenXml, abierto en la secuencia especificada. (Heredado de OpenXmlPackage)
Clone(Stream, Boolean)	Crea un clon de este paquete OpenXml, abierto en la secuencia especificada. El paquete OpenXml clonado se abre con el mismo OpenSettings que este paquete OpenXml. (Heredado de OpenXmlPackage)
Clone(Stream)	Crea un clon de este paquete OpenXml, abierto en la secuencia especificada. El paquete OpenXml clonado se abre con la misma configuración, es decir, FileOpenAccess y OpenSettings, como este paquete OpenXml. (Heredado de OpenXmlPackage)
Clone(String, Boolean, OpenSettings)	Crea un clon de este paquete OpenXml abierto desde el archivo especificado (que se creará mediante la clonación de este paquete OpenXml). (Heredado de OpenXmlPackage)
Clone(String, Boolean)	Crea un clon de este paquete OpenXml abierto desde el archivo especificado (que se creará mediante la clonación de este paquete OpenXml). El paquete OpenXml clonado se abre con el mismo OpenSettings que este paquete OpenXml. (Heredado de OpenXmlPackage)
Clone(String)	Crea un clon de este paquete OpenXml abierto desde el archivo especificado (que se creará mediante la clonación de este paquete OpenXml). El paquete OpenXml clonado se abre con la misma configuración, es decir, FileOpenAccess y OpenSettings, como este paquete OpenXml. (Heredado de OpenXmlPackage)
Close()	Guarda y cierra el paquete OpenXml y todas las secuencias de elementos subyacentes. (Heredado de OpenXmlPackage)
Create(Package, SpreadsheetDocumentType, Boolean)	Crea una nueva instancia de la clase SpreadsheetDocument a partir del paquete especificado.
Create(Package, SpreadsheetDocumentType)	Crea una nueva instancia de la clase SpreadsheetDocument a partir del paquete especificado.
Create(Stream, SpreadsheetDocumentType, Boolean)	Crea una nueva instancia de la clase SpreadsheetDocument a partir de la secuencia de E/S.
Create(Stream, SpreadsheetDocumentType)	Crea una nueva instancia de la clase SpreadsheetDocument a partir de la secuencia de E/S.
Create(String, SpreadsheetDocumentType, Boolean)	Crea una nueva instancia de la clase SpreadsheetDocument a partir del archivo especificado.
Create(String, SpreadsheetDocumentType)	Crea una nueva instancia de la clase SpreadsheetDocument a partir del archivo especificado.
CreateClone(Package)	Crea una nueva instancia de OpenXmlPackage en la instancia especificada de Package. (Heredado de OpenXmlPackage)
CreateClone(Stream)	Crea un nuevo OpenXmlPackage en la secuencia especificada. (Heredado de OpenXmlPackage)
CreateClone(String)	Crea un nuevo paquete OpenXml en el archivo especificado. (Heredado de OpenXmlPackage)
CreateFromTemplate(String)	Crea un spreadsheetDocument editable a partir de una plantilla, abierta en un objeto MemoryStream con capacidad ampliable.
CreateMediaDataPart(MediaDataPartType)	Crea un elemento nuevo MediaDataPart en el paquete del documento. (Heredado de OpenXmlPackage)
CreateMediaDataPart(String, String)	Crea un elemento nuevo MediaDataPart en el paquete del documento. (Heredado de OpenXmlPackage)
CreateMediaDataPart(String)	Crea un elemento nuevo MediaDataPart en el paquete del documento. (Heredado de OpenXmlPackage)
CreateRelationshipToPart(OpenXmlPart, String)	Agrega una relación para la parte especificada a esta parte. (Heredado de OpenXmlPartContainer)
CreateRelationshipToPart(OpenXmlPart)	Agrega una relación para la parte especificada a esta parte. (Heredado de OpenXmlPartContainer)
DeleteExternalRelationship(ExternalRelationship)	Elimina la relación externa especificada. (Heredado de OpenXmlPartContainer)
DeleteExternalRelationship(String)	Elimina el objeto ExternalRelationship especificado. (Heredado de OpenXmlPartContainer)
DeletePart(DataPart)	Elimina el especificado DataPart del paquete de documentos. (Heredado de OpenXmlPackage)
DeletePart(OpenXmlPart)	Elimina un elemento especificado en la capa raíz del paquete. (Heredado de OpenXmlPartContainer)
DeletePart(String)	Elimina la parte secundaria especificada de esta parte. (Heredado de OpenXmlPartContainer)
DeleteParts<T>(IEnumerable<T>)	Elimina del documento todos los elementos que se encuentran en la colección pasada. (Heredado de OpenXmlPartContainer)
DeletePartsRecursivelyOfType<T>()	Elimina todas las partes con el tipo de elemento especificado del paquete de forma recursiva. (Heredado de OpenXmlPackage)
DeleteReferenceRelationship(ReferenceRelationship)	Elimina la relación de referencia especificada. (Heredado de OpenXmlPartContainer)
DeleteReferenceRelationship(String)	Elimina la relación de referencia especificada. (Heredado de OpenXmlPartContainer)
Dispose()	Vacía y guarda el contenido, cierra el documento y libera todos los recursos. (Heredado de OpenXmlPackage)
Dispose(Boolean)	Vacía y guarda el contenido, cierra el documento y libera todos los recursos. (Heredado de OpenXmlPackage)
FromFlatOpcDocument(XDocument, Package)	Crea una nueva instancia de SpreadsheetDocument a partir de un libro en formato OPC plano en la instancia especificada de Package.
FromFlatOpcDocument(XDocument, Stream, Boolean)	Crea una nueva instancia de SpreadsheetDocument a partir de un libro en formato OPC plano.
FromFlatOpcDocument(XDocument, String, Boolean)	Crea una nueva instancia de SpreadsheetDocument a partir de un libro en formato OPC plano.
FromFlatOpcDocument(XDocument)	Crea una nueva instancia editable de SpreadsheetDocument a partir de un XDocument objeto en formato OPC plano, abierto en .MemoryStream
FromFlatOpcString(String, Package)	Crea una nueva instancia de SpreadsheetDocument a partir de una cadena en formato OPC plano.
FromFlatOpcString(String, Stream, Boolean)	Crea una nueva instancia de SpreadsheetDocument a partir de una cadena en formato OPC plano en un
FromFlatOpcString(String, String, Boolean)	Crea una nueva instancia de SpreadsheetDocument a partir de una cadena en formato OPC plano.
FromFlatOpcString(String)	Crea una nueva instancia de SpreadsheetDocument a partir de una cadena en formato OPC plano en un MemoryStream con capacidad ampliable.
GetExternalRelationship(String)	Obtiene el objeto ExternalRelationship especificado. (Heredado de OpenXmlPartContainer)
GetIdOfPart(OpenXmlPart)	Obtiene el identificador de relación del elemento. (Heredado de OpenXmlPartContainer)
GetPartById(String)	Obtiene la parte secundaria a través del identificador de relación. (Heredado de OpenXmlPartContainer)
GetPartsCountOfType<T>()	Obtiene el recuento de todas las partes del tipo T. (Heredado de OpenXmlPartContainer)
GetPartsOfType<T>()	Enumera todas las partes secundarias del tipo T especificado de esta parte. (Heredado de OpenXmlPartContainer)
GetPartsOfType<T>(ICollection<T>)	Obtiene todas las partes secundarias del tipo T especificado en partCollection de esta parte. (Heredado de OpenXmlPartContainer)
GetReferenceRelationship(String)	Obtiene el objeto ReferenceRelationship especificado. (Heredado de OpenXmlPartContainer)
Open(Package, OpenSettings)	Crea una nueva instancia de la clase SpreadsheetDocument a partir del paquete especificado.
Open(Package)	Crea una nueva instancia de la clase SpreadsheetDocument a partir del paquete especificado.
Open(Stream, Boolean, OpenSettings)	Crea una nueva instancia de la clase SpreadsheetDocument a partir de la secuencia de E/S.
Open(Stream, Boolean)	Crea una nueva instancia de la clase SpreadsheetDocument a partir de la secuencia de E/S.
Open(String, Boolean, OpenSettings)	Crea una nueva instancia de la clase SpreadsheetDocument a partir del archivo especificado.
Open(String, Boolean)	Crea una nueva instancia de la clase SpreadsheetDocument a partir del archivo especificado.
OpenClone(Stream, Boolean, OpenSettings)	Abre el paquete OpenXml clonado en la secuencia especificada. (Heredado de OpenXmlPackage)
OpenClone(String, Boolean, OpenSettings)	Abre el paquete OpenXml clonado en el archivo especificado. (Heredado de OpenXmlPackage)
RemoveAnnotations(Type)	Quita las anotaciones del tipo especificado de este PartContainer. (Heredado de OpenXmlPartContainer)
RemoveAnnotations<T>()	Quita las anotaciones del tipo especificado de este PartContainer. (Heredado de OpenXmlPartContainer)
Save()	Guarda el contenido de todos los elementos y relaciones contenidos en el paquete OpenXml, si FileOpenAccess es ReadWrite. Algunas plataformas no admiten el guardado debido a las limitaciones de Package, por lo que consulte CanSave en tiempo de OpenXmlPackageejecución para saber si se admitirá el guardado completo sin cerrar y eliminar . (Heredado de OpenXmlPackage)
SaveAs(String)	Guarda el contenido de todos los elementos y relaciones contenidos en el paquete OpenXml en el archivo especificado. Abre el documento guardado con la misma configuración que se usó para abrir este paquete OpenXml. (Heredado de OpenXmlPackage)
ThrowIfObjectDisposed()	Se produce si se elimina un objeto. (Heredado de OpenXmlPackage)
ToFlatOpcDocument()	Convierte un paquete OpenXml en formato OPC en un XDocument en formato OPC plano. (Heredado de OpenXmlPackage)
ToFlatOpcDocument(XProcessingInstruction)	Convierte un paquete OpenXml en formato OPC en un XDocument en formato OPC plano. (Heredado de OpenXmlPackage)
ToFlatOpcString()	Convierte un paquete OpenXml en formato OPC en cadena en formato OPC plano. (Heredado de OpenXmlPackage)
TryGetPartById(String, OpenXmlPart)	Intente obtener la parte secundaria por el identificador de relación. (Heredado de OpenXmlPartContainer)
Validate(OpenXmlPackageValidationSettings)	Valida el paquete. Este método no valida el contenido XML de cada parte. (Heredado de OpenXmlPackage)

Métodos de extensión

GetPackage(OpenXmlPackage)	Obtiene el valor actual IPackage de package.
AddPackageEventsFeature(OpenXmlPackage)	Agrega una característica para realizar un seguimiento de los eventos de un ciclo de vida de un paquete.
AddPartEventsFeature(OpenXmlPackage)	Agrega una característica para realizar un seguimiento de los eventos de un paquete que crea o quita partes.
AddPartRootEventsFeature(OpenXmlPartContainer)	Agrega una característica para realizar un seguimiento de los eventos del ciclo de vida del paquete.
AddRandomNumberGeneratorFeature(OpenXmlPackage)	Agregue un generador de números aleatorios al paquete.
CreateUnknownElement(OpenXmlPartContainer, String)	Crea una nueva clase OpenXmlUnknownElement mediante el XML externo.
ToFlatOpcDocument(OpenXmlPackage)	Convierte un paquete OpenXml en formato OPC en un XDocument en formato OPC plano.
ToFlatOpcString(OpenXmlPackage)	Convierte un paquete OpenXml en formato OPC en cadena en formato OPC plano.
GetAllParts(OpenXmlPackage)	Recorrer partes en por OpenXmlPackage amplitud en primer lugar.
IgnoreCalculationChainPartRelationship(SpreadsheetDocument)	Configura para spreadsheet omitir las CalculationChainPart relaciones si el elemento no está allí.