Abrufen einer Spaltenüberschrift in einem Tabellenkalkulationsdokument

In diesem Thema wird gezeigt, wie Sie die Klassen im Open XML SDK für Office verwenden, um eine Spaltenüberschrift in einem Tabellenkalkulationsdokument programmgesteuert abzurufen.

Grundlegende Struktur eines SpreadsheetML-Dokuments

Die grundlegende Dokumentstruktur eines SpreadsheetML Dokuments besteht aus den Sheets Elementen und Sheet , die auf die Arbeitsblätter in der Arbeitsmappe verweisen. A separate XML file is created for each worksheet. Beispielsweise befindet sich der SpreadsheetML für ein Workbook mit den beiden Arbeitsblättern MySheet1 und MySheet2 in der Workbook.xml Datei und wird im folgenden Codebeispiel gezeigt.

    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
    <workbook xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://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>

Die XML-Dateien des Arbeitsblatts enthalten ein oder mehrere Elemente auf Blockebene, z. B. stellt SheetData die Zelltabelle dar und enthält mindestens ein Row Element. Ein row -Element enthält mindestens ein Cell -Element. Jede Zelle enthält ein CellValue Element, das den Wert der Zelle darstellt. Beispielsweise befindet sich das SpreadsheetML für das erste Arbeitsblatt in einer Arbeitsmappe, das nur den Wert 100 in Zelle A1 aufweist, in der Sheet1.xml-Datei und wird im folgenden Codebeispiel gezeigt.

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

Mit dem Open XML SDK können Sie Dokumentstrukturen und Inhalte erstellen, die stark typisierte Klassen verwenden, die Elementen entsprechen SpreadsheetML . Sie finden diese Klassen im DocumentFormat.OpenXML.Spreadsheet -Namespace. In der folgenden Tabelle sind die Klassennamen der Klassen aufgeführt, die den workbookElementen , sheets, sheet, worksheetund sheetData entsprechen.

SpreadsheetML-Element	Open XML SDK-Klasse	Beschreibung
<workbook/>	DocumentFormat.OpenXML.Spreadsheet.Workbook	Das Stammelement des Hauptdokumentteils.
<sheets/>	DocumentFormat.OpenXML.Spreadsheet.Sheets	Der Container für die Strukturen auf Blockebene, wie z. B. "sheet", "fileVersion" und andere Elemente, die in der Spezifikation ISO/IEC 29500 angegeben sind.
<sheet/>	DocumentFormat.OpenXml.Spreadsheet.Sheet	Ein Blatt, das auf eine Blattdefinitionsdatei zeigt.
<worksheet/>	DocumentFormat.OpenXML.Spreadsheet. Worksheet	Eine Blattdefinitionsdatei, welche die Blattdaten enthält.
<sheetData/>	DocumentFormat.OpenXML.Spreadsheet.SheetData	Die Zellentabelle, die mithilfe von Zeilen gruppiert wird.
<row/>	DocumentFormat.OpenXml.Spreadsheet.Row	Eine Zeile in der Zellentabelle.
<c/>	DocumentFormat.OpenXml.Spreadsheet.Cell	Eine Zelle in einer Zeile.
<v/>	DocumentFormat.OpenXml.Spreadsheet.CellValue	Der Wert einer Zelle.

Funktionsweise des Beispielcodes

Der Code in dieser Vorgehensweise besteht aus drei Methoden (Funktionen in Visual Basic): GetColumnHeading, GetColumnNameund GetRowIndex. Die letzten beiden Methoden werden innerhalb der GetColumnHeading -Methode aufgerufen.

Die GetColumnName -Methode verwendet den Zellennamen als Parameter. Sie analysiert den Zellennamen zum Abrufen des Spaltennamens, indem ein regulärer Ausdruck für den Abgleich des Spaltennamensteils des Zellennamens erstellt wird. Weitere Informationen über reguläre Ausdrücke finden Sie unter Sprachelemente für reguläre Ausdrücke.

C#

// Create a regular expression to match the column name portion of the cell name.
Regex regex = new Regex("[A-Za-z]+");
Match match = regex.Match(cellName);

return match.Value;

Visual Basic

' Create a regular expression to match the column name portion of the cell name.
Dim regex As New Regex("[A-Za-z]+")
Dim match As Match = regex.Match(cellName)

Return match.Value

Die GetRowIndex -Methode verwendet den Zellennamen als Parameter. Sie analysiert den Zellennamen, um den Zeilenindex durch Erstellen eines regulären Ausdrucks zu ermitteln, der den Zeilenindexteil des Zellennamens abgleicht.

C#

// Create a regular expression to match the row index portion the cell name.
Regex regex = new Regex(@"\d+");
Match match = regex.Match(cellName);

return uint.Parse(match.Value);

Visual Basic

' Create a regular expression to match the row index portion the cell name.
Dim regex As New Regex("\d+")
Dim match As Match = regex.Match(cellName)

