SpreadsheetDocument Classe

Definição

Namespace:

DocumentFormat.OpenXml.Packaging

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Define PlanilhaDocument – um OpenXmlPackage representa um documento de Planilha.

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)

Herança

Object

OpenXmlPartContainer

OpenXmlPackage

SpreadsheetDocument

Implementações

ISupportedRelationship<ThumbnailPart> ISupportedRelationship<WorkbookPart>

Exemplos

O exemplo a seguir cria um documento básico do Excel, uma pasta de trabalho com uma planilha. Depois de executar o exemplo de código, dê uma olhada no arquivo criado, "SpreadsheetDocumentEx.xlsx" e observe a planilha chamada "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  

Propriedades

AutoSave	Obtém um valor que indica se as partes devem ser salvas quando descartadas. (Herdado de OpenXmlPackage)
CompressionOption	Obtém ou define o nível de compactação para o conteúdo da nova parte (Herdado de OpenXmlPackage)
CoreFilePropertiesPart	Obtém o CoreFilePropertiesPart da PlanilhaDocument.
CustomFilePropertiesPart	Obtém a CustomFilePropertiesPart da PlanilhaDocument.
DataPartReferenceRelationships	Obtém todos os DataPartReferenceRelationship relacionamentos. (Herdado de OpenXmlPartContainer)
DataParts	Obtém todas as DataPart partes no pacote de documentos. (Herdado de OpenXmlPackage)
DigitalSignatureOriginPart	Obtém o DigitalSignatureOriginPart da PlanilhaDocument.
DocumentType	Obtém o tipo de PlanilhaDocument.
ExtendedFilePropertiesPart	Obtém o ExtendedFilePropertiesPart da PlanilhaDocument.
ExternalRelationships	Obtém todas as relações externas. As relações de hiperlink não estão incluídas, use a propriedade HyperlinkRelationship para enumerar relações de hiperlink. (Herdado de OpenXmlPartContainer)
Features	Obtém os recursos associados a essa parte.
FileOpenAccess	Obtém a configuração FileAccess para o documento. As configurações de acesso de E/S atuais são: Leitura, Gravação ou ReadWrite. (Herdado de OpenXmlPackage)
HyperlinkRelationships	Obtém todas as relações de hiperlink. (Herdado de OpenXmlPartContainer)
LabelInfoPart	Obtém o LabelInfoPart da PlanilhaDocument, disponível apenas no Office2021.
MarkupCompatibilityProcessSettings	Obtém as configurações de compatibilidade de marcação aplicadas na hora do carregamento. (Herdado de OpenXmlPackage)
MaxCharactersInPart	Obtém um valor que indica o número máximo permitido de caracteres em uma parte Open XML. Um valor zero (0) indica que não há limites no tamanho da parte. Um valor não zero especifica o tamanho máximo em caracteres. (Herdado de OpenXmlPackage)
Package	Obtém o pacote do documento. (Herdado de OpenXmlPackage)
PackageProperties	Obtém as propriedades do pacote. (Herdado de OpenXmlPackage)
PartExtensionProvider	Obtém uma parte PartExtensionProvider que fornece um mapeamento do ContentType para a extensão de parte. (Herdado de OpenXmlPackage)
Parts	Obtém todas as partes que são destinos de relacionamento dessa parte. (Herdado de OpenXmlPartContainer)
QuickAccessToolbarCustomizationsPart	Obtém o QuickAccessToolbarCustomizationsPart da PlanilhaDocument.
RibbonAndBackstageCustomizationsPart	Obtém o RibbonAndBackstageCustomizationsPart da PlanilhaDocument, disponível apenas no Office2010.
RibbonExtensibilityPart	Obtém a RibbonExtensibilityPart da PlanilhaDocument.
RootPart	Obtém a parte raiz do pacote. (Herdado de OpenXmlPackage)
StrictRelationshipFound	Obtém um valor que indica se esse pacote contém relações transitórias convertidas de Strict. (Herdado de OpenXmlPackage)
ThumbnailPart	Obtém a Miniatura Parte da PlanilhaDocument.
WebExTaskpanesPart	Obtém o WebExTaskpanesPart da PlanilhaDocument, disponível apenas no Office2013.
WorkbookPart	Obtém a WorkbookPart da PlanilhaDocument.

