SpreadsheetDocument Classe

Definição

Namespace:

DocumentFormat.OpenXml.Packaging

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Define SpreadsheetDocument - um OpenXmlPackage representa um documento de Folha 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)

Herança

Object

OpenXmlPartContainer

OpenXmlPackage

SpreadsheetDocument

Implementações

ISupportedRelationship<ThumbnailPart> ISupportedRelationship<WorkbookPart>

Exemplos

O exemplo seguinte cria um documento básico do Excel, um livro com uma folha de cálculo. Depois de executar o exemplo de código, observe o ficheiro criado, "SpreadsheetDocumentEx.xlsx" e repare na folha de cálculo com o nome "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 guardadas quando eliminadas. (Herdado de OpenXmlPackage)
CompressionOption	Obtém ou define o nível de compressão para o conteúdo da nova parte (Herdado de OpenXmlPackage)
CoreFilePropertiesPart	Obtém o CoreFilePropertiesPart da Folha de CálculoDocumento.
CustomFilePropertiesPart	Obtém o CustomFilePropertiesPart da Folha de CálculoDocumento.
DataPartReferenceRelationships	Obtém todas as DataPartReferenceRelationship relações. (Herdado de OpenXmlPartContainer)
DataParts	Obtém todas as DataPart partes no pacote de documentos. (Herdado de OpenXmlPackage)
DigitalSignatureOriginPart	Obtém o DigitalSignatureOriginPart da Folha de CálculoDocumento.
DocumentType	Obtém o tipo de Folha de CálculoDocumento.
ExtendedFilePropertiesPart	Obtém o ExtendedFilePropertiesPart da Folha de CálculoDocumento.
ExternalRelationships	Obtém todas as relações externas. As relações de hiperligação não estão incluídas, utilize a propriedade HyperlinkRelationship para enumerar relações de hiperligação. (Herdado de OpenXmlPartContainer)
Features	Obtém as funcionalidades associadas a esta parte.
FileOpenAccess	Obtém a definição FileAccess para o documento. As definições de acesso de E/S atuais são: Leitura, Escrita ou Escrita. (Herdado de OpenXmlPackage)
HyperlinkRelationships	Obtém todas as relações de hiperligação. (Herdado de OpenXmlPartContainer)
LabelInfoPart	Obtém o LabelInfoPart da Folha de CálculoDocument, disponível apenas no Office2021.
MarkupCompatibilityProcessSettings	Obtém as definições de compatibilidade de markup aplicadas no tempo de carregamento. (Herdado de OpenXmlPackage)
MaxCharactersInPart	Obtém um valor que indica o número máximo permitido de carateres numa peça Open XML. Um valor zero (0) indica que não existem limites no tamanho da peça. Um valor diferente de zero especifica o tamanho máximo, em carateres. (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 de ContentType para uma extensão de parte. (Herdado de OpenXmlPackage)
Parts	Obtém todas as partes que são destinos de relação desta parte. (Herdado de OpenXmlPartContainer)
QuickAccessToolbarCustomizationsPart	Obtém o QuickAccessToolbarCustomizationsPart da Folha de CálculoDocumento.
RibbonAndBackstageCustomizationsPart	Obtém o RibbonAndBackstageCustomizationsPart da Folha de CálculoDocumento, disponível apenas no Office2010.
RibbonExtensibilityPart	Obtém o RibbonExtensibilityPart da Folha de CálculoDocumento.
RootPart	Obtém a parte raiz do pacote. (Herdado de OpenXmlPackage)
StrictRelationshipFound	Obtém um valor que indica se este pacote contém relações transitórias convertidas de Estrita. (Herdado de OpenXmlPackage)
ThumbnailPart	Obtém a ThumbnailPart da Folha de CálculoDocumento.
WebExTaskpanesPart	Obtém a Peça WebExTaskpanes da Folha de CálculoDocument, disponível apenas no Office2013.
WorkbookPart	Obtém a Peça de Livro da Folha de CálculoDocumento.

Métodos

AddAnnotation(Object)	Adiciona um objeto à lista de anotação deste PartContainer. (Herdado de OpenXmlPartContainer)
AddCoreFilePropertiesPart()	Adicione um CoreFilePropertiesPart à Folha de CálculoDocumento.
AddCustomFilePropertiesPart()	Adicione um CustomFilePropertiesPart à Folha de CálculoDocumento.
AddDigitalSignatureOriginPart()	Adicione um DigitalSignatureOriginPart à Folha de CálculoDocumento.
AddExtendedFilePropertiesPart()	Adicione uma ExtendedFilePropertiesPart à Folha de CálculoDocumento.
AddExtendedPart(String, String, String, String)	Adiciona uma parte expandida (parte específica da aplicação ). (Herdado de OpenXmlPartContainer)
AddExtendedPart(String, String, String)	Adiciona uma parte expandida (parte específica da aplicação ). (Herdado de OpenXmlPartContainer)
AddExternalRelationship(String, Uri, String)	Adiciona uma relação externa. Não adicione relações de hiperligação através deste método. Em alternativa, utilize AddHyperlinkRelationship(). (Herdado de OpenXmlPartContainer)
AddExternalRelationship(String, Uri)	Adiciona uma relação externa. Não adicione relações de hiperligação através deste método. Em alternativa, utilize AddHyperlinkRelationship(). (Herdado de OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean, String)	Adiciona uma nova relação de hiperligação. (Herdado de OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean)	Adiciona uma nova relação de hiperligação. (Herdado de OpenXmlPartContainer)
AddLabelInfoPart()	Adiciona uma LabelInfoPart à Folha de CálculoDocument. Esta parte só está disponível no Office2021.
AddNewPart<T>()	Adiciona uma nova parte do tipo T. (Herdado de OpenXmlPartContainer)
AddNewPart<T>(String, String)	Adiciona uma nova parte do tipo T.
AddNewPart<T>(String)	Adiciona uma nova parte do tipo T. (Herdado de OpenXmlPartContainer)
AddPart<T>(T, String)	Adiciona a parte ao documento com um determinado identificador de relação (ID). Tem de utilizar a parte devolvida para operar na parte adicionada ao documento (Herdado de OpenXmlPartContainer)
AddPart<T>(T)	Adiciona a parte especificada ao documento. Utilize a parte devolvida para operar na parte adicionada ao documento. (Herdado de OpenXmlPackage)
AddQuickAccessToolbarCustomizationsPart()	Adiciona uma QuickAccessToolbarCustomizationsPart à Folha de CálculoDocumento.
AddRibbonAndBackstageCustomizationsPart()	Adiciona um RibbonAndBackstageCustomizationsPart à Folha de CálculoDocumento. Esta parte só está disponível no Office2010.
AddRibbonExtensibilityPart()	Adiciona uma RibbonExtensibilityPart à Folha de CálculoDocumento.
AddWebExTaskpanesPart()	Adiciona uma Peça WebExTaskpanes à Folha de CálculoDocumento. Esta parte só está disponível no Office2013.
AddWorkbookPart()	Criou a Peça de Livro e adicionou-a a este documento.
Annotation(Type)	Obtenha o primeiro objeto de anotação do tipo especificado a partir deste PartContainer. (Herdado de OpenXmlPartContainer)
Annotation<T>()	Obtenha o primeiro objeto de anotação do tipo especificado a partir 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 o ID da relação da peça. (Herdado de OpenXmlPartContainer)
Clone()	Cria um clone editável deste pacote OpenXml, aberto numa MemoryStream capacidade expansível e com OpenSettings predefinido. (Herdado de OpenXmlPackage)
Clone(Package, OpenSettings)	Cria um clone deste pacote OpenXml, aberto na instância especificada do Pacote. (Herdado de OpenXmlPackage)
Clone(Package)	Cria um clone deste pacote OpenXml, aberto na instância especificada do Pacote. O clone será aberto com as mesmas OpenSettings que este pacote OpenXml. (Herdado de OpenXmlPackage)
Clone(Stream, Boolean, OpenSettings)	Cria um clone deste pacote OpenXml, aberto no fluxo especificado. (Herdado de OpenXmlPackage)
Clone(Stream, Boolean)	Cria um clone deste pacote OpenXml, aberto no fluxo especificado. O pacote OpenXml clonado é aberto com as mesmas OpenSettings que este pacote OpenXml. (Herdado de OpenXmlPackage)
Clone(Stream)	Cria um clone deste pacote OpenXml, aberto no fluxo especificado. O pacote OpenXml clonado é aberto com as mesmas definições, ou seja, FileOpenAccess e OpenSettings, que este pacote OpenXml. (Herdado de OpenXmlPackage)
Clone(String, Boolean, OpenSettings)	Cria um clone deste pacote OpenXml aberto a partir do ficheiro especificado (que será criado através da clonagem deste pacote OpenXml). (Herdado de OpenXmlPackage)
Clone(String, Boolean)	Cria um clone deste pacote OpenXml aberto a partir do ficheiro especificado (que será criado através da clonagem deste pacote OpenXml). O pacote OpenXml clonado é aberto com as mesmas OpenSettings que este pacote OpenXml. (Herdado de OpenXmlPackage)
Clone(String)	Cria um clone deste pacote OpenXml aberto a partir do ficheiro especificado (que será criado através da clonagem deste pacote OpenXml). O pacote OpenXml clonado é aberto com as mesmas definições, ou seja, FileOpenAccess e OpenSettings, que este pacote OpenXml. (Herdado de OpenXmlPackage)
Close()	Guarda e fecha o pacote OpenXml e todos os fluxos de peças subjacentes. (Herdado de OpenXmlPackage)
Create(Package, SpreadsheetDocumentType, Boolean)	Cria uma nova instância da classe Folha de CálculoDocument a partir do pacote especificado.
Create(Package, SpreadsheetDocumentType)	Cria uma nova instância da classe Folha de CálculoDocument a partir do pacote especificado.
Create(Stream, SpreadsheetDocumentType, Boolean)	Cria uma nova instância da classe Folha de CálculoDocumento a partir do fluxo de E/S.
Create(Stream, SpreadsheetDocumentType)	Cria uma nova instância da classe Folha de CálculoDocumento a partir do fluxo de E/S.
Create(String, SpreadsheetDocumentType, Boolean)	Cria uma nova instância da classe Folha de CálculoDocument a partir do ficheiro especificado.
Create(String, SpreadsheetDocumentType)	Cria uma nova instância da classe Folha de CálculoDocument a partir do ficheiro especificado.
CreateClone(Package)	Cria uma nova instância de OpenXmlPackage na instância especificada do Pacote. (Herdado de OpenXmlPackage)
CreateClone(Stream)	Cria um novo OpenXmlPackage no fluxo especificado. (Herdado de OpenXmlPackage)
CreateClone(String)	Cria um novo pacote OpenXml no ficheiro especificado. (Herdado de OpenXmlPackage)
CreateFromTemplate(String)	Cria uma Folha de Cálculo editávelDocument a partir de um modelo, aberto num MemoryStream com capacidade expansível.
CreateMediaDataPart(MediaDataPartType)	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)
CreateMediaDataPart(String)	Cria uma nova MediaDataPart parte no pacote de documentos. (Herdado de OpenXmlPackage)
CreateRelationshipToPart(OpenXmlPart, String)	Adiciona uma relação para a parte especificada a esta parte. (Herdado de OpenXmlPartContainer)
CreateRelationshipToPart(OpenXmlPart)	Adiciona uma relação para a parte especificada a esta parte. (Herdado de OpenXmlPartContainer)
DeleteExternalRelationship(ExternalRelationship)	Elimina a relação externa especificada. (Herdado de OpenXmlPartContainer)
DeleteExternalRelationship(String)	Elimina o ExternalRelationship especificado. (Herdado de OpenXmlPartContainer)
DeletePart(DataPart)	Elimina o especificado DataPart do pacote de documentos. (Herdado de OpenXmlPackage)
DeletePart(OpenXmlPart)	Elimina uma parte especificada na camada raiz do pacote. (Herdado de OpenXmlPartContainer)
DeletePart(String)	Elimina a parte subordinada especificada desta parte. (Herdado de OpenXmlPartContainer)
DeleteParts<T>(IEnumerable<T>)	Elimina todas as partes que estão na coleção transmitida do documento. (Herdado de OpenXmlPartContainer)
DeletePartsRecursivelyOfType<T>()	Elimina todas as partes com o tipo de peça especificado do pacote de forma recursiva. (Herdado de OpenXmlPackage)
DeleteReferenceRelationship(ReferenceRelationship)	Elimina a relação de referência especificada. (Herdado de OpenXmlPartContainer)
DeleteReferenceRelationship(String)	Elimina a relação de referência especificada. (Herdado de OpenXmlPartContainer)
Dispose()	Remove e guarda o conteúdo, fecha o documento e liberta todos os recursos. (Herdado de OpenXmlPackage)
Dispose(Boolean)	Remove e guarda o conteúdo, fecha o documento e liberta todos os recursos. (Herdado de OpenXmlPackage)
FromFlatOpcDocument(XDocument, Package)	Cria uma nova instância de Folha de CálculoDocument a partir de um livro no formato OPC Plano na instância especificada do Pacote.
FromFlatOpcDocument(XDocument, Stream, Boolean)	Cria uma nova instância de Folha de CálculoDocumento a partir de um livro no formato OPC Simples.
FromFlatOpcDocument(XDocument, String, Boolean)	Cria uma nova instância de Folha de CálculoDocumento a partir de um livro no formato OPC Simples.
FromFlatOpcDocument(XDocument)	Cria uma nova instância editável de SpreadsheetDocument a partir de um XDocument formato OPC plano, aberto num MemoryStream.
FromFlatOpcString(String, Package)	Cria uma nova instância de Folha de CálculoDocumento a partir de uma cadeia no formato OPC Plano.
FromFlatOpcString(String, Stream, Boolean)	Cria uma nova instância de Folha de CálculoDocument a partir de uma cadeia no formato OPC Plano num
FromFlatOpcString(String, String, Boolean)	Cria uma nova instância de Folha de CálculoDocumento a partir de uma cadeia no formato OPC Plano.
FromFlatOpcString(String)	Cria uma nova instância de Folha de CálculoDocumento a partir de uma cadeia no formato OPC Plano numa MemoryStream com capacidade expansível.
GetExternalRelationship(String)	Obtém o ExternalRelationship especificado. (Herdado de OpenXmlPartContainer)
GetIdOfPart(OpenXmlPart)	Obtém o ID de relação da peça. (Herdado de OpenXmlPartContainer)
GetPartById(String)	Obtém a parte subordinada através do ID da relação. (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 subordinadas do tipo T especificado desta peça. (Herdado de OpenXmlPartContainer)
GetPartsOfType<T>(ICollection<T>)	Obtém todas as partes subordinadas do tipo TpartCollection especificado nesta parte. (Herdado de OpenXmlPartContainer)
GetReferenceRelationship(String)	Obtém a ReferenceRelationship especificada. (Herdado de OpenXmlPartContainer)
Open(Package, OpenSettings)	Cria uma nova instância da classe Folha de CálculoDocument a partir do pacote especificado.
Open(Package)	Cria uma nova instância da classe Folha de CálculoDocument a partir do pacote especificado.
Open(Stream, Boolean, OpenSettings)	Cria uma nova instância da classe Folha de CálculoDocumento a partir do fluxo de E/S.
Open(Stream, Boolean)	Cria uma nova instância da classe Folha de CálculoDocumento a partir do fluxo de E/S.
Open(String, Boolean, OpenSettings)	Cria uma nova instância da classe Folha de CálculoDocument a partir do ficheiro especificado.
Open(String, Boolean)	Cria uma nova instância da classe Folha de CálculoDocument a partir do ficheiro especificado.
OpenClone(Stream, Boolean, OpenSettings)	Abre o pacote OpenXml clonado no fluxo especificado. (Herdado de OpenXmlPackage)
OpenClone(String, Boolean, OpenSettings)	Abre o pacote OpenXml clonado no ficheiro especificado. (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()	Guarda o conteúdo de todas as partes e relações contidas no pacote OpenXml, se FileOpenAccess for ReadWrite. Algumas plataformas não suportam a gravação devido a limitações no Package, por isso, consulte CanSave no runtime para saber se a gravação completa será suportada sem fechar e eliminar o OpenXmlPackage. (Herdado de OpenXmlPackage)
SaveAs(String)	Guarda o conteúdo de todas as partes e relações contidas no pacote OpenXml no ficheiro especificado. Abre o documento guardado com as mesmas definições que foram utilizadas para abrir este pacote OpenXml. (Herdado de OpenXmlPackage)
ThrowIfObjectDisposed()	Acionado se um objeto for eliminado. (Herdado de OpenXmlPackage)
ToFlatOpcDocument()	Converte um pacote OpenXml no formato OPC num XDocument formato OPC Plano. (Herdado de OpenXmlPackage)
ToFlatOpcDocument(XProcessingInstruction)	Converte um pacote OpenXml no formato OPC num XDocument formato OPC Plano. (Herdado de OpenXmlPackage)
ToFlatOpcString()	Converte um pacote OpenXml no formato OPC em cadeia no formato OPC Plano. (Herdado de OpenXmlPackage)
TryGetPartById(String, OpenXmlPart)	Tente obter a parte subordinada pelo ID da relação. (Herdado de OpenXmlPartContainer)
Validate(OpenXmlPackageValidationSettings)	Valida o pacote. Este método não valida o conteúdo XML em cada parte. (Herdado de OpenXmlPackage)

Métodos de Extensão

GetPackage(OpenXmlPackage)	Obtém a corrente IPackage para o package.
AddPackageEventsFeature(OpenXmlPackage)	Adiciona uma funcionalidade para controlar os eventos de um ciclo de vida de pacotes.
AddPartEventsFeature(OpenXmlPackage)	Adiciona uma funcionalidade para controlar os eventos de um pacote que cria ou remove peças.
AddPartRootEventsFeature(OpenXmlPartContainer)	Adiciona uma funcionalidade para controlar eventos para eventos do ciclo de vida do pacote.
AddRandomNumberGeneratorFeature(OpenXmlPackage)	Adicione um gerador de números aleatórios ao pacote.
CreateUnknownElement(OpenXmlPartContainer, String)	Cria uma nova classe OpenXmlUnknownElement com o XML externo.
ToFlatOpcDocument(OpenXmlPackage)	Converte um pacote OpenXml no formato OPC num XDocument formato OPC Plano.
ToFlatOpcString(OpenXmlPackage)	Converte um pacote OpenXml no formato OPC em cadeia no formato OPC Plano.
GetAllParts(OpenXmlPackage)	Percorram partes no OpenXmlPackage por amplitude-primeiro.
IgnoreCalculationChainPartRelationship(SpreadsheetDocument)	Configura o spreadsheet para ignorar quaisquer CalculationChainPart relações se a parte não estiver lá.