Return UInteger.Parse(match.Value)

Die GetColumnHeading -Methode verwendet drei Parameter: den vollständigen Pfad zur Quelltabellendatei, den Namen des Arbeitsblatts, das die angegebene Spalte enthält, und den Namen einer Zelle in der Spalte, für die die Überschrift abgerufen werden soll.

Der Code ruft den Namen der Spalte der angegebenen Zelle durch Aufrufen der GetColumnName -Methode ab. Der Code ruft auch die Zellen in der Spalte ab und sortiert sie mithilfe der GetRowIndex -Methode nach Zeile.

C#

// Get the column name for the specified cell.
string columnName = GetColumnName(cellName);

// Get the cells in the specified column and order them by row.
IEnumerable<Cell> cells = worksheetPart.Worksheet.Descendants<Cell>().Where(c => string.Compare(GetColumnName(c.CellReference?.Value), columnName, true) == 0)
    .OrderBy(r => GetRowIndex(r.CellReference) ?? 0);

Visual Basic

' Get the column name for the specified cell.
Dim columnName As String = GetColumnName(cellName)

' Get the cells in the specified column and order them by row.
Dim cells As IEnumerable(Of Cell) = worksheetPart.Worksheet.Descendants(Of Cell)().Where(Function(c) String.Compare(GetColumnName(c.CellReference?.Value), columnName, True) = 0) _
    .OrderBy(Function(r) If(GetRowIndex(r.CellReference), 0))

Wenn die angegebene Spalte vorhanden ist, wird die erste Zelle in der Spalte mithilfe der First -Methode abgerufen. Die erste Zelle enthält die Überschrift. Andernfalls ist die angegebene Spalte nicht vorhanden, und die Methode gibt zurück. null / Nothing

C#

if (cells.Count() == 0)
{
    // The specified column does not exist.
    return null;
}

// Get the first cell in the column.
Cell headCell = cells.First();

Visual Basic

If cells.Count() = 0 Then
    ' The specified column does not exist.
    Return Nothing
End If

' Get the first cell in the column.
Dim headCell As Cell = cells.First()

Wenn der Inhalt der Zelle im SharedStringTablePart -Objekt gespeichert ist, ruft er die freigegebenen Zeichenfolgenelemente ab und gibt den Inhalt der Spaltenüberschrift mithilfe der Parse -Methode zurück. Wenn sich der Inhalt der Zelle nicht im SharedStringTable -Objekt befindet, wird der Inhalt der Zelle zurückgegeben.

C#

// If the content of the first cell is stored as a shared string, get the text of the first cell
// from the SharedStringTablePart and return it. Otherwise, return the string value of the cell.
if (headCell.DataType is not null && headCell.DataType.Value == CellValues.SharedString && int.TryParse(headCell.CellValue?.Text, out int index))
{
    SharedStringTablePart shareStringPart = document.WorkbookPart.GetPartsOfType<SharedStringTablePart>().First();
    SharedStringItem[] items = shareStringPart.SharedStringTable.Elements<SharedStringItem>().ToArray();

    return items[index].InnerText;
}
else
{
    return headCell.CellValue?.Text;
}

Visual Basic

' If the content of the first cell is stored as a shared string, get the text of the first cell
' from the SharedStringTablePart and return it. Otherwise, return the string value of the cell.
Dim idx As Integer

If headCell.DataType IsNot Nothing AndAlso headCell.DataType.Value = CellValues.SharedString AndAlso Integer.TryParse(headCell.CellValue?.Text, idx) Then
    Dim shareStringPart As SharedStringTablePart = document.WorkbookPart.GetPartsOfType(Of SharedStringTablePart)().First()
    Dim items As SharedStringItem() = shareStringPart.SharedStringTable.Elements(Of SharedStringItem)().ToArray()

    Return items(idx).InnerText
Else
    Return headCell.CellValue?.Text
End If

Beispielcode

Nachstehend ist der vollständige Beispielcode in C# und Visual Basic aufgeführt.

C#