Métodos

AddAnnotation(Object)	Adiciona um objeto à lista de anotações deste PartContainer. (Herdado de OpenXmlPartContainer)
AddCoreFilePropertiesPart()	Adicione um CoreFilePropertiesPart à PlanilhaDocument.
AddCustomFilePropertiesPart()	Adicione uma CustomFilePropertiesPart à PlanilhaDocument.
AddDigitalSignatureOriginPart()	Adicione um DigitalSignatureOriginPart à PlanilhaDocument.
AddExtendedFilePropertiesPart()	Adicione uma ExtendedFilePropertiesPart à PlanilhaDocument.
AddExtendedPart(String, String, String)	Adiciona uma parte estendida ( parte específica do aplicativo ). (Herdado de OpenXmlPartContainer)
AddExtendedPart(String, String, String, String)	Adiciona uma parte estendida ( parte específica do aplicativo ). (Herdado de OpenXmlPartContainer)
AddExternalRelationship(String, Uri)	Adiciona uma relação externa. Não adicione relações de hiperlink por meio desse método. Em vez disso, use AddHyperlinkRelationship(). (Herdado de OpenXmlPartContainer)
AddExternalRelationship(String, Uri, String)	Adiciona uma relação externa. Não adicione relações de hiperlink por meio desse método. Em vez disso, use AddHyperlinkRelationship(). (Herdado de OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean)	Adiciona uma nova relação de hiperlink. (Herdado de OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean, String)	Adiciona uma nova relação de hiperlink. (Herdado de OpenXmlPartContainer)
AddLabelInfoPart()	Adiciona um LabelInfoPart à PlanilhaDocument, essa parte só está disponível no Office2021.
AddNewPart<T>()	Adiciona uma nova parte do tipo T. (Herdado de OpenXmlPartContainer)
AddNewPart<T>(String)	Adiciona uma nova parte do tipo T. (Herdado de OpenXmlPartContainer)
AddNewPart<T>(String, String)	Adiciona uma nova parte do tipo T.
AddPart<T>(T)	Adiciona a parte especificada ao documento. Use a parte retornada para operar na parte adicionada ao documento. (Herdado de OpenXmlPackage)
AddPart<T>(T, String)	Adiciona a parte ao documento com uma determinada ID (identificador de relação). Deve usar a parte retornada para operar na parte adicionada ao documento (Herdado de OpenXmlPartContainer)
AddQuickAccessToolbarCustomizationsPart()	Adiciona um QuickAccessToolbarCustomizationsPart à PlanilhaDocument.
AddRibbonAndBackstageCustomizationsPart()	Adiciona um RibbonAndBackstageCustomizationsPart à PlanilhaDocument, essa parte só está disponível no Office2010.
AddRibbonExtensibilityPart()	Adiciona uma RibbonExtensibilityPart à PlanilhaDocument.
AddWebExTaskpanesPart()	Adiciona um WebExTaskpanesPart à PlanilhaDocument, essa parte só está disponível no Office2013.
AddWorkbookPart()	Criei a WorkbookPart e adicione-a a este documento.
Annotation(Type)	Obtenha o primeiro objeto de anotação do tipo especificado deste PartContainer. (Herdado de OpenXmlPartContainer)
Annotation<T>()	Obtenha o primeiro objeto de anotação do tipo especificado deste PartContainer. (Herdado de OpenXmlPartContainer)
Annotations(Type)	Obtém uma coleção de anotações do tipo especificado para este PartContainer. (Herdado de OpenXmlPartContainer)
Annotations<T>()	Obtém uma coleção de anotações do tipo especificado para este PartContainer. (Herdado de OpenXmlPartContainer)
ChangeDocumentType(SpreadsheetDocumentType)	Altera o tipo de documento.
ChangeIdOfPart(OpenXmlPart, String)	Altera a ID da relação da parte. (Herdado de OpenXmlPartContainer)
Clone()	Cria um clone editável deste pacote OpenXml, aberto em um MemoryStream com capacidade expansível e usando OpenSettings padrão. (Herdado de OpenXmlPackage)
Clone(Package)	Cria um clone deste pacote OpenXml, aberto na instância especificada do Pacote. O clone será aberto com os mesmos OpenSettings que este pacote OpenXml. (Herdado de OpenXmlPackage)
Clone(Package, OpenSettings)	Cria um clone deste pacote OpenXml, aberto na instância especificada do Pacote. (Herdado de OpenXmlPackage)
Clone(Stream)	Cria um clone desse pacote OpenXml, aberto no fluxo determinado. O pacote OpenXml clonado é aberto com as mesmas configurações, ou seja, FileOpenAccess e OpenSettings, como este pacote OpenXml. (Herdado de OpenXmlPackage)
Clone(Stream, Boolean)	Cria um clone desse pacote OpenXml, aberto no fluxo determinado. O pacote OpenXml clonado é aberto com os mesmos OpenSettings que este pacote OpenXml. (Herdado de OpenXmlPackage)
Clone(Stream, Boolean, OpenSettings)	Cria um clone desse pacote OpenXml, aberto no fluxo determinado. (Herdado de OpenXmlPackage)
Clone(String)	Cria um clone desse pacote OpenXml aberto a partir do arquivo determinado (que será criado clonando este pacote OpenXml). O pacote OpenXml clonado é aberto com as mesmas configurações, ou seja, FileOpenAccess e OpenSettings, como este pacote OpenXml. (Herdado de OpenXmlPackage)
Clone(String, Boolean)	Cria um clone desse pacote OpenXml aberto a partir do arquivo determinado (que será criado clonando este pacote OpenXml). O pacote OpenXml clonado é aberto com os mesmos OpenSettings que este pacote OpenXml. (Herdado de OpenXmlPackage)
Clone(String, Boolean, OpenSettings)	Cria um clone desse pacote OpenXml aberto a partir do arquivo determinado (que será criado clonando este pacote OpenXml). (Herdado de OpenXmlPackage)
Close()	Salva e fecha o pacote OpenXml e todos os fluxos de parte subjacentes. (Herdado de OpenXmlPackage)
Create(Package, SpreadsheetDocumentType)	Cria uma nova instância da classe SpreadsheetDocument do pacote especificado.
Create(Package, SpreadsheetDocumentType, Boolean)	Cria uma nova instância da classe SpreadsheetDocument do pacote especificado.
Create(Stream, SpreadsheetDocumentType)	Cria uma nova instância da classe SpreadsheetDocument do fluxo de E/S.
Create(Stream, SpreadsheetDocumentType, Boolean)	Cria uma nova instância da classe SpreadsheetDocument do fluxo de E/S.
Create(String, SpreadsheetDocumentType)	Cria uma nova instância da classe SpreadsheetDocument do arquivo especificado.
Create(String, SpreadsheetDocumentType, Boolean)	Cria uma nova instância da classe SpreadsheetDocument do arquivo especificado.
CreateClone(Package)	Cria uma nova instância do OpenXmlPackage na instância especificada do Pacote. (Herdado de OpenXmlPackage)
CreateClone(Stream)	Cria um novo OpenXmlPackage no fluxo determinado. (Herdado de OpenXmlPackage)
CreateClone(String)	Cria um novo pacote OpenXml no arquivo determinado. (Herdado de OpenXmlPackage)
CreateFromTemplate(String)	Cria uma Planilha editávelDocument de um modelo, aberto em um MemoryStream com capacidade expansível.
CreateMediaDataPart(MediaDataPartType)	Cria uma nova MediaDataPart parte no pacote de documentos. (Herdado de OpenXmlPackage)
CreateMediaDataPart(String)	Cria uma nova MediaDataPart parte no pacote de documentos. (Herdado de OpenXmlPackage)
CreateMediaDataPart(String, String)	Cria uma nova MediaDataPart parte no pacote de documentos. (Herdado de OpenXmlPackage)
CreateRelationshipToPart(OpenXmlPart)	Adiciona uma relação para a parte especificada a essa parte. (Herdado de OpenXmlPartContainer)
CreateRelationshipToPart(OpenXmlPart, String)	Adiciona uma relação para a parte especificada a essa parte. (Herdado de OpenXmlPartContainer)
DeleteExternalRelationship(ExternalRelationship)	Exclui a relação externa especificada. (Herdado de OpenXmlPartContainer)
DeleteExternalRelationship(String)	Exclui a ExternalRelationship especificada. (Herdado de OpenXmlPartContainer)
DeletePart(DataPart)	Exclui o especificado DataPart do pacote de documentos. (Herdado de OpenXmlPackage)
DeletePart(OpenXmlPart)	Exclui uma parte especificada na camada raiz do pacote. (Herdado de OpenXmlPartContainer)
DeletePart(String)	Exclui a parte filho especificada dessa parte. (Herdado de OpenXmlPartContainer)
DeleteParts<T>(IEnumerable<T>)	Exclui todas as partes que estão na coleção passada do documento. (Herdado de OpenXmlPartContainer)
DeletePartsRecursivelyOfType<T>()	Exclui todas as partes com o tipo de parte especificado do pacote de forma recursiva. (Herdado de OpenXmlPackage)
DeleteReferenceRelationship(ReferenceRelationship)	Exclui a relação de referência especificada. (Herdado de OpenXmlPartContainer)
DeleteReferenceRelationship(String)	Exclui a relação de referência especificada. (Herdado de OpenXmlPartContainer)
Dispose()	Libera e salva o conteúdo, fecha o documento e libera todos os recursos. (Herdado de OpenXmlPackage)
Dispose(Boolean)	Libera e salva o conteúdo, fecha o documento e libera todos os recursos. (Herdado de OpenXmlPackage)
FromFlatOpcDocument(XDocument)	Cria uma nova instância editável do SpreadsheetDocument a partir de um XDocument formato em OPC Simples, aberto em um MemoryStream.
FromFlatOpcDocument(XDocument, Package)	Cria uma nova instância de PlanilhaDocument de uma pasta de trabalho no formato OPC Simples na instância especificada do Pacote.
FromFlatOpcDocument(XDocument, Stream, Boolean)	Cria uma nova instância de PlanilhaDocument de uma pasta de trabalho no formato OPC Simples.
FromFlatOpcDocument(XDocument, String, Boolean)	Cria uma nova instância de PlanilhaDocument de uma pasta de trabalho no formato OPC Simples.
FromFlatOpcString(String)	Cria uma nova instância de PlanilhaDocument de uma cadeia de caracteres no formato OPC Simples em uma MemoryStream capacidade expansível.
FromFlatOpcString(String, Package)	Cria uma nova instância de PlanilhaDocument de uma cadeia de caracteres no formato OPC Simples.
FromFlatOpcString(String, Stream, Boolean)	Cria uma nova instância de PlanilhaDocument de uma cadeia de caracteres no formato OPC Simples em um
FromFlatOpcString(String, String, Boolean)	Cria uma nova instância de PlanilhaDocument de uma cadeia de caracteres no formato OPC Simples.
GetExternalRelationship(String)	Obtém a ExternalRelationship especificada. (Herdado de OpenXmlPartContainer)
GetIdOfPart(OpenXmlPart)	Obtém a ID de relacionamento da parte. (Herdado de OpenXmlPartContainer)
GetPartById(String)	Obtém a parte filho por meio da ID do relacionamento. (Herdado de OpenXmlPartContainer)
GetPartsCountOfType<T>()	Obtém a contagem de todas as partes do tipo T. (Herdado de OpenXmlPartContainer)
GetPartsOfType<T>()	Enumera todas as partes de crianças do tipo T especificado dessa parte. (Herdado de OpenXmlPartContainer)
GetPartsOfType<T>(ICollection<T>)	Obtém todas as partes de crianças do tipo TpartCollection especificado nesta parte. (Herdado de OpenXmlPartContainer)
GetReferenceRelationship(String)	Obtém o ReferenceRelationship especificado. (Herdado de OpenXmlPartContainer)
Open(Package)	Cria uma nova instância da classe SpreadsheetDocument do pacote especificado.
Open(Package, OpenSettings)	Cria uma nova instância da classe SpreadsheetDocument do pacote especificado.
Open(Stream, Boolean)	Cria uma nova instância da classe SpreadsheetDocument do fluxo de E/S.
Open(Stream, Boolean, OpenSettings)	Cria uma nova instância da classe SpreadsheetDocument do fluxo de E/S.
Open(String, Boolean)	Cria uma nova instância da classe SpreadsheetDocument do arquivo especificado.
Open(String, Boolean, OpenSettings)	Cria uma nova instância da classe SpreadsheetDocument do arquivo especificado.
OpenClone(Stream, Boolean, OpenSettings)	Abre o pacote OpenXml clonado no fluxo determinado. (Herdado de OpenXmlPackage)
OpenClone(String, Boolean, OpenSettings)	Abre o pacote OpenXml clonado no arquivo determinado. (Herdado de OpenXmlPackage)
RemoveAnnotations(Type)	Remove as anotações do tipo especificado deste PartContainer. (Herdado de OpenXmlPartContainer)
RemoveAnnotations<T>()	Remove as anotações do tipo especificado deste PartContainer. (Herdado de OpenXmlPartContainer)
Save()	Salva o conteúdo de todas as partes e relações contidas no pacote OpenXml, se FileOpenAccess for ReadWrite. Algumas plataformas não dão suporte a salvamento devido a limitações no Package, portanto, consulte CanSave em runtime para saber se o salvamento total terá suporte sem fechar e descartar o OpenXmlPackage. (Herdado de OpenXmlPackage)
SaveAs(String)	Salva o conteúdo de todas as partes e relações contidas no pacote OpenXml no arquivo especificado. Abre o documento salvo usando as mesmas configurações usadas para abrir este pacote OpenXml. (Herdado de OpenXmlPackage)
ThrowIfObjectDisposed()	Lançado se um objeto for descartado. (Herdado de OpenXmlPackage)
ToFlatOpcDocument()	Converte um pacote OpenXml no formato OPC em um XDocument formato OPC simples. (Herdado de OpenXmlPackage)
ToFlatOpcDocument(XProcessingInstruction)	Converte um pacote OpenXml no formato OPC em um XDocument formato OPC simples. (Herdado de OpenXmlPackage)
ToFlatOpcString()	Converte um pacote OpenXml no formato OPC em cadeia de caracteres no formato OPC Simples. (Herdado de OpenXmlPackage)
TryGetPartById(String, OpenXmlPart)	Tente obter a parte filho pela ID do relacionamento. (Herdado de OpenXmlPartContainer)
Validate(OpenXmlPackageValidationSettings)	Valida o pacote. Esse método não valida o conteúdo XML em cada parte. (Herdado de OpenXmlPackage)

