Obter informações de planilha de um pacote Open XML

Este tópico mostra como usar as classes no SDK Open XML para Office para recuperar programaticamente informações de uma planilha em um documento da Planilha.

Estrutura básica de um documento de planilha

A estrutura básica de um documento SpreadsheetML consiste nos elementos Sheets e Sheet, que referenciam as planilhas na pasta de trabalho. Um arquivo XML separado é criado para cada planilha. Por exemplo, o SpreadsheetML de uma Pasta de trabalho que tem duas planilhas chamadas MySheet1 e MySheet2 está localizado no arquivo Workbook.xml e é mostrado no exemplo de código a seguir.

    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
    <workbook xmlns=https://schemas.openxmlformats.org/spreadsheetml/2006/main xmlns:r="https://schemas.openxmlformats.org/officeDocument/2006/relationships">
        <sheets>
            <sheet name="MySheet1" sheetId="1" r:id="rId1" /> 
            <sheet name="MySheet2" sheetId="2" r:id="rId2" /> 
        </sheets>
    </workbook>

Os arquivos XML da planilha contêm um ou mais elementos de nível de bloco, como sheetData , representa a tabela de células e contém um ou mais elementos row . Uma linha contém um ou mais elementos Cell. Cada célula contém um elemento CellValue que representa o valor da célula. Por exemplo, a PlanilhaML da primeira planilha em uma pasta de trabalho, que tem apenas o valor 100 na célula A1, está localizada no arquivo Sheet1.xml e é mostrada no exemplo de código a seguir.

    <?xml version="1.0" encoding="UTF-8" ?> 
    <worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">
        <sheetData>
            <row r="1">
                <c r="A1">
                    <v>100</v> 
                </c>
            </row>
        </sheetData>
    </worksheet>

Usando o SDK Do Open XML, você pode criar a estrutura de documentos e o conteúdo que usa classes fortemente tipdas que correspondem a elementos SpreadsheetML . Você pode encontrar essas classes no namespace DocumentFormat.OpenXML.Spreadsheet. A tabela a seguir lista os nomes das classes que correspondem aos elementos workbook, sheets, sheet, worksheet e sheetData.

Elemento SpreadsheetML	Classe SDK Open XML	Descrição
pasta de trabalho	DocumentFormat.OpenXML.Spreadsheet.Workbook	O elemento raiz para a parte do documento principal.
sheets	DocumentFormat.OpenXML.Spreadsheet.Sheets	O contêiner para as estruturas de nível de bloco, como sheet, fileVersion e outras indicadas na especificação ISO/IEC 29500.
sheet	DocumentFormat.OpenXml.Spreadsheet.Sheet	Uma planilha que aponta para um arquivo de definição de planilha.
planilha	DocumentFormat.OpenXML.Spreadsheet. Planilha	Um arquivo de definição de planilha que contém os dados de planilha.
sheetData	DocumentFormat.OpenXML.Spreadsheet.SheetData	A tabela de células, agrupadas por linhas.
row	DocumentFormat.OpenXml.Spreadsheet.Row	Uma linha na tabela de células.
c	DocumentFormat.OpenXml.Spreadsheet.Cell	Uma célula em uma linha.
v	DocumentFormat.OpenXml.Spreadsheet.CellValue	O valor de uma célula.

Como funciona o código de exemplo

Depois de abrir o arquivo para acesso somente leitura, instancie a classe Planilhas .

C#

Sheets? sheets = mySpreadsheet.WorkbookPart?.Workbook?.Sheets;

Visual Basic

Dim sheets As Sheets = mySpreadsheet.WorkbookPart.Workbook.Sheets

Em seguida, você itera por meio da coleção Planilhas e exibe OpenXmlElement e OpenXmlAttribute em cada elemento.

C#

foreach (OpenXmlElement sheet in sheets)
{
    foreach (OpenXmlAttribute attr in sheet.GetAttributes())
    {
        Console.WriteLine("{0}: {1}", attr.LocalName, attr.Value);
    }
}

Visual Basic

For Each sheet As OpenXmlElement In sheets
    For Each attr As OpenXmlAttribute In sheet.GetAttributes()
        Console.WriteLine("{0}: {1}", attr.LocalName, attr.Value)
    Next
Next

Ao exibir as informações de atributo, você obtém o nome e a ID de cada planilha no arquivo de planilha.

Código de exemplo

A seguir está um exemplo de código completo em C# e Visual Basic.

C#

using DocumentFormat.OpenXml.Packaging;
using System;
using OpenXmlAttribute = DocumentFormat.OpenXml.OpenXmlAttribute;
using OpenXmlElement = DocumentFormat.OpenXml.OpenXmlElement;
using Sheets = DocumentFormat.OpenXml.Spreadsheet.Sheets;


static void GetSheetInfo(string fileName)
{
    // Open file as read-only.
    using (SpreadsheetDocument mySpreadsheet = SpreadsheetDocument.Open(fileName, false))
    {
        Sheets? sheets = mySpreadsheet.WorkbookPart?.Workbook?.Sheets;

        if (sheets is not null)
        {
            // For each sheet, display the sheet information.
            foreach (OpenXmlElement sheet in sheets)
            {
                foreach (OpenXmlAttribute attr in sheet.GetAttributes())
                {
                    Console.WriteLine("{0}: {1}", attr.LocalName, attr.Value);
                }
            }
        }
    }
}

Visual Basic

Imports DocumentFormat.OpenXml.Packaging
Imports OpenXmlAttribute = DocumentFormat.OpenXml.OpenXmlAttribute
Imports OpenXmlElement = DocumentFormat.OpenXml.OpenXmlElement
Imports Sheets = DocumentFormat.OpenXml.Spreadsheet.Sheets


Module MyModule

    Sub Main(args As String())
        Dim fileName As String = args(0)
        GetSheetInfo(fileName)
    End Sub

    Public Sub GetSheetInfo(ByVal fileName As String)
        ' Open file as read-only.
        Using mySpreadsheet As SpreadsheetDocument = SpreadsheetDocument.Open(fileName, False)

            Dim sheets As Sheets = mySpreadsheet.WorkbookPart.Workbook.Sheets

            ' For each sheet, display the sheet information.
            For Each sheet As OpenXmlElement In sheets
                For Each attr As OpenXmlAttribute In sheet.GetAttributes()
                    Console.WriteLine("{0}: {1}", attr.LocalName, attr.Value)
                Next
            Next
        End Using
    End Sub
End Module

Confira também

Abrir referência de biblioteca de classes do SDK XML