static string? GetColumnHeading(string docName, string worksheetName, string cellName)
{
    // Open the document as read-only.
    using (SpreadsheetDocument document = SpreadsheetDocument.Open(docName, false))
    {
        IEnumerable<Sheet>? sheets = document.WorkbookPart?.Workbook.Descendants<Sheet>().Where(s => s.Name == worksheetName);

        if (sheets is null || sheets.Count() == 0)
        {
            // The specified worksheet does not exist.
            return null;
        }

        string? id = sheets.First().Id;

        if (id is null)
        {
            // The worksheet does not have an ID.
            return null;
        }

        WorksheetPart worksheetPart = (WorksheetPart)document.WorkbookPart!.GetPartById(id);

        // Get the column name for the specified cell.
        string columnName = GetColumnName(cellName);

        // Get the cells in the specified column and order them by row.
        IEnumerable<Cell> cells = worksheetPart.Worksheet.Descendants<Cell>().Where(c => string.Compare(GetColumnName(c.CellReference?.Value), columnName, true) == 0)
            .OrderBy(r => GetRowIndex(r.CellReference) ?? 0);

        if (cells.Count() == 0)
        {
            // The specified column does not exist.
            return null;
        }

        // Get the first cell in the column.
        Cell headCell = cells.First();

        // If the content of the first cell is stored as a shared string, get the text of the first cell
        // from the SharedStringTablePart and return it. Otherwise, return the string value of the cell.
        if (headCell.DataType is not null && headCell.DataType.Value == CellValues.SharedString && int.TryParse(headCell.CellValue?.Text, out int index))
        {
            SharedStringTablePart shareStringPart = document.WorkbookPart.GetPartsOfType<SharedStringTablePart>().First();
            SharedStringItem[] items = shareStringPart.SharedStringTable.Elements<SharedStringItem>().ToArray();

            return items[index].InnerText;
        }
        else
        {
            return headCell.CellValue?.Text;
        }
    }
}
// Given a cell name, parses the specified cell to get the column name.
static string GetColumnName(string? cellName)
{
    if (cellName is null)
    {
        return string.Empty;
    }

    // Create a regular expression to match the column name portion of the cell name.
    Regex regex = new Regex("[A-Za-z]+");
    Match match = regex.Match(cellName);

    return match.Value;
}

// Given a cell name, parses the specified cell to get the row index.
static uint? GetRowIndex(string? cellName)
{
    if (cellName is null)
    {
        return null;
    }

    // Create a regular expression to match the row index portion the cell name.
    Regex regex = new Regex(@"\d+");
    Match match = regex.Match(cellName);

    return uint.Parse(match.Value);
}

Visual Basic

Function GetColumnHeading(docName As String, worksheetName As String, cellName As String) As String
    ' Open the document as read-only.
    Using document As SpreadsheetDocument = SpreadsheetDocument.Open(docName, False)
        Dim sheets As IEnumerable(Of Sheet) = document.WorkbookPart?.Workbook.Descendants(Of Sheet)().Where(Function(s) s.Name = worksheetName)

        If sheets Is Nothing OrElse sheets.Count() = 0 Then
            ' The specified worksheet does not exist.
            Return Nothing
        End If

        Dim id As String = sheets.First().Id

        If id Is Nothing Then
            ' The worksheet does not have an ID.
            Return Nothing
        End If

        Dim worksheetPart As WorksheetPart = CType(document.WorkbookPart.GetPartById(id), WorksheetPart)

        ' Get the column name for the specified cell.
        Dim columnName As String = GetColumnName(cellName)

        ' Get the cells in the specified column and order them by row.
        Dim cells As IEnumerable(Of Cell) = worksheetPart.Worksheet.Descendants(Of Cell)().Where(Function(c) String.Compare(GetColumnName(c.CellReference?.Value), columnName, True) = 0) _
            .OrderBy(Function(r) If(GetRowIndex(r.CellReference), 0))

        If cells.Count() = 0 Then
            ' The specified column does not exist.
            Return Nothing
        End If

        ' Get the first cell in the column.
        Dim headCell As Cell = cells.First()

        ' If the content of the first cell is stored as a shared string, get the text of the first cell
        ' from the SharedStringTablePart and return it. Otherwise, return the string value of the cell.
        Dim idx As Integer

        If headCell.DataType IsNot Nothing AndAlso headCell.DataType.Value = CellValues.SharedString AndAlso Integer.TryParse(headCell.CellValue?.Text, idx) Then
            Dim shareStringPart As SharedStringTablePart = document.WorkbookPart.GetPartsOfType(Of SharedStringTablePart)().First()
            Dim items As SharedStringItem() = shareStringPart.SharedStringTable.Elements(Of SharedStringItem)().ToArray()

            Return items(idx).InnerText
        Else
            Return headCell.CellValue?.Text
        End If
    End Using
End Function

' Given a cell name, parses the specified cell to get the column name.
Function GetColumnName(cellName As String) As String
    If cellName Is Nothing Then
        Return String.Empty
    End If

    ' Create a regular expression to match the column name portion of the cell name.
    Dim regex As New Regex("[A-Za-z]+")
    Dim match As Match = regex.Match(cellName)

    Return match.Value
End Function

' Given a cell name, parses the specified cell to get the row index.
Function GetRowIndex(cellName As String) As UInteger?
    If cellName Is Nothing Then
        Return Nothing
    End If

    ' Create a regular expression to match the row index portion the cell name.
    Dim regex As New Regex("\d+")
    Dim match As Match = regex.Match(cellName)

    Return UInteger.Parse(match.Value)
End Function

Siehe auch

Referenz zur Open XML SDK-Klassenbibliothek