Métodos de Extensão

GetPackage(OpenXmlPackage)	Obtém o atual IPackage para o package.
AddPackageEventsFeature(OpenXmlPackage)	Adiciona um recurso para acompanhar o evento de um pacote de eventos de ciclo de vida.
AddPartEventsFeature(OpenXmlPackage)	Adiciona um recurso para acompanhar o evento de um pacote que cria ou remove peças.
AddPartRootEventsFeature(OpenXmlPartContainer)	Adiciona um recurso para acompanhar o evento para eventos do ciclo de vida do pacote.
AddRandomNumberGeneratorFeature(OpenXmlPackage)	Adicione um gerador de número aleatório ao pacote.
CreateUnknownElement(OpenXmlPartContainer, String)	Cria uma nova classe OpenXmlUnknownElement usando o XML externo.
ToFlatOpcDocument(OpenXmlPackage)	Converte um pacote OpenXml no formato OPC em um XDocument formato OPC simples.
ToFlatOpcString(OpenXmlPackage)	Converte um pacote OpenXml no formato OPC em cadeia de caracteres no formato OPC Simples.
GetAllParts(OpenXmlPackage)	Atravesse partes no OpenXmlPackage por amplitude primeiro.
IgnoreCalculationChainPartRelationship(SpreadsheetDocument)	Configura o spreadsheet para ignorar quaisquer CalculationChainPart relações se a parte não estiver lá.